From c5e1d3ac4e9137c99025b4fe19d4a9a3e0f614a7 Mon Sep 17 00:00:00 2001 From: guiyep Date: Tue, 17 Oct 2023 09:15:21 +1000 Subject: [PATCH] adding docsify --- README.md | 176 +------------ docs/.nojekyll | 0 docs/README.md | 251 ++++++++++++++++++ docs/_coverpage.md | 6 + docs/index.html | 32 +++ docs/logo.png | Bin 0 -> 22783 bytes package.json | 6 +- yarn.lock | 643 ++++++++++++++++++++++++++++++++++++++++++++- 8 files changed, 929 insertions(+), 185 deletions(-) create mode 100644 docs/.nojekyll create mode 100644 docs/README.md create mode 100644 docs/_coverpage.md create mode 100644 docs/index.html create mode 100644 docs/logo.png diff --git a/README.md b/README.md index 461dd9a..dc7daec 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ I created a component that uses the Airbnb library called `react-virtualized` fo ## Install ```bash -npm install --save react-select-virtualized +yarn add react-select-virtualized ``` ### Peer Dependencies @@ -35,30 +35,16 @@ npm install --save react-select-virtualized } ``` -## Note +## API Documentation -The select component will be the same from `react-select v5` so you will be able to use it with any select you already have. +You can check the full library documentation [here](https://deluxe-blancmange-4a5494.netlify.app/#/)!!!!. -## Try It +## Examples -[![Edit react-select-virtualized](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vigilant-mclean-wpbk7) +The select component will be the same from `react-select v5` so you will be able to use it with any select you already have. Check [Storybook](https://serene-hawking-021d7a.netlify.com/) for more examples -## What we do support and don't from react-select - -Components: `Select`, `Async`, `Creatable` - -- [x] We support all the UI related props for the input. Extension also. - -- [x] We do not support any related prop to the popup list. We extend it. \*Sorry no extension of any component inside the list.\* - -- [x] Sorry no multi selection yet. (no `isMulti`) - -# Examples - -## Options Shape - ```jsx const options = [ { @@ -97,155 +83,3 @@ const Example1 = () => ; +``` + +[![Edit react-select-virtualized](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/vigilant-mclean-wpbk7) + +## With group + +```jsx +import React from 'react'; + +import Select from 'react-select-virtualized'; + +const Example1 = () =>