@geneui/components
v2.16.2
Published
The Gene UI components library designed for BI tools
Downloads
953
Maintainers
Readme
Gene UI components
The design system to democratize a UI unification process of BI tools.
Table of Contents
⚙️ Installation
You can install Gene UI components using npm or yarn:
# 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
import GeneUIProvider from '@geneui/components/GeneUIProvider';
Then you need to wrap your main component with provider
<GeneUIProvider>
<App />
</GeneUIProvider>
Example
Now you can start use any components available in the package
import { Button } from '@geneui/components';
function App() {
return (
<div>
<Button>Do action</Button>
</div>
);
}
📝 Documentation
Explore in-depth documentation to make the most out of Gene UI components.
API Reference
Visit our API Reference 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 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.
⚖️ License
The Gene UI design system is licensed under the MIT License