Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.18 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.18 KB
Raw

@makinox/makinox-ui

A little UI library with basic components and near zero dependencies and hard configurations.

Used

  • Stiches
  • Storyboard Only for development
  • React Only for storybook visualization, you can use any framework you like

Link to makinox-ui!

Usage

Just install with

npm i @makinox/makinox-ui
----
yarn add @makinox/makinox-ui

Add this to your code if you want the base colors

import '@makinox/makinox-ui/dist/colors.css';

If you want to use custom colors, just copy the format of the file and replace the colors, then import the content of the file to your code

Also, you can add the base layout classes like this if you want, this is optional

import '@makinox/makinox-ui/dist/index.css';

Documentation

You can see the current components available in this web https://makinox-ui.jesusbossa.dev Also, you can see these components locally running this command

yarn storybook

Contributing

If you're interested in contributing to project, please read our contributing docs before submitting a pull request.