Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yunusga/postcss-momentum-scrolling
PostCSS plugin add 'momentum' style scrolling behavior (-webkit-overflow-scrolling: touch) for elements with overflow (scroll, auto) on iOS
https://github.com/yunusga/postcss-momentum-scrolling
css inertia-scroll ios ios-safari momentum momentum-scrolling overflow postcss postcss-plugin safari scroll touch
Last synced: 11 days ago
JSON representation
PostCSS plugin add 'momentum' style scrolling behavior (-webkit-overflow-scrolling: touch) for elements with overflow (scroll, auto) on iOS
- Host: GitHub
- URL: https://github.com/yunusga/postcss-momentum-scrolling
- Owner: yunusga
- License: mit
- Created: 2017-10-23T12:59:51.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-18T20:15:20.000Z (over 1 year ago)
- Last Synced: 2024-10-23T13:41:37.745Z (21 days ago)
- Topics: css, inertia-scroll, ios, ios-safari, momentum, momentum-scrolling, overflow, postcss, postcss-plugin, safari, scroll, touch
- Language: JavaScript
- Homepage: https://github.com/yunusga/postcss-momentum-scrolling
- Size: 945 KB
- Stars: 69
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PostCSS Momentum Scrolling
[PostCSS]: https://github.com/postcss/postcss
[MIT]: https://github.com/solversgroup/postcss-momentum-scrolling/LICENSE
[official docs]: https://github.com/postcss/postcss#usage
[Releases history]: https://github.com/solversgroup/postcss-momentum-scrolling/CHANGELOG.md
[](https://www.npmjs.com/package/postcss-momentum-scrolling)
[](https://www.npmjs.com/package/postcss-momentum-scrolling)
[PostCSS] plugin for adding **momentum** style scrolling behavior (`-webkit-overflow-scrolling:touch`) for elements with overflow (scroll, auto) on iOS.
## Example
```css
/* Input example */
.minicart {
overflow: scroll;
}
```
```css
/* Output example */
.minicart {
overflow: scroll;
-webkit-overflow-scrolling: touch;
}
```
## Live Example
[Live demo](https://dev.solvers.group/momentum/), [YouTube demo](https://www.youtube.com/watch?v=mYLSv7Il-D0)
### 🔗 Links:
- [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-overflow-scrolling)
- [Momentum Scrolling on iOS Overflow Elements](https://css-tricks.com/snippets/css/momentum-scrolling-on-ios-overflow-elements/)
- [Six things I learnt about iOS Safari's rubber band scrolling](https://www.specialagentsqueaky.com/blog-post/ssy5i7qw/2015-06-10-six-things-i-learnt-about-ios-rubberband-overflow-scrolling/)
## Getting Started
First thing's, install the module:
```
npm install postcss-momentum-scrolling --save-dev
```
## 🍳 Usage
Check you project for existed PostCSS config: `postcss.config.js`
in the project root, `"postcss"` section in `package.json`
or `postcss` in bundle config.
If you already use PostCSS, add the plugin to plugins list:
```diff
module.exports = {
plugins: [
+ require('postcss-momentum-scrolling')([
+ // example options
+ 'hidden',
+ 'scroll',
+ 'auto',
+ 'inherit'
+ ]),
require('autoprefixer')
]
}
```
If you do not use PostCSS, add it according to [official docs]
and set this plugin in settings.
## 🍰 Options
> If the passed options are not an `Array`, then the default options will be set.
`Array` of `overflow` property values at which you want to add momentum style scrolling behavior. Default `['hidden', 'scroll', 'auto', 'inherit']` (use only `['scroll']` for minimize css size).
### Custom options example
```js
postcss([
require('postcss-momentum-scrolling')([
'hidden',
'inherit'
])
])
```
```css
/* Before */
header {
overflow: hidden;
}
main {
overflow: scroll;
}
footer {
overflow: inherit;
}
```
```css
/* After */
header {
overflow: hidden;
-webkit-overflow-scrolling: touch;
}
main {
overflow: scroll;
}
footer {
overflow: inherit;
-webkit-overflow-scrolling: touch;
}
```
## Changelog
See [Releases history]
## License
[MIT]
## Other PostCSS plugins
- [`postcss-sort-media-queries`](https://github.com/yunusga/postcss-sort-media-queries) - plugin for combine and sort CSS media queries with **mobile first** or **desktop first** methods