Getting Started
Installation
The best way to include react-sheikah-ui
is via the npm
package which you can install with npm
(or yarn
if
you prefer).
npm install react-sheikah-ui
# or
yarn add react-sheikah-ui
Usage
To use these components, first import StyleWrapper
and use it to wrap your page or your app.
import { StyleWrapper } from "react-sheikah-ui";
<StyleWrapper theme="dark">
<YourApp />
</StyleWrapper>;
You can also set the theme in the StyleWrapper
with dark
or light
. If left empty, it will be defaulted to dark
.
Theme Color Palette
You can access the theme colors by using useTheme
hook.
import { useTheme } from "react-sheikah-ui";
const theme = useTheme();
<div style={{ background: theme.color.uiBlue }} />
<div style={{ background: theme.color.uiLightSecondary }} />
List of available colors:
uiLightPrimary
uiLightSecondary
uiDarkPrimary
uiDarkSecondary
uiBlue
uiCyan
uiGreen
uiRed
uiYellow
uiTrueBlack
uiTrueWhite