From c6232bd3c04d86c3c8ef0d057ab1141ddb2659dc Mon Sep 17 00:00:00 2001 From: Rene Haas Date: Thu, 17 Nov 2022 09:19:40 +0100 Subject: [PATCH] improve readme --- packages/overlayscrollbars-react/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/overlayscrollbars-react/README.md b/packages/overlayscrollbars-react/README.md index fc9af42..6542e83 100644 --- a/packages/overlayscrollbars-react/README.md +++ b/packages/overlayscrollbars-react/README.md @@ -65,7 +65,7 @@ import { OverlayScrollbarsComponent } from "overlayscrollbars-react"; ### Properties 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. - `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 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. - `events`: accepts an `object` which represents the OverlayScrollbars events.