Skip to content

Commit

Permalink
docs(storybook): import docs from README to storybook Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
asmyshlyaev177 authored and asmyshlyaev177 committed Jun 29, 2024
1 parent 1e3d4fa commit 239d85d
Show file tree
Hide file tree
Showing 5 changed files with 1,735 additions and 252 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Check out examples on [Storybook](https://asmyshlyaev177.github.io/react-horizon
```bash
npm install --save react-horizontal-scrolling-menu
```

test
In project:

```javascript
Expand Down Expand Up @@ -188,6 +188,7 @@ npm run setup
npm run storybook
```

<!-- DOCS_START -->
### Helpers and api

Children of main ScrollMenu component(arrows, fotter, items) can use **VisibilityContext** to access state and callbacks.
Expand Down Expand Up @@ -319,6 +320,8 @@ For scrolling use `apiRef.scrollToItem(apiRef.getItemElementById)` instead of `a
Can get item outside of context via `apiRef.getItemElementById(id)` or directly via ``document.querySelector(`[data-key='${itemId}']`)``.
See [`apiRef` example and `Add item and scroll to it`](#examples)

<!-- DOCS_END -->

## Browser support

- Browser must support **IntersectionObserver API** and **requestAnimationFrame** or use polyfills.
Expand Down
4 changes: 3 additions & 1 deletion example-nextjs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 239d85d

Please sign in to comment.