Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.07 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.07 KB

@xlox/ui

React component library based on Xlox design system

Table of contents:

How to install ?

npm install @xlox/ui

How to use the package ?

  • For using Components
import { HorizontalDivider, Row } from "@xlox/ui";
  • For using Primitives
import { mainColors } from "@xlox/ui";
  • For using Types
import { ButtonProps } from "@xlox/ui";

How to add new features to the package ?

  • Step 1 run

    npm run plop

  • Step 2 choose component from the provided option

  • Step 3 provide the required details about the component

  • Step 4 after the component is developed, expose it for consumtion via a components/index.ts

  • Step 5

    • Go to UIkit path via cd
    • Build the components as a library for consumtion via a

      npm run build

Scope of improvement ?