UNPKG

5.44 kBMarkdownView Raw
1# Changelog
2
3Releases are be numbered in the semantic versioning format:
4
5`<major>.<minor>.<patch>`
6
7And constructed with these guidelines:
8
9* Breaking backwards compatibility bumps the major
10* New additions without breaking backwards compatibility bumps the minor
11* Bug fixes and misc changes bump the patch
12
13For more information on semantic versioning, please visit http://semver.org/.
14
15## v3.0.1 - December 22, 2018
16
17Update file name casing for consistency.
18
19## v3.0.0 - December 22, 2018
20
21Version 3 is a complete re-write of scrollnav to move the project away from
22jQuery, update to the latest es6 features, and remove all production
23dependencies. This update also removes a number of user options to simplify
24the API and reduces the amount of DOM manipulation to reduce likelihood of
25browser bugs. Includes a full set of test suites for all modules (unless
26noted). Please read through the [readme](https://github.com/jimmynotjim/scrollnav/blob/master/README.md) for further
27details.
28
29## v2.7.3 - March 19, 2018
30
31* Added BEM-style active classes
32
33## v2.7.2 - March 18, 2018
34
35* Fixed grunt:jshint error
36* Fixed readme typo
37* Replaced andSelf() calls with addBack()
38* Updated semver version to fix vulnerability
39
40## v2.7.1 - February 18, 2015
41
42* Fixed package.json
43
44## v2.7.0 - February 11, 2015
45
46* Add `activeClass` setting for custom styles
47* Add `__focused-section` when a section is scrolled to
48
49## v2.6.0 - February 19, 2015
50
51* Added in-view and active logic to sub-sections
52
53## v2.5.0 - January 18, 2015
54
55* Add scrollToHash setting
56
57## v2.4.0 - November 13, 2014
58
59* Adds a new resetPos public function for updating the section positions when the page's content changes. Refer to the Readme for more details.
60
61## v2.3.1 - October 30, 2014
62
63* Patched an active section bug where no sections were active when a section matched the exact pixel offset calculated
64
65## v2.3.0 - October 9, 2014
66
67* Updated min Node to 0.10.\*
68* Updated all Node plugins to latest
69
70## v2.2.0 - March 14, 2014
71
72* Added option to change the classname used throughout the plugin.
73* Updated jQuery dep to 1.9.\*
74
75## v2.1.1 - December 13, 2013
76
77Added `scrollnav` namespace to event listeners to avoid crashing in to user defined event listeners.
78
79## v2.1.0 - November 15, 2013
80
81v2.1 adds support for public methods, a new destroy method, custom callbacks for init, render and destroy, and small bugfixes.
82
83* Reorganized core to allow for new public methods
84* Added destroy method to core to allow for breaking down the plugin and it's dom \* changes
85* Added the option to add callback functions to init, render and destroy
86* Squashed a bug when wrapping sub-sections in their div
87* Updated core init in test for easier reuse
88* Fixed Grunt test:browser task to only run in the browser
89* Added destroy tests to core module and a new module for the callbacks
90
91## v2.0.2 - October 31, 2013
92
93Double releasing to include changelog and readme updates in Bower. One day I'll figure all this out :)
94
95## v2.0.1 - October 31, 2013
96
97Bugfixes for the following:
98
99* package.json now includes semver: Ooops, sorry
100* Moved jQuery dependency from package.json to bower.json and updated jQuery dep to v1.8.\*
101* Removed unneeded build dirs from bower install
102* Updated gitignore to ignore bower_components
103
104## v2.0.0 - October 11, 2013
105
106v2 is a complete re-write of scrollnav and includes better code organization, new options, updated options, grunt integration, and bugfixes. This update will most like break your options and markup from v1, please read through the following changes and reference the [readme](https://github.com/jimmynotjim/scrollnav/blob/master/README.md) for further details.
107
108* Updated to wrap each section in a `section` tag and support for sub-sections (as well as an option to change the wrapping element).
109* Fixed the active state when scrolling, no longer switches to the next nav item as the page finishes scrolling.
110* There are now two classes added to the nav item when scrolling, `active` and `in-view`. All sections within the view bounds are marked as `in-view` and the topmost section is marked as `active`.
111* Added grunt workflow. Edits to the plugin should be made in `/src/scrollnav.js` with tests to support them and jshint, qunit, concat and uglify should be run before submitting PRs.
112* Added parsing of url for an element hash. This fixes inbound urls with a hash not scrolling to the section if plugin loading is delayed.
113* Added arrow key navigation option. When enabled, users can jump from section to section using the up/down arrow keys.
114* Added option to change insertion target.
115* Added Bower support for easy project dependency management.
116* Updated the class names of scrollnav elements to follow BEM conventions.
117* Updated existing settings option naming for the following (_this may break your current setups_):
118 * `titleText` -> `headlineText`
119 * `location` -> `insertLocation`
120
121## v1.2.0
122
123Added topLinkText option to customize the top link text (Thanks to [Wizcover][11]).
124
125## v1.1.4
126
127Updated Readme to include new options.
128
129## v1.1.3
130
131Added option for insertion location.
132
133## v1.1.2
134
135Added option to remove Top Link from the nav.
136
137## v1.1.1
138
139Fixed html rather than text being added to nav elements where heading contains nested elems.
140
141## v1.1.0
142
143Added options for showing Headline Text and animation speed.
144
145## v1.0.1
146
147Added ARIA support to nav elem (Thanks to [Jeff Coburn][10]).
148
149## v1.0.0
150
151Initial Release of scrollnav