Custom functions to determine whether or not to pin/unpin headroom element

[jeffshaver]

In a modified version of this that I changed, I added the ability to pass in two new options: shouldPinCheck and shouldUnpinCheck (couldn't think of better names). These are functions that must return true/false. They are fired inside the shouldPin/shouldUnpin functions in the return statement.

Therefore, if a headroom goes to unpin and the shouldUnpinCheck returns false, the headroom element shouldn't be unpinned. Same thing for the shouldPinCheck but opposite.

If it was useful to me, I thought it may be useful to someone else as well. Maybe this should be added into the codebase.

[mdarens]

👍 but maybe call them beforeUnpin and beforePin?

[jeffshaver]

Those names work for me. I am not the best at coming up with function names xD

[WickyNilliams]

this has previously been discussed. the idea was to have the same thing but cancel the action if the regular onPin/onUnpin callbacks returned false. thoughts? this would negate the need for yet more callbacks/options

[gmclelland]

I think this would solve my problem of having the mobile menu disappear when the page is scrolled on a mobile device.
I could run a custom function on beforPin to check if the menu is open. If the menu is open then disable headroom.

[jeffshaver]

@WickyNilliams This comment is a little late, but that would work for me.

[WickyNilliams]

Closing as this is effectively a duplicate of #38 and the PR #125 offers a potential solution