mirrors/OverlayScrollbars
2
0
Fork 0
mirror of https://github.com/tenrok/OverlayScrollbars.git synced 2026-06-20 20:30:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
Rene Haas
2022-10-13 14:26:13 +02:00
parent e713de4789
commit d0139f7c9a
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -41,6 +41,7 @@ I've created this plugin because I hate ugly and space consuming scrollbars. Sim
- Bidirectional - LTR or RTL direction support - Bidirectional - LTR or RTL direction support
- Simple and effective scrollbar styling - Simple and effective scrollbar styling
- TypeScript support - fully written in TypeScript - TypeScript support - fully written in TypeScript
- Incredibly well tested - extensive unit, integration & e2e tests
## Getting started ## Getting started
@@ -431,8 +432,15 @@ OverlayScrollbars.plugin([SizeObserverPlugin, ClickScrollPlugin]);
#### Writing Plugins #### Writing Plugins
> __Note__: For now please refer to the <b>TypeScript definitions</b> for a more detailed description.
You can write and publish your own Plugins. This section is a work in progress. You can write and publish your own Plugins. This section is a work in progress.
## Feature comparison to `v1`
- The `scroll` function is missing. Planned as a `plugin`. (WIP)
- Initialization to the `textarea` element isn't supported yet. Planned as a `plugin`. (WIP)
## Sponsors ## Sponsors
<table> <table>
<tr> <tr>
packages/overlayscrollbars/README.md
+1 -1
View File
@@ -41,7 +41,7 @@ I've created this plugin because I hate ugly and space consuming scrollbars. Sim
- Bidirectional - LTR or RTL direction support - Bidirectional - LTR or RTL direction support
- Simple and effective scrollbar styling - Simple and effective scrollbar styling
- TypeScript support - fully written in TypeScript - TypeScript support - fully written in TypeScript
- Very well tested - extensive unit & e2e tests - Incredibly well tested - extensive unit, integration & e2e tests
## Getting started ## Getting started