Skip to content

Latest commit

 

History

History
461 lines (302 loc) · 9.94 KB

README.md

File metadata and controls

461 lines (302 loc) · 9.94 KB

@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) Documentation Maintenance License: MIT Twitter: ThaddeusJiang

Features

  1. out of box utils of UIUX.
  2. beautiful default styling.
  3. without big external dependencies, like: @tanstack/table, Downshift and Tippy.js etc.

Install

yarn add @thaddeusjiang/omakase-ui

Components

Common

Button

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

Icon

Recommend heroicons v1 and sodaicons

sodaicons supports Highlight colorful icons, just like:

sodaicons-outline-icons

sodaicons-solid-icons.png

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

Typography

Layout

Divider

daisyUI

Grid

Layout

Space

Navigation

Affix

Breadcrumb

Dropdown

@radix-ui/react-dropdown-menu

Menu

daisyUI

PageHeader

Pagination

  • provide utils for pagination
<Pagination start={1} end={10} total={10015} currentPage={1} totalPage={101} onChangePage={onChangePage} />

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"

<input type="date" id="start" name="trip-start" value="2018-07-22" min="2018-01-01" max="2018-12-31" />

HTML input type="datetime-local"

<input
  type="datetime-local"
  id="meeting-time"
  name="meeting-time"
  value="2018-06-12T19:30"
  min="2018-06-07T00:00"
  max="2018-06-14T00:00"
/>

others

input type="month"

Form

Input

Don't need JS, learn HTML native input and input class.

html-input-types

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

examples

Slider

Switch

Don't need JS, learn daisyUI Toggle and daisyUI Swap. daisyUI is super cool, you should try it.

TimePicker

Don't need JS, learn

HTML input type="datetime-local"

```html ```

HTML input type="time"

<input type="time" id="appt" name="appt" min="09:00" max="18:00" required />

Transfer

🙅‍♂️ Never use this UI

TreeSelect

Upload

Data Display

Avatar

daisyUI Avatar

Badge

daisyUI 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

<div title="CoolTip">
  <p>Hovering here will show "CoolTip".</p>

  <p title="">Hovering here will show nothing.</p>
</div>
  • no JS (Must)
  • no CSS (Optional, don't over styling.) confirm you didn't make a bug tweet

Tree

Feedback

Alert

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

Drawer

Message

Recommend react-hot-toast

Modal

Recommend Radix Alert Dialog and Radix 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

Phone

daisyUI

Window

daisyUI

BTW, we recommend to not mock up Phone and Window. Welcome to try @omakase-ui/react-responsive-design-mode

Useful

LoadingIcon

ScreenLoading

SectionLoading

DataNotFound

Run tests

yarn run test

Develop

yarn storybook

Author

👤 Thaddeus Jiang

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Thaddeus Jiang.

This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator