foxlake 0.6.3
Install from the command line:
Learn more about npm packages
$ npm install @project-sparrow/foxlake@0.6.3
Install via package.json:
"@project-sparrow/foxlake": "0.6.3"
About this version
Sparrow UI component library built with TailwindCSS.
This is the React UI component library for the Project Sparrow front-end web client. This library must follow the styles & guidelines specified by the Sparrow Design & Creative team. If you have any inquiries please make an issue or message a UI/UX leader on Discord.
- Node 16
- Yarn
yarn add @project-sparrow/foxlake
import { Button } from '@project-sparrow/foxlake'
// ...
export default function ExampleComponent() {
return (
<>
<Button type="secondary" icon="RocketLaunchIcon">Hello World!</Button>
</>
);
}
Make sure you have linted all your files, if not then just execute yarn lint
, then proceed with the command below.
yarn build
For development environment just run the command below.
yarn storybook
In case you want to export the docs as a static site.
yarn build:storybook
-
/.storybook
- Storybook configuration.
-
/stories
- This directory defines the documentation for the components.
-
/src
- This directory defines React components for the library, and is the main directory with the main TS file.
-
/dist
- Library build output.
-
/docs
- Storybook build output, Webpack static site.
MIT License, Β© 2022 Project Sparrow