usual-ui
v0.2.0
Published
react ui-components library
Downloads
7
Readme
✨Features
- Component-based architecture: Usual UI is built on React, leveraging its component-based approach for a modular and scalable design.
- TypeScript support: Components are written in TypeScript, ensuring type safety and enhancing developer experience with autocompletion and type checking.
- TailwindCSS integration: Utilizes TailwindCSS for rapid styling, allowing developers to easily customize the appearance of components.
💿Installation | Usage
To install Usual UI in` your project, you can use either npm or yarn.
Using npm:
npm install usual-ui
Using yarn:
yarn add usual-ui
After installation, you can import and use the components in your project.
import { Button, Text, Input, Box, Stack } from 'usual-ui';
// Use the components in your application
Additionally, you can use Tailwindcss styles by combining them with Usual-UI styles:
<Text variant="outline" className="text-amber-700">Lorem ipsum dolor sit amet, consectetur adipiscing elit</Text>
The Stack component allows you to arrange child components in a row or column, depending on the selected argument:
<Stack direction="row" gap="md" className="bg-gray-400">
<Box variant="outline">First</Box>
<Box variant="outline">Second</Box>
<Box variant="outline">Third</Box>
</Stack>
In this library I have added 4 types of buttons, you can change the style of the button using the "variant" attribute:
<Button variant="solid">Solid</Button>
<Button variant="outline">Outline</Button>
<Button variant="ghost">Ghost</Button>
<Button variant="underline">Underline</Button>
📚Components
- <Button>: A customizable button component | attrs. = variant, size, weight
- <Text>: A component for displaying text with various styles | attrs. = variant, size, weight, emphasis, align, italic, underline
- <Input>: A flexible input component that supports various types and customization |
- <Box>: A layout component that can be used to create flexible layouts | attrs. = variant, size, align
- <Stack>: A component for stacking elements vertically or horizontally | attrs. = direction, gap
🛠️Tools Used
- React: A JavaScript library for building user interfaces.
- Vite: A build tool that aims to provide a faster and leaner development experience for modern web projects.
- Vitest: A testing framework for Vite projects, offering a fast and efficient way to test components.
- React Testing Library: A lightweight solution for testing React components, encouraging best practices.
- TailwindCSS: A utility-first CSS framework for rapidly building custom designs.
- Storybook: An open-source tool for developing UI components in isolation.
©️ License
Usual-UI is open-source software licensed under the MIT License.