Skip to content

Commit aabdcc1

Browse files
honghuangdchonghuangdc
committed
docs(README): update installation instructions and remove component roadmap
1 parent 390d069 commit aabdcc1

File tree

1 file changed

+4
-138
lines changed

1 file changed

+4
-138
lines changed

‎headless/README.md‎

Lines changed: 4 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -2,142 +2,8 @@
22

33
SoybeanHeadless is a collection unstyled components for Vue 3. It is designed to be lightweight and easy to use.
44

5-
## Roadmap
5+
## Installation
66

7-
### Components
8-
9-
✅: Completed ✨: Implemented
10-
11-
✅ 46 / total: 107
12-
13-
| No | Priority | Name | Status | Alias | 📝 Note |
14-
| --- | -------- | --------------- | ------------ | -------------------- | ------------------------ |
15-
| 1 | 1 | Accordion | ✅ Completed | | |
16-
| 2 | 1 | Alert | ✅ Completed | | |
17-
| 3 | 1 | AlertDialog | ✅ Completed | | |
18-
| 4 | 1 | Arrow | ✅ Completed | | |
19-
| 5 | 1 | AspectRatio | ✅ Completed | | |
20-
| 6 | 1 | Avatar | ✅ Completed | | |
21-
| 7 | 1 | Badge | ✅ Completed | Chip | |
22-
| 8 | 1 | Breadcrumb | ✅ Completed | | |
23-
| 9 | 1 | Button | ✅ Completed | | ✨ support loading |
24-
| 10 | 1 | Card | ✅ Completed | | |
25-
| 11 | 1 | Checkbox | ✅ Completed | | ✨ support checkbox card |
26-
| 12 | 1 | Collapsible | ✅ Completed | | |
27-
| 13 | 1 | Command | ✅ Completed | | |
28-
| 14 | 1 | ConfigProvider | ✅ Completed | | |
29-
| 15 | 1 | ContextMenu | ✅ Completed | | |
30-
| 16 | 1 | Dialog | ✅ Completed | | |
31-
| 17 | 1 | Drawer | ✅ Completed | Sheet | |
32-
| 18 | 1 | DropdownMenu | ✅ Completed | | ✨ support hover trigger |
33-
| 19 | 1 | Form | ✅ Completed | | |
34-
| 20 | 1 | Icon | ✅ Completed | | ✨ based on iconify |
35-
| 21 | 1 | Input | ✅ Completed | | |
36-
| 22 | 1 | Kbd | ✅ Completed | | |
37-
| 23 | 1 | Label | ✅ Completed | | |
38-
| 24 | 1 | Layout | ✅ Completed | | |
39-
| 25 | 1 | Link | ✅ Completed | | |
40-
| 26 | 1 | List | ✅ Completed | | |
41-
| 27 | 1 | Listbox | ✅ Completed | | |
42-
| 28 | 1 | Menu | ✅ Completed | | |
43-
| 29 | 1 | NavigationMenu | ✅ Completed | | |
44-
| 30 | 1 | NumberInput | ✅ Completed | NumberField | |
45-
| 31 | 1 | Pagination | ✅ Completed | | |
46-
| 32 | 1 | Password | ✅ Completed | | |
47-
| 33 | 1 | Popover | ✅ Completed | | |
48-
| 34 | 1 | RadioGroup | ✅ Completed | | ✨ support radio card |
49-
| 35 | 1 | Segment | ✅ Completed | | |
50-
| 36 | 1 | Select | ✅ Completed | | support virtualized |
51-
| 37 | 1 | Separator | ✅ Completed | Divider | |
52-
| 38 | 1 | Switch | ✅ Completed | | support switch card |
53-
| 39 | 1 | Tabs | ✅ Completed | | |
54-
| 40 | 1 | Tag | ✅ Completed | Badge(shadcn-ui) | |
55-
| 41 | 1 | Textarea | ✅ Completed | | support auto size |
56-
| 42 | 1 | Toast | | Sonner | |
57-
| 43 | 1 | Tooltip | ✅ Completed | | |
58-
| 44 | 1 | Tree | ✅ Completed | | ✨ support virtualized |
59-
| 45 | 1 | TreeMenu | ✅ Completed | | |
60-
| 46 | 1 | Virtualizer | ✅ Completed | | |
61-
| 47 | 1 | VisuallyHidden | ✅ Completed | | |
62-
| 48 | 2 | ColorPicker | | | |
63-
| 49 | 2 | Combobox | | | support virtualized |
64-
| 50 | 2 | DataTable | | | support virtualized |
65-
| 51 | 2 | Menubar | | | |
66-
| 52 | 2 | PinInput | | InputOPT, OPTInput | |
67-
| 53 | 2 | Popconfirm | | | |
68-
| 54 | 2 | Progress | | | include circle |
69-
| 55 | 2 | ScrollArea | | | |
70-
| 56 | 2 | Skeleton | | | |
71-
| 57 | 2 | Slider | | | |
72-
| 58 | 2 | Table | | | |
73-
| 59 | 2 | Toggle | | | |
74-
| 60 | 2 | ToggleGroup | | | |
75-
| 61 | 3 | BottomSheet | | Drawer(shadcn-ui) | |
76-
| 62 | 3 | Calendar | | | v-calendar |
77-
| 63 | 3 | Carousel | | | |
78-
| 64 | 3 | DateField | | | |
79-
| 65 | 3 | DatePicker | | | |
80-
| 66 | 3 | DateRangeField | | | |
81-
| 67 | 3 | DateRangePicker | | | |
82-
| 68 | 3 | Editable | | | |
83-
| 69 | 3 | HoverCard | | | |
84-
| 70 | 3 | RangeCalendar | | | v-calendar |
85-
| 71 | 3 | Resizable | | | |
86-
| 72 | 3 | Splitter | | | |
87-
| 73 | 3 | Stepper | | | |
88-
| 74 | 3 | TagsInput | | | |
89-
| 75 | 3 | TimeField | | | |
90-
| 76 | 3 | Timeline | | | ui things |
91-
| 77 | 3 | TimePicker | | | element-plus |
92-
| 78 | 3 | Toolbar | | | |
93-
| 79 | 4 | Affix | | | |
94-
| 80 | 4 | Anchor | | | |
95-
| 81 | 4 | AutoComplete | | | support virtualized |
96-
| 82 | 4 | Backtop | | | |
97-
| 83 | 4 | Cascader | | | support virtualized |
98-
| 84 | 4 | Clipboard | | | |
99-
| 85 | 4 | Code | | | |
100-
| 86 | 4 | Comment | | | |
101-
| 87 | 4 | Countdown | | | |
102-
| 88 | 4 | CurrencyInput | | | |
103-
| 89 | 4 | Descriptions | | | |
104-
| 90 | 4 | Ellipsis | | | |
105-
| 91 | 4 | Empty | | | |
106-
| 92 | 4 | Equation | | | based on katex |
107-
| 93 | 4 | InfiniteScroll | | | |
108-
| 94 | 4 | Mention | | | element-plus |
109-
| 95 | 4 | Navbar | | | |
110-
| 96 | 4 | NumberAnimation | | | naive-ui |
111-
| 97 | 4 | PageTab | | | |
112-
| 98 | 4 | QRCode | | | |
113-
| 99 | 4 | Rating | | Rate | element-plus |
114-
| 100 | 4 | Result | | | |
115-
| 101 | 4 | Spinner | | Loader, Spin | github ldrs |
116-
| 102 | 4 | Statistic | | | |
117-
| 103 | 4 | Tour | | | |
118-
| 104 | 4 | Transfer | | | |
119-
| 105 | 4 | TreeSelect | | | |
120-
| 106 | 4 | Typography | | | shadcn-ui |
121-
| 107 | 4 | Upload | | FileUpload, Dropfile | |
122-
| 108 | 4 | Watermark | | | |
123-
124-
### Utilities
125-
126-
✅ 10 / total: 14
127-
128-
| No. | Priority | Name | Status | 📝 Note |
129-
| --- | -------- | ------------------- | ------------ | -------------- |
130-
| 1 | 1 | Popper | ✅ Completed | |
131-
| 2 | 1 | Portal | ✅ Completed | alias Teleport |
132-
| 3 | 1 | Primitive | ✅ Completed | |
133-
| 4 | 1 | RovingFocus | ✅ Completed | |
134-
| 5 | 1 | Slot | ✅ Completed | |
135-
| 6 | 1 | useCollection | ✅ Completed | |
136-
| 7 | 1 | useDismissableLayer | ✅ Completed | |
137-
| 8 | 1 | useFocusGuards | ✅ Completed | |
138-
| 9 | 1 | useFocusScope | ✅ Completed | |
139-
| 10 | 1 | useMessage | | |
140-
| 11 | 1 | useModal | | |
141-
| 12 | 1 | useNotification | | |
142-
| 13 | 1 | usePresence | ✅ Completed | |
143-
| 14 | 2 | useLoadingBar | | |
7+
```bash
8+
pnpm add @soybeanjs/headless
9+
```

0 commit comments

Comments
 (0)