unovue / shadcn-vue

Vue port of shadcn-ui
https://www.shadcn-vue.com/
MIT License
5.32k stars 318 forks source link

[Feature]: Sidebar needs more documentation and a code example #881

Open Soviut opened 2 weeks ago

Soviut commented 2 weeks ago

Describe the feature

Currently, the Sidebar example only has a preview but no code or usage examples. The sidebar has dozens of components which aren't clear on how they should be assembled.

For example, a <SidebarProvider> is needed to wrap the entire component, <SidebarContent> is for the content beside the sidebar as opposed to inside the it, etc. All of these things should be documented but even just showing the code for the example would clarify most of it.

I would happily create a PR that updates the docs if I could figure out how the component previews are generated.

Additional information

Harryalways317 commented 2 weeks ago

This is a needed one. I've been referring to Shadcn UI React documentation to set up the sidebar in Vue, I can chip in too if needed

brokuka commented 1 week ago

Originally doc is here, you can use as your own. Waiting for vue docs.