An open API service indexing awesome lists of open source software.

https://github.com/thaddeusjiang/omakase-ui

refined UI components using daisyUI and Conform
https://github.com/thaddeusjiang/omakase-ui

components-library daisy-ui react-js remix-run tailwind-css

Last synced: 12 months ago
JSON representation

refined UI components using daisyUI and Conform

Awesome Lists containing this project

README

          

# @thaddeusjiang/omakase-ui 👋

> - Maybe you shouldn't use this library, just use tailwindcss and HTML is enough.
> - You don't need to use this library if you have lots of time to code and want to build the unique UI.

[![npm (scoped)](https://img.shields.io/npm/v/@thaddeusjiang/omakase-ui?style=for-the-badge)](https://www.npmjs.com/package/@thaddeusjiang/omakase-ui)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/ThaddeusJiang/omakase-ui#readme)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ThaddeusJiang/omakase-ui/graphs/commit-activity)
[![License: MIT](https://img.shields.io/github/license/ThaddeusJiang/omakase-ui)](https://github.com/ThaddeusJiang/omakase-ui/blob/main/LICENSE)
[![Twitter: ThaddeusJiang](https://img.shields.io/twitter/follow/ThaddeusJiang.svg?style=social)](https://twitter.com/ThaddeusJiang)

## Features

1. out of box utils of UIUX.
2. beautiful default styling.
3. without big external dependencies, like: [@tanstack/table](https://github.com/tanstack/table), [Downshift](https://github.com/downshift-js/downshift) and [Tippy.js](https://github.com/atomiks/tippyjs) etc.

## 🏠 [Homepage](https://github.com/ThaddeusJiang/omakase-ui#readme)

## Install

```sh
yarn add @thaddeusjiang/omakase-ui
```

# Components

- [@thaddeusjiang/omakase-ui 👋](#thaddeusjiangomakase-ui-)
- [Features](#features)
- [🏠 Homepage](#-homepage)
- [Install](#install)
- [Components](#components)
- [Common](#common)
- [Button](#button)
- [Icon](#icon)
- [Typography](#typography)
- [Layout](#layout)
- [Divider](#divider)
- [Grid](#grid)
- [Layout](#layout-1)
- [Space](#space)
- [Navigation](#navigation)
- [Affix](#affix)
- [Breadcrumb](#breadcrumb)
- [Dropdown](#dropdown)
- [Menu](#menu)
- [PageHeader](#pageheader)
- [Pagination](#pagination)
- [Steps](#steps)
- [Data Entry](#data-entry)
- [AutoComplete](#autocomplete)
- [~~Cascader~~](#cascader)
- [Checkbox](#checkbox)
- [DatePicker](#datepicker)
- [Form](#form)
- [Input](#input)
- [InputNumber](#inputnumber)
- [Mentions](#mentions)
- [Radio](#radio)
- [Rate](#rate)
- [Select](#select)
- [Slider](#slider)
- [Switch](#switch)
- [TimePicker](#timepicker)
- [~~Transfer~~](#transfer)
- [TreeSelect](#treeselect)
- [Upload](#upload)
- [Data Display](#data-display)
- [Avatar](#avatar)
- [Badge](#badge)
- [Calendar](#calendar)
- [Card](#card)
- [Carousel](#carousel)
- [Collapse](#collapse)
- [Comment](#comment)
- [Descriptions](#descriptions)
- [Empty](#empty)
- [Image](#image)
- [List](#list)
- [Popover](#popover)
- [Segmented](#segmented)
- [Statistic](#statistic)
- [Table](#table)
- [Tabs](#tabs)
- [Tag](#tag)
- [Timeline](#timeline)
- [Tooltip](#tooltip)
- [Tree](#tree)
- [Feedback](#feedback)
- [Alert](#alert)
- [Drawer](#drawer)
- [Message](#message)
- [Modal](#modal)
- [Notification](#notification)
- [Popconfirm](#popconfirm)
- [Progress](#progress)
- [Result](#result)
- [Skeleton](#skeleton)
- [Spin](#spin)
- [Other](#other)
- [Anchor](#anchor)
- [BackTop](#backtop)
- [ConfigProvider](#configprovider)
- [Mockup](#mockup)
- [Code](#code)
- [Phone](#phone)
- [Window](#window)
- [Useful](#useful)
- [LoadingIcon](#loadingicon)
- [ScreenLoading](#screenloading)
- [SectionLoading](#sectionloading)
- [DataNotFound](#datanotfound)
- [Run tests](#run-tests)
- [Develop](#develop)
- [Author](#author)
- [🤝 Contributing](#-contributing)
- [Show your support](#show-your-support)
- [📝 License](#-license)

## Common

### Button

Don't need JS, learn https://daisyui.com/components/button/

### Icon

Recommend [heroicons v1](https://heroicons.com/) and [sodaicons](https://github.com/ThaddeusJiang/sodaicons)

> sodaicons supports Highlight colorful icons, just like:

![sodaicons-outline-icons](./docs/assets/sodaicons-outline-icons.png)

![sodaicons-solid-icons.png](./docs/assets/sodaicons-solid-icons.png)

> We recommend make all icons as button, apply :hover, :focus and other styles.

### Typography

## Layout

### Divider

[daisyUI](https://daisyui.com/components/divider/)

- [ ] left and right align
- [ ] [divider-solid divider-dotted divider-dashed divider-double](https://github.com/saadeghi/daisyui/issues/1163)

### Grid

### Layout

### Space

## Navigation

### Affix

### Breadcrumb

### Dropdown

[@radix-ui/react-dropdown-menu](https://www.radix-ui.com/docs/primitives/components/dropdown-menu)

### Menu

[daisyUI](https://daisyui.com/components/menu/)

### PageHeader

### Pagination

- [ ] provide utils for pagination

```jsx

```

### Steps

## Data Entry

### AutoComplete

### ~~Cascader~~

🙅‍♂️ Don't use this UI.

### Checkbox

Don't need JS, learn https://daisyui.com/components/checkbox/

### DatePicker

Don't need JS, learn [HTML input type="date" ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date)

```html

```

[HTML input type="datetime-local"](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local)

```html

```

others

input type="month"

### Form

### Input

Don't need JS, learn [HTML native input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) and [input class](https://daisyui.com/components/input/).

![html-input-types](./docs/assets/html-input-types.png)

### InputNumber

### Mentions

### Radio

Don't need JS, learn https://daisyui.com/components/radio/

### Rate

### Select

Simple select don't need JS, learn https://daisyui.com/components/select/.

Complex select and combobox recommend to use [react-select](https://github.com/jedwatson/react-select)

[examples](./stories/Select.stories.tsx)

### Slider

### Switch

Don't need JS, learn [daisyUI Toggle](https://daisyui.com/components/toggle/) and [daisyUI Swap](https://daisyui.com/components/swap/).
daisyUI is super cool, you should try it.

### TimePicker

Don't need JS, learn

[HTML input type="datetime-local"](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local)

```html

```

[HTML input type="time"](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time)

```html

```

### ~~Transfer~~

🙅‍♂️ Never use this UI

### TreeSelect

### Upload

## Data Display

### Avatar

[daisyUI Avatar](https://daisyui.com/components/avatar/)

### Badge

[daisyUI Badge](https://daisyui.com/components/badge/)

### Calendar

### Card

### Carousel

### Collapse

### Comment

### Descriptions

### Empty

### Image

### List

### Popover

### Segmented

### Statistic

### Table

### Tabs

### Tag

### Timeline

### Tooltip

Don't need JS, we recommend [HTML tooltip](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title)

```html


Hovering here will show "CoolTip".

Hovering here will show nothing.



```

- no JS (Must)
- no CSS (Optional, don't over styling.) confirm you didn't make a bug [tweet](https://twitter.com/ThaddeusJiang/status/1460773968063787014)

### Tree

## Feedback

### Alert

https://daisyui.com/components/alert/

### Drawer

### Message

Recommend [react-hot-toast](https://github.com/timolins/react-hot-toast)

### Modal

Recommend [Radix Alert Dialog](https://www.radix-ui.com/docs/primitives/components/alert-dialog) and [Radix Dialog](https://www.radix-ui.com/docs/primitives/components/dialog)

> Why:
> We love self control dialog component, we don't want to write a lot of State for `isOpen` and `setIsOpen`

> Why we don't use daisyUI Modal?
> We need accessibility.

KnowHow

- `Radix Alert Dialog` for confirm
- `Radix Dialog` for asynchronous form submission

### Notification

### Popconfirm

### Progress

### Result

### Skeleton

### Spin

## Other

### Anchor

### BackTop

### ConfigProvider

## Mockup

### Code

[daisyUI](https://daisyui.com/components/mockup-code/)

### Phone

[daisyUI](https://daisyui.com/components/mockup-phone/)

### Window

[daisyUI](https://daisyui.com/components/mockup-window/)

BTW, we recommend to not mock up Phone and Window.
Welcome to try [@omakase-ui/react-responsive-design-mode](https://www.npmjs.com/package/@omakase-ui/react-responsive-design-mode)

## Useful

### LoadingIcon

### ScreenLoading

### SectionLoading

### DataNotFound

# Run tests

```sh
yarn run test
```

# Develop

```sh
yarn storybook
```

# Author

👤 **Thaddeus Jiang**

- Website: https://thaddeusjiang.com/
- Twitter: [@ThaddeusJiang](https://twitter.com/ThaddeusJiang)
- Github: [@ThaddeusJiang](https://github.com/ThaddeusJiang)

# 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/ThaddeusJiang/omakase-ui/issues). You can also take a look at the [contributing guide](https://github.com/ThaddeusJiang/omakase-ui/blob/main/CONTRIBUTING.md).

# Show your support

Give a ⭐️ if this project helped you!

# 📝 License

Copyright © 2022 [Thaddeus Jiang](https://github.com/ThaddeusJiang).

This project is [MIT](https://github.com/ThaddeusJiang/omakase-ui/blob/main/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_