Adding methods to freeze / unfreeze the current headroom's state.

[andreivictor]

Inspired from another PR (#253), I've added methods to freeze and unfreeze the current headroom's state.

• freeze method: When called, this method will freeze the current headroom's state (pinned or unpinned). Headroom will not react to the user's scroll. If you wish to re-enable the headroom's default behaviour, you can call unfreeze method.

• unfreeze method: When called, this method will resume headroom's default behaviour. Headroom will pin or unpin when the user scrolls the page. By default, Headroom is not freezed and calling this method before freeze will do nothing.

There is also a new property - frozen - for the classes option:

{
  classes: {
    // ... other classes
    freezed : 'headroom--frozen'
  }
}

Usage:

var headroom  = new Headroom(myElement);
// initialise
headroom.init();

// freeze 
headroom.freeze();

// unfreeze
headroom.unfreeze();

Example:
https://codepen.io/andreivictor/pen/oymbLO

[andreivictor]

Why closing it?

[WickyNilliams]

Must have done it on accident, sorry!

[andreivictor]

No prob, thanks for your answer.

[WickyNilliams]

This looks good to me, thanks @andreivictor. I'll get this merged now and try and work out a plan for release. I'll also need to update the docs. Unless you have a desire to do that also?

[andreivictor]

I will try to update the README.md file in this weekend. Is there another place to update?

[WickyNilliams]

Don't do it on the weekend if you don't want to, enjoy yourself instead!

There's also a website on the gh-pages branch, but it's been so long since I've had to update that, I'm not sure what state it is in.

[WickyNilliams]

Just updating the readme would be more than enough.

[andreivictor]

Updated in #316. Thanks!

[WickyNilliams]

Published to npm as v0.10.0 🎉