Decurl
  • English

    • API Overview

    API Overview

    The default @guanriyue/decurl entry provides React Router hooks. Additional API entries cover provided, codec, decode, routeSpec, and pagination.

    Entries

    EntryPurpose
    @guanriyue/decurlReady-to-use React Router hooks
    @guanriyue/decurl/providedUse hooks based on the Provider store and centralize React Router location / navigate access
    @guanriyue/decurl/codecFieldCodec, Search Fields, URLSearchParams codec
    @guanriyue/decurl/decodeDecode primitives and composition helpers
    @guanriyue/decurl/routeSpecDefine path and search contracts, then generate type-safe hrefs
    @guanriyue/decurl/paginationPage, pageSize, and pagination behavior
    1. Start with Getting Started.
    2. Read FieldCodec.
    3. Continue with Decode pipeline.
    4. Then read Search Fields.
    5. React Router users can continue with Integration Overview.

    Reference

    @guanriyue/decurl/codec

    @guanriyue/decurl/codec

    @guanriyue/decurl/decode

    @guanriyue/decurl/decode

    @guanriyue/decurl

    @guanriyue/decurl

    @guanriyue/decurl/routeSpec

    @guanriyue/decurl/routeSpec

    @guanriyue/decurl/pagination

    @guanriyue/decurl/pagination

    @guanriyue/decurl/provided

    @guanriyue/decurl/provided