Skip to content

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

Foxlake

GitHub tag (latest SemVer) Discord chat

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.

πŸ“ Prerequisites

  • Node 16
  • Yarn

πŸš€ Quick start

✨ Installation

yarn add @project-sparrow/foxlake

🧩 Usage

import { Button } from '@project-sparrow/foxlake'
// ...
export default function ExampleComponent() {
  return (
    <>
      <Button type="secondary" icon="RocketLaunchIcon">Hello World!</Button>
    </>
  );
}

πŸͺ„ Build components

Make sure you have linted all your files, if not then just execute yarn lint, then proceed with the command below.

yarn build

πŸ“š Generate & build docs

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

πŸ“‚ Project structure

  • /.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.

πŸ“™ License

MIT License, Β© 2022 Project Sparrow

Details


Assets

  • foxlake-0.6.3.tgz

Download activity

  • Total downloads 6
  • Last 30 days 0
  • Last week 0
  • Today 0