feat(helper/is): add is_home_first_page() helper (#5006)

hexojs · Jun 30, 2022 · ccbed65 · ccbed65
1 parent 3bd5f2b
commit ccbed65
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/lib/plugins/helper/index.js b/lib/plugins/helper/index.js
@@ -31,6 +31,7 @@ module.exports = ctx => {
   const is = require('./is');
   helper.register('is_current', is.current);
   helper.register('is_home', is.home);
+  helper.register('is_home_first_page', is.home_first_page);
   helper.register('is_post', is.post);
   helper.register('is_page', is.page);
   helper.register('is_archive', is.archive);

diff --git a/lib/plugins/helper/is.js b/lib/plugins/helper/is.js
@@ -23,6 +23,10 @@ function isHomeHelper() {
   return Boolean(this.page.__index);
 }
 
+function isHomeFirstPageHelper() {
+  return Boolean(this.page.__index) && this.page.current === 1;
+}
+
 function isPostHelper() {
   return Boolean(this.page.__post);
 }
@@ -79,6 +83,7 @@ function isTagHelper(tag) {
 
 exports.current = isCurrentHelper;
 exports.home = isHomeHelper;
+exports.home_first_page = isHomeFirstPageHelper;
 exports.post = isPostHelper;
 exports.page = isPageHelper;
 exports.archive = isArchiveHelper;

diff --git a/test/scripts/helpers/is.js b/test/scripts/helpers/is.js
@@ -25,6 +25,13 @@ describe('is', () => {
     await is.home.call({page: {}}).should.be.false;
   });
 
+  it('is_home_first_page', async () => {
+    await is.home_first_page.call({page: {__index: true, current: 1}}).should.be.true;
+    await is.home_first_page.call({page: {__index: true, current: 2}}).should.be.false;
+    await is.home_first_page.call({page: {__index: true}}).should.be.false;
+    await is.home_first_page.call({page: {}}).should.be.false;
+  });
+
   it('is_post', async () => {
     await is.post.call({page: {__post: true}}).should.be.true;
     await is.post.call({page: {}}).should.be.false;