Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pascalduez/postcss-scrollbar
PostCSS plugin enabling custom scrollbars
https://github.com/pascalduez/postcss-scrollbar
css postcss
Last synced: 4 days ago
JSON representation
PostCSS plugin enabling custom scrollbars
- Host: GitHub
- URL: https://github.com/pascalduez/postcss-scrollbar
- Owner: pascalduez
- License: unlicense
- Created: 2018-12-26T18:48:47.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T10:29:30.000Z (almost 2 years ago)
- Last Synced: 2024-12-08T20:16:31.585Z (15 days ago)
- Topics: css, postcss
- Language: JavaScript
- Size: 744 KB
- Stars: 74
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# postcss-scrollbar
[![npm version][npm-image]][npm-url]
[![CI Status][ci-image]][ci-url]
[![Coverage Status][codecov-image]][codecov-url]
> [PostCSS] plugin enabling custom scrollbars
Spec : https://drafts.csswg.org/css-scrollbars-1
Browser support: https://caniuse.com/#feat=css-scrollbar
Docs: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Scrollbars
## Installation
```
npm install postcss postcss-scrollbar --save-dev
```
or
```
yarn add postcss postcss-scrollbar --save-dev
```
## Usage
```js
const fs = require('node:fs');
const postcss = require('postcss');
const scrollbar = require('postcss-scrollbar');
let input = fs.readFileSync('input.css', 'utf8');
postcss()
.use(scrollbar)
.process(input)
.then(result => {
fs.writeFileSync('output.css', result.css);
});
```
## Examples
```css
/* input */
.scrollable {
scrollbar-color: rebeccapurple green;
scrollbar-width: thin;
}
```
```css
/* output */
.scrollable::-webkit-scrollbar-thumb {
background-color: rebeccapurple;
}
.scrollable::-webkit-scrollbar-track {
background-color: green;
}
.scrollable::-webkit-scrollbar-corner {
background-color: green;
}
.scrollable::-webkit-scrollbar {
width: 8px;
height: 8px;
}
.scrollable {
-ms-overflow-style: auto;
scrollbar-color: rebeccapurple green;
scrollbar-width: thin;
}
```
```css
/* input */
.scrollable {
scrollbar-width: none;
}
```
```css
/* output */
.scrollable::-webkit-scrollbar {
width: 0;
height: 0;
}
.scrollable {
-ms-overflow-style: none;
scrollbar-width: none;
}
```
## options
### `width`
type: `String`
default: `8px`
Allows for setting the webkit fallbacks `width` and `height`.
### `edgeAutohide`
type: `Boolean`
default: `false`
Allows for setting the scrollbar behaviour for the Edge Browser.
`-ms-overflow-style: -ms-autohiding-scrollbar;`
Edge doesn't support scrollbar styling.
See https://developer.mozilla.org/fr/docs/Web/CSS/-ms-overflow-style
## Credits
- [Pascal Duez](https://github.com/pascalduez)
## Licence
postcss-scrollbar is [unlicensed](http://unlicense.org/).
[postcss]: https://github.com/postcss/postcss
[npm-url]: https://www.npmjs.org/package/postcss-scrollbar
[npm-image]: http://img.shields.io/npm/v/postcss-scrollbar.svg?style=flat-square
[ci-url]: https://github.com/pascalduez/postcss-scrollbar/actions/workflows/ci.yml
[ci-image]: https://img.shields.io/github/actions/workflow/status/pascalduez/postcss-scrollbar/ci.yml?branch=main&style=flat-square
[codecov-url]: https://codecov.io/gh/pascalduez/postcss-scrollbar
[codecov-image]: https://img.shields.io/codecov/c/github/pascalduez/postcss-scrollbar.svg?style=flat-square
[license-image]: http://img.shields.io/npm/l/postcss-scrollbar.svg?style=flat-square
[license-url]: UNLICENSE