p-sw/pswui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
p-sw 2024-05-15 23:40:27 +09:00
parent 75fb0b57f7
commit e1efe9556a
1 changed files with 65 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
README.md
View File

@ -6,62 +6,71 @@ My goal is to create **fully typesafe**, **highly customizable** component with
## Rules of PSW-UI Development ## Rules of PSW-UI Development
* Only use **React** or **Svelte**, **TailwindCSS**, **tailwind-merge**, **clsx**, **class-variance-authority** for runtime dependency. - **Minimum complexity**. Miminum shared utility & runtime dependency.
* **Simplicity** over **Versatility**. Make it easy to edit, so user can easily add or patch their own code to the component. - **Simplicity** over **Versatility**. Make it easy to edit, so user can easily add or patch their own code to the component.
* **Hate script.** If you can do that with CSS, just do that with CSS. Why use JS? - **Hate script.** If you can do that with CSS, just do that with CSS. Why use JS?
* **Stick with the defaults.** Just let others do their customization. And, well, TailwindCSS's default theme is pretty cool. - **Stick with the defaults.** Just let others do their customization. And, well, TailwindCSS's default theme is pretty cool.
* **Keep component isolated.** Leave them alone. Don't make one dependent to others. - **Keep component isolated.** Leave them alone. Don't make one dependent to others.
## Milestones ## Milestones
* Component Implementation - Component Implementation
* [ ] Accordion - [ ] Accordion
* [ ] Alert - [ ] Alert
* [ ] Avatar - [ ] Avatar
* [ ] Badge - [ ] Badge
* [ ] Breadcrumb - [ ] Breadcrumb
* [ ] Button - [ ] Button
* [ ] Calendar - [ ] Calendar
* [ ] Card - [ ] Card
* [ ] Carousel - [ ] Carousel
* [ ] Checkbox - [ ] Checkbox
* [ ] Combobox - [ ] Combobox
* [ ] Command - [ ] Command
* [ ] Context Menu - [ ] Context Menu
* [ ] Data Table - [ ] Data Table
* [ ] Date Picker - [ ] Date Picker
* [ ] Dialog - [ ] Dialog
* [ ] Drawer - [ ] Drawer
* [ ] Dropdown Menu - [ ] Dropdown Menu
* [ ] Form - [ ] Form
* [ ] Hover Card - [ ] Hover Card
* [ ] Input - [ ] Input
* [ ] Input OTP - [ ] Input OTP
* [ ] Label - [ ] Label
* [ ] Menubar - [ ] Menubar
* [ ] Navigation Menu - [ ] Navigation Menu
* [ ] Pagination - [ ] Pagination
* [ ] Popover - [ ] Popover
* [ ] Progress - [ ] Progress
* [ ] Radio Group - [ ] Radio Group
* [ ] Resizable - [ ] Resizable
* [ ] Scroll Area - [ ] Scroll Area
* [ ] Select - [ ] Select
* [ ] Separator - [ ] Separator
* [ ] Sheet - [ ] Sheet
* [ ] Skeleton - [ ] Skeleton
* [ ] Slider - [ ] Slider
* [ ] Sonner - [ ] Sonner
* [ ] Switch - [ ] Switch
* [ ] Table - [ ] Table
* [ ] Tabs - [ ] Tabs
* [ ] Textarea - [ ] Textarea
* [ ] Toast - [ ] Toast
* [ ] Toggle - [ ] Toggle
* [ ] Toggle Group - [ ] Toggle Group
* [ ] Tooltip - [ ] Tooltip
* Library/Framework Support - Library/Framework Support
* [ ] React - [ ] React
* [ ] Svelte - [ ] Svelte
* CLI - _I'm not sure about this._ - CLI - _I'm not sure about this._
* [ ] Add - [ ] Add
## Building local development environment
```bash
# Corepack - Yarn 4.2.2
corepack enable
corepack install yarn@4.2.2
corepack use yarn@4.2.2
```