https://github.com/sohamsshah/sodium-ui

Sodium is a simple, modular and customizable web component library to build elegant and accessible UI pieces for your React Application.
https://github.com/sohamsshah/sodium-ui

component-library design-system react reactjs storybook ui-components ui-library uikit web-components

Last synced: 3 months ago
JSON representation

Sodium is a simple, modular and customizable web component library to build elegant and accessible UI pieces for your React Application.

• Host: GitHub
• URL: https://github.com/sohamsshah/sodium-ui
• Owner: sohamsshah
• License: mit
• Created: 2021-03-14T09:31:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-30T05:00:16.000Z (over 3 years ago)
• Last Synced: 2024-04-26T03:01:09.206Z (9 months ago)
• Topics: component-library, design-system, react, reactjs, storybook, ui-components, ui-library, uikit, web-components
• Language: JavaScript
• Homepage: https://sohamsshah.github.io/sodium-ui
• Size: 2.54 MB
• Stars: 23
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


Sodium UI




Swiftly develop elegant [React](https://reactjs.org/) 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](https://www.npmjs.com/package/sodium-ui).

```sh

// 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](https://storybook.js.org/). 

* Module Bundler used for this project: [rollup.js](https://rollupjs.org/) 

Have a feature request? Let us know by opening an [issue](https://github.com/sohamsshah/sodium-ui/issues)!

## **Usage** 

```jsx

import * as React from 'react';

import ReactDOM from 'react-dom';

import {Button} from 'sodium-ui';

function App() {

  return Hello World;

}

ReactDOM.render(, document.querySelector('#app'));

```

## Components available in Sodium-UI

Sodium-UI has all the components deployed on the [Component Site](https://sohamsshah.github.io/sodium-ui/) 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](/CONTRIBUTING.md) 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](/LICENSE).