Road to v1

Thought I’d gather a rough plan, and list of possible changes, for v1:

• drop async behaviour when initialising (#346)
• simplify API (#352)
  • I don’t think there’s much in having consumers new up an instance and then call init().
  • A simple function headroom(elem, options) should do
  • update docs
• maybe drop callbacks in favour events emitted on elem?
  • this would further simplify the API
  • we could support both callbacks and events as interim?
• work out what to do with angular/jquery plugins
  • jquery is so simple it’s almost pointless!
  • someone has ported headroom to angular: https://github.com/TypeCtrl/ngx-headroom. should we just recommend people use that?
• fix all the outstanding iOS issues
  • first step will be to verify if all are still valid
  • may need to enlist someone with an iOS device, as I have none
• rename Headroom.cutsTheMustard to Headroom.isSupported (#351)
  • update docs

I’ve created a v1 branch which is where i’ll gather all these changes. This allows me to work on breaking changes in isolation, and still be able to publish any bugfixes on master.

If anybody else has any other suggestions, please let me know.

[WickyNilliams]

@fuzzzerd there’s no plan to change to the core library. I’m thinking I’ll just completely drop the jquery plugin and angular module altogether

[saas786]

@WickyNilliams Any further progress on this?