https://github.com/softconstruct/gene-ui-components
The Gene UI components library designed for BI tools
https://github.com/softconstruct/gene-ui-components
component-library design-system geneui react
Last synced: 2 days ago
JSON representation
The Gene UI components library designed for BI tools
- Host: GitHub
- URL: https://github.com/softconstruct/gene-ui-components
- Owner: softconstruct
- License: mit
- Created: 2023-11-08T07:18:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-06T12:07:51.000Z (2 days ago)
- Last Synced: 2025-05-06T14:15:57.743Z (2 days ago)
- Topics: component-library, design-system, geneui, react
- Language: JavaScript
- Homepage: https://geneui-storybook.softconstruct.com
- Size: 6.79 MB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Gene UI components
> The design system to democratize a UI unification process of BI tools.
[](https://www.npmjs.com/package/@geneui/components)
[](https://github.com/softconstruct/gene-ui-components/blob/main/LICENSE)
## Table of Contents
- [Installation](#-installation)
- [Usage](#-usage)
- [Importing Components](#importing-components)
- [Example](#example)
- [Documentation](#-documentation)
- [API Reference](#api-reference)
- [Contributing](#-contributing)
- [Changelog](#-changelog)
- [License](#%EF%B8%8F-license)
## ⚙️ Installation
You can install Gene UI components using npm or yarn:
```bash
# Yarn
yarn add @geneui/components
# NPM
npm install --save @geneui/components
```
## 👀 Usage
### Importing Components
To use a component in your project, first you need to import the provider in your main component e.g. in the App.js file
```js
import GeneUIProvider from '@geneui/components/GeneUIProvider';
```
Then you need to wrap your main component with provider
```js
```
### Example
Now you can start use any components available in the package
```js
import { Button } from '@geneui/components';
function App() {
return (
Do action
);
}
```
## 📝 Documentation
Explore in-depth documentation to make the most out of Gene UI components.
### API Reference
Visit our [API Reference](https://geneui.softconstruct.com/) for detailed information on each component, including props
and usage examples.
## 👍 Contributing
We welcome contributions from the community! Here's how you can get involved:
> 👉 See the [contributing docs](https://github.com/softconstruct/gene-ui-components/blob/main/CONTRIBUTING.md) for more
> info on code style, testing, coverage, and troubleshooting.
## 📜 Changelog
Stay up-to-date with the latest changes and improvements by checking our
[Changelog](https://github.com/softconstruct/gene-ui-components/blob/main/CHANGELOG.md).
## ⚖️ License
The Gene UI design system is licensed under the
[MIT License](https://github.com/softconstruct/gene-ui-components/blob/main/LICENSE)