-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Overview
Integrate nuqs-presets hooks into the shadcn registry to make them easily accessible and customizable for users.
Benefits
- Discoverability: Users browsing nuqs docs will find these presets
- Customization: Users can tweak implementations for their needs (custom URL rendering, etc.)
- Easier adoption: CLI installation instead of npm package
Questions to Resolve
- Should registry versions be simplified or match npm package exactly?
- How to handle shared utilities/types across hooks?
- Do we maintain both npm package AND registry, or transition fully?
- What's the best way to keep both in sync?
Implementation Steps
-
Study the nuqs registry structure:
- Review existing registry items: https://github.com/47ng/nuqs/tree/next/packages/docs/src/registry/items
- Understand the format and requirements
-
Adapt hooks for registry:
- Create registry-compatible versions of each hook
- Add proper metadata (name, description, dependencies)
- Ensure they work standalone when installed via CLI
-
Test locally:
- Set up nuqs docs locally
- Test each hook installation
- Verify customization scenarios
-
Proceed with release steps [TBD]
Resources
- nuqs registry items: https://github.com/47ng/nuqs/tree/next/packages/docs/src/registry/items
- shadcn CLI docs: https://ui.shadcn.com/docs/cli
Additional Notes:
This integration was suggested by @fortysevenfx (nuqs creator) and would significantly increase adoption and visibility of nuqs-presets.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request