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
* Only use **React** or **Svelte**, **TailwindCSS**, **tailwind-merge**, **clsx**, **class-variance-authority** for runtime dependency.
* **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?
* **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.
- **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.
- **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.
- **Keep component isolated.** Leave them alone. Don't make one dependent to others.
## Milestones
* Component Implementation
* [ ] Accordion
* [ ] Alert
* [ ] Avatar
* [ ] Badge
* [ ] Breadcrumb
* [ ] Button
* [ ] Calendar
* [ ] Card
* [ ] Carousel
* [ ] Checkbox
* [ ] Combobox
* [ ] Command
* [ ] Context Menu
* [ ] Data Table
* [ ] Date Picker
* [ ] Dialog
* [ ] Drawer
* [ ] Dropdown Menu
* [ ] Form
* [ ] Hover Card
* [ ] Input
* [ ] Input OTP
* [ ] Label
* [ ] Menubar
* [ ] Navigation Menu
* [ ] Pagination
* [ ] Popover
* [ ] Progress
* [ ] Radio Group
* [ ] Resizable
* [ ] Scroll Area
* [ ] Select
* [ ] Separator
* [ ] Sheet
* [ ] Skeleton
* [ ] Slider
* [ ] Sonner
* [ ] Switch
* [ ] Table
* [ ] Tabs
* [ ] Textarea
* [ ] Toast
* [ ] Toggle
* [ ] Toggle Group
* [ ] Tooltip
* Library/Framework Support
* [ ] React
* [ ] Svelte
* CLI - _I'm not sure about this._
* [ ] Add
- Component Implementation
- [ ] Accordion
- [ ] Alert
- [ ] Avatar
- [ ] Badge
- [ ] Breadcrumb
- [ ] Button
- [ ] Calendar
- [ ] Card
- [ ] Carousel
- [ ] Checkbox
- [ ] Combobox
- [ ] Command
- [ ] Context Menu
- [ ] Data Table
- [ ] Date Picker
- [ ] Dialog
- [ ] Drawer
- [ ] Dropdown Menu
- [ ] Form
- [ ] Hover Card
- [ ] Input
- [ ] Input OTP
- [ ] Label
- [ ] Menubar
- [ ] Navigation Menu
- [ ] Pagination
- [ ] Popover
- [ ] Progress
- [ ] Radio Group
- [ ] Resizable
- [ ] Scroll Area
- [ ] Select
- [ ] Separator
- [ ] Sheet
- [ ] Skeleton
- [ ] Slider
- [ ] Sonner
- [ ] Switch
- [ ] Table
- [ ] Tabs
- [ ] Textarea
- [ ] Toast
- [ ] Toggle
- [ ] Toggle Group
- [ ] Tooltip
- Library/Framework Support
- [ ] React
- [ ] Svelte
- CLI - _I'm not sure about this._
- [ ] 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
```