Skip to content

Commit

Permalink
chore: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Grsmto committed Jan 15, 2023
1 parent f41405f commit a83c819
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 389 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,16 @@
SimpleBar does only one thing: replace the browser's default scrollbar with a custom CSS-styled one without losing performances.
Unlike some popular plugins, SimpleBar doesn't mimic scroll with Javascript, causing janks and strange scrolling behaviours...
You keep the awesomeness of native scrolling...with a custom scrollbar!

SimpleBar **does NOT implement a custom scroll behaviour**. It keeps the **native** `overflow: auto` scroll and **only** replace the scrollbar visual appearance.

### [🐦 Follow me on Twitter!](https://twitter.com/adriendenat)

### 👨‍💻 I'm available for hire! [Reach out to me!](https://adriendenat.com/)

### 🚧 Check out my new project [Scroll Snap Carousel](https://github.com/Grsmto/scroll-snap-carousel)!

:warning: SimpleBar v6 is here! There are some **breaking changes!** Make sure to check out [the changelog](https://github.com/Grsmto/simplebar/blob/master/packages/simplebar-core/CHANGELOG.md) before updating.

#### Design it as you want

SimpleBar uses pure CSS to style the scrollbar. You can easily customize it as you want! Or even have multiple style on the same page...or just keep the default style ("Mac OS" scrollbar style).
Expand Down Expand Up @@ -47,9 +54,6 @@ You can check our [demo page](https://grsmto.github.io/simplebar/examples) (whic

See changelog here : https://github.com/Grsmto/simplebar/releases

### 👨‍💻 I'm available for hire! [Reach out to me!](https://adriendenat.com/)
### 🚧 Check out my new project [Scroll Snap Carousel](https://github.com/Grsmto/scroll-snap-carousel)!

### Credits

- [KingSora](https://github.com/KingSora) for multiple features and inspirations (`height: auto` detection, RTL mode cross browser support and more) with [OverlayScrollbars](https://kingsora.github.io/OverlayScrollbars/).
Expand Down
8 changes: 7 additions & 1 deletion packages/simplebar-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@

# SimplebarAngular

### [🐦 Follow me on Twitter!](https://twitter.com/adriendenat)

### 👨‍💻 I'm available for hire! [Reach out to me!](https://adriendenat.com/)

### 🚧 Check out my new project [Scroll Snap Carousel](https://github.com/Grsmto/scroll-snap-carousel)!

### Installation

**- Via npm**
Expand All @@ -34,7 +40,7 @@ import { AppComponent } from './app.component';
declarations: [AppComponent],
imports: [BrowserModule, SimplebarAngularModule],
providers: [],
bootstrap: [AppComponent]
bootstrap: [AppComponent],
})
export class AppModule {}
```
Expand Down
17 changes: 17 additions & 0 deletions packages/simplebar-core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## 6.0.0

### Major

- :warning: SimpleBar v6 does not use any polyfill anymore by default!
If you see any error in a browser you want support for, you might need a polyfill!
You can use Babel `@babel/preset-env` to polyfill for you, see our [examples package](https://github.com/Grsmto/simplebar/blob/next/packages/examples/.babelrc#L2) or check out [polyfill.io](https://polyfill.io/).
- `timeout` option is now deprecated. It is now only made with a CSS transition that you can override with CSS as you want.
- `mutation-observer` polyfill is not shipped by default anymore.
- `core-js` is not included anymore. We now use TypeScript instead of Babel so polyfilling is up to you!
- Bundle is much smaller!
- New useful classes on host element:
`.simplebar-hover`,
`.simplebar-mouse-entered`,
`.simplebar-scrolling`,
`.simplebar-scrollable`.
- Scrollbar recalculations are now throttled with RAQ instead of Lodash's throttle function, which prevents stuttering on animations (#507)
Loading

0 comments on commit a83c819

Please sign in to comment.