Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 of 2 tasks
Soviut opened this issue Nov 10, 2024 · 1 comment
Open
1 of 2 tasks

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

Soviut opened this issue Nov 10, 2024 · 1 comment

Comments

@Soviut
Copy link

Soviut commented Nov 10, 2024

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

  • I intend to submit a PR for this feature.
  • I have already implemented and/or tested this feature.
@Harryalways317
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants