English | 日本語

Yamada UI is a React UI component library that streamlines the development of cutting-edge web applications and websites. This library offers a diverse range of components that can be easily combined to construct complex user interfaces, incorporating various features such as color modes and animations, which are not typically supported by other React UI component libraries.

Contents

• Respect
• Documentation
• Features
• Installation
• Usage
• CodeSandbox
• Storybook
• Support
• Contributing
• License

Respect

Yamada UI has drawn a lot of inspiration from Chakra UI, MUI and Mantine UI. This has brought me wonderful experiences in my life. I am deeply grateful to Segun Adebayo and all the gods who have given me such experiences. And I love them.

Documentation

It's the https://yamada-ui.com website for the latest version of Yamada UI.

Features

• Ease of Styling: Yamada UI contains a set of layout components like Box and Stack that make it easy to style your components by passing props.
• Flexible & composable: Yamada UI components are built on top of a React UI Primitive for endless composability.
• Animation: Yamada UI provides hooks that allow for easy declaration of animations. These hooks can be written similar to CSS animations and are supported by all components.
• Color mode: Yamada UI makes it easy to set values for each color mode in the props of all components.
• Theme switching: Yamada UI allows users to switch themes. Users can adapt their own themes and use web applications and websites.
• Other features: Yamada UI comes with essential loading and notification features that are considered crucial for modern web applications and websites. This means you don't have to define them individually yourself.

Installation

To use Yamada UI components, all you need to install the @yamada-ui/react package.

1pnpm add @yamada-ui/react
2# or
3yarn add @yamada-ui/react
4# or
5npm install @yamada-ui/react
6# or
7bun add @yamada-ui/react

@yamada-ui/table and @yamada-ui/calendar, among others, are not included with @yamada-ui/react. You will need to install them separately.

1# Provide a convenient Table component using `@tanstack/react-table`.
2pnpm add @yamada-ui/table
3
4# Provide a convenient Calendar and datePicker, MonthPicker component
5pnpm add @yamada-ui/calendar
6
7# Provide a convenient Carousel component using `embla-carousel-react`.
8pnpm add @yamada-ui/carousel
9
10# Provide a convenient Dropzone component using `react-dropzone`.
11pnpm add @yamada-ui/dropzone
12
13# Provide a convenient Chart component using `recharts`.
14pnpm add @yamada-ui/charts
15
16# Provide a convenient Markdown component using `react-markdown` and `react-syntax-highlighter`.
17pnpm add @yamada-ui/markdown
18
19# Provide a convenient Icon component using `Lucide`.
20pnpm add @yamada-ui/lucide
21
22# a package for conveniently using `Font Awesome`.
23pnpm add @yamada-ui/fontawesome

Usage

To get started with using the components, please follow the steps below:

1. Wrap your application with the UIProvider provided

1import { UIProvider } from "@yamada-ui/react"
2
3const App = ({ children }) => {
4  return <UIProvider>{children}</UIProvider>
5}
6
7export default App

Yamada UI supports light and dark modes by default

2. Now you can start using components like so

1import { Box, Text } from "@yamada-ui/react"
2
3const Example = () => {
4  return (
5    <Box>
6      <Text>ギャルのパンティーおくれーーーっ！！！！！</Text>
7    </Box>
8  )
9}

CodeSandbox

• JavaScript
• TypeScript
• Next.js - Pages
• Next.js - App

Support

Please support this project with you or your organization. Your logo will appear here with a link to your website. We'll appreciate some support. [Contribute]

Organizations

Individuals

Contributing

Wouldn't you like to contribute? That's amazing! We have prepared a contribution guide to assist you.

If you're interested in contributing to the documentation, please refer to this contribution guide.

License

MIT © Hirotomo Yamada