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

improve readme

Browse Source
This commit is contained in:
Rene Haas
2022-11-17 09:19:40 +01:00
parent 26f42d09c0
commit c6232bd3c0
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/overlayscrollbars-react/README.md
+2 -2
View File
@@ -65,7 +65,7 @@ import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
### Properties ### Properties
The component accepts all properties of intrinsic JSX elements such as `div` and `span`. The component accepts all properties of intrinsic JSX elements such as `div` and `span`.
Additionally it has three optional properties: `element`, `options` and `events`. Additionally it has custom optional properties:
- `element`: accepts a `string` which represents the tag of the root element. - `element`: accepts a `string` which represents the tag of the root element.
- `options`: accepts an `object` which represents the OverlayScrollbars options. - `options`: accepts an `object` which represents the OverlayScrollbars options.
@@ -121,7 +121,7 @@ The hook will destroy the instance automatically if the component unmounts.
### Parameters ### Parameters
Parameters are optional and similar to the `OverlayScrollbarsComponent`. Parameters are optional and similar to the `OverlayScrollbarsComponent`.
Its an `object` with two optional properties: Its an `object` with optional properties:
- `options`: accepts an `object` which represents the OverlayScrollbars options. - `options`: accepts an `object` which represents the OverlayScrollbars options.
- `events`: accepts an `object` which represents the OverlayScrollbars events. - `events`: accepts an `object` which represents the OverlayScrollbars events.