AkatsukiUI is a dynamic UI component library for React that allows customization according to customer needs.
You can install the library using npm:
npm install akatsuki-ui
Or using yarn:
yarn add akatsuki-ui
Import the desired components into your project and start using them:
import React from 'react';
import { Button } from 'akatsuki-ui';
const App = () => (
<div>
<Button primary label="Click Me" />
</div>
);
export default App;
A basic button component with different styles. Props:
-
primary
(boolean): If true, applies the primary style. -
backgroundColor
(string): Sets the background color of the button. -
size
(string): Size of the button. Options aresmall
,medium
,large
. -
label
(string): The text label of the button. -
onClick
(function): Click event handler. Example:
<Button primary label="Primary Button" onClick={() => alert('Clicked!')} />
- Menu: A Menu component.
For a full list of components and their usage, please refer to the documentation.
You can customize the components using CSS or styled-components. Here's an example of customizing the Button component:
import styled from 'styled-components';
import { Button } from 'akatsuki-ui';
const CustomButton = styled(Button)`
background-color: #ff0000;
border-radius: 10px;
`;
const App = () => (
<div>
<CustomButton label="Custom Button" />
</div>
);
export default App;
We welcome contributions from the community! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-branch
). - Open a pull request.
© 2024 AkatsukiUI. All rights reserved.