Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.34 KB

README.md

File metadata and controls

67 lines (41 loc) · 2.34 KB
Raw

Material-UI logo

Sodium UI

Swiftly develop elegant React apps. Sodium is a simple, modular, customizable and of course, React(ive) web component library to build beautiful and accessible UI pieces for your React needs.

Installation

Sodium-UI is available as an npm package.

// using npm
$ npm i sodium-ui

// using yarn
$ yarn add sodium-ui

Features

  • Sodium UI has React Components that makes your life easy while developing React Apps.
  • Styling components in Sodium is quite simple and flexible to handle.
  • Resusable and Atomic Design Patterns are followed while development.
  • UI development, documentation and testing done presently using Storybook.
  • Module Bundler used for this project: rollup.js

Have a feature request? Let us know by opening an issue!

Usage

import * as React from 'react';
import ReactDOM from 'react-dom';
import {Button} from 'sodium-ui';

function App() {
  return <Button variant="primary">Hello World</Button>;
}

ReactDOM.render(<App />, document.querySelector('#app'));

Components available in Sodium-UI

Sodium-UI has all the components deployed on the Component Site that is essentially Storybook-build for developing and building React Components in isolation. If you are a user, or a developer or a tester; this site can be helpful for visualizing available components in Sodium-UI.

We love Contributions 💖

Sodium UI is truly Open Source. Any sort of contribution to this project are highly appreciated. Read the Contributing Guideline to learn more on how to setup development environment, propose bug fixes or improvements and how to build and test your changes to Sodium UI.

License

This project is licensed under the terms of the MIT license.