Leap UI Kit
Reusable react component library for Leap Organisation
Installation
npm i @leapfinance/ui-kit
OR
yarn add @leapfinance/ui-kit
UseCase
import { ImageWithText } from "@leapfinance/ui-kit";
// ...
<ImageWithText
img="https://leapassets.s3.ap-south-1.amazonaws.com/workshop/1669013114743-tick_(2)_1.png"
onClick={() => {}}
text="100+ Mock Tests"
/>
Guide
Useful CLI
# to create folder structure in components
yarn plop create {$FileName}
# to create new Component in the packages
yarn plop add {$ComponentName}
# to displaying components
yarn storybook
# to create declaration file
yarn tsm
reference
- Design System Doc open
Tips and Tricks For Development
- use npm link to test your package in your project. read more
- use storybook to see the ui of your components. read more
- use snapshot to publish your packages for testing.
RULES
- Always use TitleCase to create new folder or component
- Don't use any external lib
- Always use plop to create new folder or components.
- Never forget to write stories for the components.