Sticky Header option bug

[Agos95]

Prerequisites

• I have searched for duplicate or closed feature requests
• I am mindful of the project scope

Proposal

My proposal is to change this code

https://github.com/wowchemy/wowchemy-hugo-themes/blob/57e374fe08d8bb0eee34b160d479a77dc13b8503/modules/wowchemy/layouts/partials/site_js.html#L131

In fact, instead of looking at

header:
  on_scroll:

actually the code searches for

header.on_scroll: 

I suggest to:

• use the keyword sticky instead of on_scroll, which in my opinion is more clear.
• search for

  header:
    sticky: true/false

option to configure the header. Now, the value must be set to "disappear" to have a disappearing header, while everything else creates a sticky one. The use of true/false instead may be more clear.

• possibility to set a global behaviour using the params.yaml configuration file, or a per page one by using the single page Front Matter.
• backward compatibility with the old "buggy" way to set the sticky header with "header.on_scroll"

The logic to set the behaviour of the header should be:

1. by default homepage and book layout have a sticky header and all other pages have a disappearing one
2. use the global configuration in params.yaml to set the options to the whole site:

header:
  sticky: true/false

3. use the specific page option, by looking the front matter:

header:
  sticky: true/false

# or this one for backword compatibility
#header.on_scroll: 

---

I already fix this behaviour in my fork. If you think this can be useful, I can proceed with a PR.

Motivation and context

As stated in this discussion on Discord, there is a bug in the syntax to set the header sticky. In particular, this is the buggy code:

https://github.com/wowchemy/wowchemy-hugo-themes/blob/57e374fe08d8bb0eee34b160d479a77dc13b8503/modules/wowchemy/layouts/partials/site_js.html#L131

As for now, to make the header sticky you need to set the parameter

header.on_scroll : false

but looking at the code it should be:

header:
  on_scroll : false

In addition, it actually checks if sticky.header is set and equal to "disappear", but I think this should be a boolean value.

[github-actions]

This issue is stale because it has not had any recent activity. The resources of the project maintainers are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the main branch, consider contributing a Pull Request with a fix.

If this is a feature request, and you feel that it is still relevant and valuable, consider contributing a Pull Request for review.

This issue will automatically close soon if no further activity occurs. Thank you for your contributions.

[rodrigoalcarazdelaosa]

I suggest you submit a PR, @Agos95

[Agos95]

Ok, I submitted a PR!

[github-actions]

This issue is stale because it has not had any recent activity. The resources of the project maintainers are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the main branch, consider contributing a Pull Request with a fix.

If this is a feature request, and you feel that it is still relevant and valuable, consider contributing a Pull Request for review.

This issue will automatically close soon if no further activity occurs. Thank you for your contributions.