-
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.
feat: customizing welcome page and get started page
- Loading branch information
Showing
6 changed files
with
82 additions
and
10 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
Binary file not shown.
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 |
---|---|---|
|
@@ -29,5 +29,5 @@ | |
".storybook/*.js", | ||
".storybook/*.ts", | ||
".storybook/preview.tsx" | ||
] | ||
, ".storybook/titleAddon.tsx" ] | ||
} |
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,8 +1,43 @@ | ||
import { Meta } from '@storybook/blocks'; | ||
import { Meta } from '@storybook/addon-docs'; | ||
|
||
<Meta title="Get Started" /> | ||
|
||
<div classname="content"> | ||
<h1>Get Started</h1> | ||
<h3>Test</h3> | ||
</div> | ||
## **Install** | ||
|
||
Bootwind UI should be installed as a `dependency` of your app. | ||
|
||
```sh | ||
yarn add @bootwindproject/bootwindui | ||
``` | ||
|
||
## **Setup** | ||
|
||
Bootwind UI components are styled using CSS in JS. This technique requires a style renderer which inserts CSS into DOM when needed. React context is used to provide the style renderer. | ||
|
||
Place a `<BootwindProvider />` at the root of your app and pass theme as a prop. | ||
|
||
```jsx | ||
import React from 'react'; | ||
import ReactDOM from 'react-dom'; | ||
import { BootwindProvider } from '@bootwindproject/bootwindui'; | ||
|
||
import App from './App'; | ||
|
||
ReactDOM.render( | ||
<BootwindProvider> | ||
<App /> | ||
</BootwindProvider>, | ||
document.getElementById('root') | ||
); | ||
``` | ||
|
||
## **Usage** | ||
|
||
That's it. You can now use Bootwind UI components in your app. | ||
|
||
```jsx | ||
import React from 'react'; | ||
import { Button } from '@bootwindproject/bootwindui'; | ||
|
||
export default () => <Button color="primary">Get started</Button>; | ||
``` |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.