docs: update demo links, closes #95

nerdyman · Aug 26, 2023 · a2ec68d · a2ec68d
1 parent 6cc66ed
commit a2ec68d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -42,8 +42,8 @@
 ## Demo
 
 - Storybook: [docs](https://react-compare-slider.vercel.app/?path=/docs/docs-introduction--page), [demos](https://react-compare-slider.vercel.app/?path=/story/demos)
-- CodeSandbox: [basic editable demo](https://codesandbox.io/s/react-compare-slider-simple-example-9si6l)
-- [Local example](./docs)
+- CodeSandbox: [basic demo](https://codesandbox.io/p/sandbox/github/nerdyman/react-compare-slider/tree/main/docs/example?file=/src/App.tsx:1,1)
+- [Local example](./docs/example)
 
 ## Usage
 

diff --git a/docs/example/README.md b/docs/example/README.md
@@ -1,10 +1,7 @@
-<div align="center">
-
 # React Compare Slider Demo
 
-👉 [CodeSandbox Demo](https://codesandbox.io/p/sandbox/github/nerdyman/react-compare-slider/tree/main/docs/example) 👈
-
-</div>
+- 🧑‍💻 [CodeSandbox Demo](https://codesandbox.io/p/sandbox/github/nerdyman/react-compare-slider/tree/main/docs/example?file=/src/App.tsx:1,1)
+- 🐙 [Github Repo](https://github.com/nerdyman/react-compare-slider)
 
 ---
 

diff --git a/docs/storybook/content/01-api.stories.mdx b/docs/storybook/content/01-api.stories.mdx
@@ -1,10 +1,11 @@
 import { Description, Meta, ArgTypes } from '@storybook/blocks';
 
 import {
-  ReactCompareSlider, 
+  ReactCompareSlider,
   ReactCompareSliderHandle,
   ReactCompareSliderImage,
   styleFitContainer,
+  useReactCompareSliderRef,
 } from 'react-compare-slider';
 
 <Meta title="Docs/API" />
@@ -79,9 +80,11 @@ import { styleFitContainer } from 'react-compare-slider';
 
 ## `useReactCompareSliderRef`
 
+<Description of={useReactCompareSliderRef} />
+
 [🔗 Source](https://github.com/nerdyman/react-compare-slider/blob/main/src/useReactCompareSliderRef.ts)
 
-The `useReactCompareSliderRef` provides a ref to the root element of the slider and exposes the internal
+The `useReactCompareSliderRef` hook provides a ref to the root element of the slider and exposes the internal
 function used to control the position of the slider. It offers performant programmatic control of the slider.
 
 Check out the [`useReactCompareSliderRef` docs](/story/docs-usereactcomparesliderref--page) more information.