Skip to content

Integrate with nuqs shadcn registry #3

@iHiteshAgrawal

Description

@iHiteshAgrawal

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

  1. Study the nuqs registry structure:

  2. 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
  3. Test locally:

    • Set up nuqs docs locally
    • Test each hook installation
    • Verify customization scenarios
  4. Proceed with release steps [TBD]

Resources

Additional Notes:

This integration was suggested by @fortysevenfx (nuqs creator) and would significantly increase adoption and visibility of nuqs-presets.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions