Skip to content

Commit

Permalink
bump library version
Browse files Browse the repository at this point in the history
  • Loading branch information
bfiessinger committed Mar 8, 2021
1 parent 81e0a18 commit e6a848f
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 5 deletions.
30 changes: 30 additions & 0 deletions changelog.MD
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# Changelog

### 3.0.0

#### Features
- Allow custom easing functions
- Allow a custom amount of pixels to use as an offset (#3)
- Animated scrolling links at the very top or bottom can now exceed the actual document so that easing functions like for example `easeInOutBounce` don't stop animating while exceeding the document.
- Introduced `scrollBy` method
- `scrollTo` now accepts numeric values

#### Enhancements
- Make imports of easings optional to enhance filesize control
- Import linear only per default (see Important Notes)
- Enhanced easing patterns

#### Bug Fixes
- Fixed a bug where the final position was calculated wrong in some situations
- Bundled browser file was not transpiled to es5

#### Code Quality
- Created a seperate file for each easing function
- Create Typescript declaration files
- Various minor bug fixes and structural improvements
- Add esm bundle
- Add cjs bundle

#### Important Notes
Version 3.0.0 is a major update and comes with some breaking changes:
- Easings are no longer imported by default, you have to import individual easings like `import { easeInQuad, easeOutQuad } from 'scrolltosmooth';`
- The `fixedHeader` option has been renamed to `offset` and accepts a fixed amount of pixels now

### 2.2.1
- Fix broken easings (easeInBack, easeOutBack, easeInOutBack)

Expand Down
2 changes: 1 addition & 1 deletion dist/scrolltosmooth.cjs.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*!
* ScrollToSmooth
* Author: Bastian Fießinger
* Version: 2.2.1
* Version: 3.0.0
*/
'use strict';

Expand Down
2 changes: 1 addition & 1 deletion dist/scrolltosmooth.esm.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*!
* ScrollToSmooth
* Author: Bastian Fießinger
* Version: 2.2.1
* Version: 3.0.0
*/
function _typeof(obj) {
"@babel/helpers - typeof";
Expand Down
2 changes: 1 addition & 1 deletion dist/scrolltosmooth.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/scrolltosmooth.pkgd.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "scrolltosmooth",
"sideEffects": false,
"version": "2.2.1",
"version": "3.0.0",
"description": "a vanilla JS smooth scroll to anchor script",
"main": "dist/scrolltosmooth.cjs.js",
"module": "dist/scrolltosmooth.esm.js",
Expand Down

0 comments on commit e6a848f

Please sign in to comment.