0.1.0 • Published 3 years ago

@belkalab/fic-rn-design-system-storybook v0.1.0

Weekly downloads
-
License
-
Repository
-
Last release
3 years ago

FIC RN Design System 🦄

React Native design system shared by FIC & DIC mobile ✨

All the components of this repository are functional components built with the help of typescript, expo, storybook and styled-components 🔥

Table of Contents

Dependency

yarn add @belkalab/fic-rn-design-system

Quick start 🏃🏻‍♂️

This repository is built using storybook (more info), so that we can develop and test our components indipendently from the rest of the app environment.

To check it out, just run yarn storybook in the root directory of the repo.

Once it's started you can run yarn ios or yarn android to see the components on Expo.

Contributing

This section explains how to add a new component and its stories to the design system 🎉

Adding a new component

To add a new component, create a folder named like it in the src/components/ directory.
Then add two files:

  • One named like the component, which exports the component itself
  • index.ts which imports the component from the first file and exports it (non-default)

Adding a component stories

To add the stories for a component, create a folder under storybook/stories/ and add the stories into it.

Then add a file named [componentName].stories.tsx in the storybook/stories/ directory.
This file imports all the stories in the folder created before.

Add to storybook/stories/index.tsx an import to this file.

List of components

This is the list of all the components included in this repo 👀