Skip to content

Commit e9a8612

Browse files
author
Kamell Perry
committed
[core]: added wiki dir + link in readme
1 parent 021f030 commit e9a8612

File tree

2 files changed

+167
-0
lines changed

2 files changed

+167
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
<a href="https://github.com/svelteuidev/svelteui/issues">Report Bug</a>
2323
·
2424
<a href="https://github.com/svelteuidev/svelteui/issues">Request Feature</a>
25+
·
26+
<a href="https://github.com/svelteuidev/svelteui/wiki/Roadmap">Read Roadmap</a>
2527
</p>
2628
</div>
2729

wiki/Roadmap.md

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<div id="top" />
2+
# The SvelteUI Roadmap (3 months)
3+
4+
This is the first iteration of a roadmap, so it will only go out for 3 months as of now. This is where we establish topics we want to work on. To make the roadmap even better, we would love to hear from you in issues, discussions, and the dicord.
5+
6+
When we follow our roadmap, we continue to learn, and our opinions on some of the topics listed change. As a result, we may add or remove topics as the project progresses.
7+
8+
We will actively listen to your feedback and adapt our plans if needed.
9+
10+
Legend of annotations:
11+
12+
| Mark | Description |
13+
| ------------ | ------------------ |
14+
| bullet | work not started |
15+
| check mark | work completed |
16+
| :runner: | in progress work |
17+
| :muscle: | stretch goal |
18+
| :red_circle: | somethings missing |
19+
20+
### Summary
21+
22+
> Stuff will be written here later
23+
24+
## SvelteUI Core
25+
26+
### Components
27+
28+
**v0.6.0**
29+
30+
- [x] Button
31+
- [x] Code
32+
- [x] Loader
33+
- [x] Switch
34+
- [x] Image
35+
- [x] Text
36+
- [x] Title
37+
- [x] Stack
38+
- [x] Badge
39+
- [x] Box
40+
- [x] ActionIcon
41+
- [x] Center
42+
- [x] Fragment
43+
- [x] Group
44+
- [x] Input
45+
- [x] InputWrapper
46+
- [x] NativeSelect
47+
- [x] Space
48+
- [x] Stack
49+
- [x] ThemeIcon
50+
- [ ] Overlay
51+
- [ ] CheckBox
52+
- [ ] SimpleGrid
53+
- [ ] ScrollArea
54+
55+
**v0.6.5**
56+
57+
- [ ] Popper
58+
- [ ] Divider
59+
- [ ] Portal
60+
- [ ] Slider
61+
- [ ] ToolTip
62+
- [ ] Card
63+
- [ ] Modal
64+
- [ ] Grid
65+
- [ ] Skeleton
66+
- [ ] Seo
67+
- [ ] ARIA
68+
69+
### Internals
70+
71+
- [ ] :runner: Transition forwarding
72+
- [ ] Even cooler error UI
73+
74+
### Styling
75+
76+
- [ ] Stitches configuration through `<SvelteUIProvider />`
77+
78+
<a href="#top">back to top</a>
79+
80+
<hr />
81+
82+
## SvelteUI Actions
83+
84+
### Actions
85+
86+
- [x] use-click-outside
87+
- [x] use-clipboard
88+
- [x] use-css-variable
89+
- [x] use-focus
90+
- [x] use-download
91+
- [x] use-page-leave
92+
- [x] use-tab-leave
93+
- [x] use-lazy
94+
- [x] use-long-press
95+
- [x] use-persistent-tab
96+
- [ ] use-hot-key
97+
98+
<a href="#top">back to top</a>
99+
100+
<hr />
101+
102+
## SvelteUI Utilities
103+
104+
### Utilities
105+
106+
- [x] os - detect a user's os.
107+
- [x] rafFn - call function on every `requestAnimationFrame`, with controls of pausing and resuming.
108+
- [x] hash - generate a random hash with a specified prefix.
109+
- [ ] uuid - :runner: generate a random id with validation
110+
111+
### Internals
112+
113+
- [ ] Utilize type guards
114+
115+
<a href="#top">back to top</a>
116+
117+
<hr />
118+
119+
## SvelteUI Motion
120+
121+
### Transitions
122+
123+
- [ ] Typewriter - displays text with a typed effect
124+
- [ ] Flipboard - displays text with a glitch like effect
125+
126+
### Animations
127+
128+
- [ ] Animation Component with predefined animations
129+
130+
<a href="#top">back to top</a>
131+
132+
<hr />
133+
134+
## SvelteUI Prism
135+
136+
### Prism
137+
138+
- [ ] Get Prism component to standard
139+
140+
- [ ] working copy button
141+
- [ ] line numbers resize correctly
142+
- [ ] full line highlighting configuration
143+
- [ ] ScrollArea component integration
144+
145+
- [ ] Prism Tabs
146+
- [ ] Custom color theming
147+
148+
### Internals
149+
150+
- [ ] Utilize config for cleaner abstraction and more customization
151+
152+
<a href="#top">back to top</a>
153+
154+
<hr />
155+
156+
## SvelteUI Dates :muscle:
157+
158+
### Core
159+
160+
- [ ] Create Month component
161+
- [ ] Create necessary utils
162+
163+
### Utilities
164+
165+
- [ ] create the date utils needed for the library

0 commit comments

Comments
 (0)