-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update storybook docs with videos
[skip-native]
- Loading branch information
1 parent
08ca309
commit 243098b
Showing
9 changed files
with
16 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-1.29 MB
apps/native-ui-storybook/docs/native-ui/guides/assets/dark-mode.gif
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-7.78 MB
apps/native-ui-storybook/docs/native-ui/guides/assets/device-mode.gif
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-2.31 MB
apps/native-ui-storybook/docs/native-ui/guides/assets/playground.gif
Binary file not shown.
Binary file not shown.
22 changes: 16 additions & 6 deletions
22
apps/native-ui-storybook/docs/native-ui/guides/using-storybook.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,38 @@ | ||
import { Meta } from '@storybook/blocks'; | ||
import playground from './assets/playground.gif'; | ||
import darkMode from './assets/dark-mode.gif'; | ||
import deviceMode from './assets/device-mode.gif'; | ||
import playground from './assets/playgrounds.mp4'; | ||
import darkMode from './assets/darkmode.mp4'; | ||
import deviceMode from './assets/devices.mp4'; | ||
|
||
<Meta title="Native UI / Guides / Using Storybook" /> | ||
|
||
# Using Storybook | ||
|
||
This Storybook is for the Native UI library. It is a tool for developing UI components in isolation for React Native which we use to share and document our components. | ||
|
||
- [Playgrounds](#playgrounds) | ||
- [Dark mode](#dark-mode) | ||
- [Device Selection](#device-selection) | ||
|
||
## Playgrounds | ||
|
||
Most components have a playground where you can interact with the component and see how it behaves with different props. You can change the props in the controls on the right side of the screen and see the component update in real time. | ||
|
||
<img src={playground} /> | ||
<video width="100%" height="auto" autoplay="autoplay" loop controls> | ||
<source src={playground} type="video/mp4" /> | ||
</video> | ||
|
||
## Dark mode | ||
|
||
Storybook has a dark mode. You can enable it by clicking the moon icon in the top right corner of the screen. If the styles of the component don't change you can refresh the page and try again. | ||
|
||
<img src={darkMode} /> | ||
<video width="100%" height="auto" autoplay="autoplay" loop controls> | ||
<source src={darkMode} type="video/mp4" /> | ||
</video> | ||
|
||
## Device Selection | ||
|
||
You can change the device you are viewing the component on by clicking the device icon in the top right corner of the screen. This will allow you to see how the component looks on different devices such as Web, iOS or Android. You can then update the component with the controls and change the device colour mode. | ||
|
||
<img src={deviceMode} /> | ||
<video width="100%" height="auto" autoplay="autoplay" loop controls> | ||
<source src={deviceMode} type="video/mp4" /> | ||
</video> |