- Name
service- Kind
- parameter
- Type
PaginationService- Requirement
- required
DocsAPI referenceHeadlesspagination
pagination headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
@grassroot/ui-headless-core/pagination
Core connector and vanilla API
connectPagination
functiondeclare function connectPagination(service: PaginationService, scope: PartScope, options?: PaginationConnectOptions): PaginationApi;servicePaginationServicescopePartScopeoptionsPaginationConnectOptionsreturnPaginationApi- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
PaginationConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
PaginationApi- Requirement
- n/a
mountPagination
functiondeclare function mountPagination(container: HTMLElement, options: MountPaginationOptions): PaginationMount;containerHTMLElementoptionsMountPaginationOptionsreturnPaginationMount- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountPaginationOptions- Requirement
- required
- Name
return- Kind
- return value
- Type
PaginationMount- Requirement
- n/a
MountPaginationOptions
interfaceinterface MountPaginationOptions extends PaginationInput { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void; readonly messages?: PaginationConnectOptions["messages"]; readonly renderPage?: (element: HTMLElement, page: number) => void;}messagesPaginationConnectOptions["messages"]onPageChange(detail: PaginationPageChangeDetail) => voidrenderPage(element: HTMLElement, page: number) => void- Name
messages- Kind
- property
- Type
PaginationConnectOptions["messages"]- Requirement
- optional
- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
- Name
renderPage- Kind
- property
- Type
(element: HTMLElement, page: number) => void- Requirement
- optional
paginationAnatomy
valueexport declare const paginationAnatomy: { readonly scope: "pagination"; readonly parts: readonly ["root", "list", "cell", "gap"];};partsreadonly ["root", "list", "cell", "gap"]scope"pagination"- Name
parts- Kind
- property
- Type
readonly ["root", "list", "cell", "gap"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"pagination"- Requirement
- required
PaginationApi
interfaceinterface PaginationApi { rootProps(): PartProps; listProps(): PartProps; previousProps(): PartProps; pageProps(page: number): PartProps; gapProps(index?: number): PartProps; nextProps(): PartProps; readonly page: number; readonly pageCount: number; readonly range: readonly (number | "…")[];}gapProps(index?: number) => PartPropslistProps() => PartPropsnextProps() => PartPropspagenumberpageCountnumberpageProps(page: number) => PartPropspreviousProps() => PartPropsrangereadonly (number | "…")[]rootProps() => PartProps- Name
gapProps- Kind
- method
- Type
(index?: number) => PartProps- Requirement
- required
- Name
listProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
nextProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
page- Kind
- property
- Type
number- Requirement
- required
- Name
pageCount- Kind
- property
- Type
number- Requirement
- required
- Name
pageProps- Kind
- method
- Type
(page: number) => PartProps- Requirement
- required
- Name
previousProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
range- Kind
- property
- Type
readonly (number | "…")[]- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
type PaginationChangeReason = "pointer" | "keyboard" | "programmatic";PaginationCommand
typetype PaginationCommand = CommandObject & { readonly type: "PAGE_CHANGE_REQUEST"; readonly page: number; readonly reason: PaginationChangeReason;};pagenumberreasonPaginationChangeReasontypestring- Name
page- Kind
- property
- Type
number- Requirement
- required
- Name
reason- Kind
- property
- Type
PaginationChangeReason- Requirement
- required
- Name
type- Kind
- property
- Type
string- Requirement
- required
PaginationConnectOptions
interfaceinterface PaginationConnectOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void; readonly messages?: Partial<PaginationMessages>;}messagesPartial<PaginationMessages>onPageChange(detail: PaginationPageChangeDetail) => void- Name
messages- Kind
- property
- Type
Partial<PaginationMessages>- Requirement
- optional
- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
PaginationContext
typetype PaginationContext = { readonly mode: "controlled" | "uncontrolled"; readonly page: number; readonly total: number; readonly pageSize: number; readonly siblingCount: number; readonly pageCount: number; readonly range: readonly (number | "…")[];};mode"controlled" | "uncontrolled"pagenumberpageCountnumberpageSizenumberrangereadonly (number | "…")[]siblingCountnumbertotalnumber- Name
mode- Kind
- property
- Type
"controlled" | "uncontrolled"- Requirement
- required
- Name
page- Kind
- property
- Type
number- Requirement
- required
- Name
pageCount- Kind
- property
- Type
number- Requirement
- required
- Name
pageSize- Kind
- property
- Type
number- Requirement
- required
- Name
range- Kind
- property
- Type
readonly (number | "…")[]- Requirement
- required
- Name
siblingCount- Kind
- property
- Type
number- Requirement
- required
- Name
total- Kind
- property
- Type
number- Requirement
- required
PaginationEvent
typetype PaginationEvent = { readonly type: "SET_PAGE"; readonly page: number; readonly reason: PaginationChangeReason;} | { readonly type: "PREVIOUS"; readonly reason: Exclude<PaginationChangeReason, "programmatic">;} | { readonly type: "NEXT"; readonly reason: Exclude<PaginationChangeReason, "programmatic">;} | { readonly type: "FIRST"; readonly reason: PaginationChangeReason;} | { readonly type: "LAST"; readonly reason: PaginationChangeReason;};PaginationInput
typetype PaginationInput = { /** Total records/items. */ readonly total: number; /** Records/items per page. Values below one normalize to one. */ readonly pageSize: number; /** Controlled 1-based page. Defining it fixes controlled mode. */ readonly page?: number; /** Uncontrolled initial 1-based page. Defaults to one. */ readonly defaultPage?: number; /** Pages to show either side of the current page. Defaults to one. */ readonly siblingCount?: number;};defaultPagenumberpagenumberpageSizenumbersiblingCountnumbertotalnumber- Name
defaultPage- Kind
- property
- Type
number- Requirement
- optional
- Description
- Uncontrolled initial 1-based page. Defaults to one.
- Name
page- Kind
- property
- Type
number- Requirement
- optional
- Description
- Controlled 1-based page. Defining it fixes controlled mode.
- Name
pageSize- Kind
- property
- Type
number- Requirement
- required
- Description
- Records/items per page. Values below one normalize to one.
- Name
siblingCount- Kind
- property
- Type
number- Requirement
- optional
- Description
- Pages to show either side of the current page. Defaults to one.
- Name
total- Kind
- property
- Type
number- Requirement
- required
- Description
- Total records/items.
paginationMachine
valueexport declare const paginationMachine: PaginationMachine;paginationMessages
valueexport declare const paginationMessages: PaginationMessages;PaginationMessages
typetype PaginationMessages = Pick<MessageTable, "root" | "previous" | "next">;PaginationMount
interfaceinterface PaginationMount { readonly service: PaginationService; readonly connector: PaginationApi; readonly root: HTMLElement; destroy(): void;}connectorPaginationApidestroy() => voidrootHTMLElementservicePaginationService- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLElement- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
PaginationPageChangeDetail
interfaceinterface PaginationPageChangeDetail { readonly page: number; readonly reason: PaginationChangeReason;}pagenumberreasonPaginationChangeReason- Name
page- Kind
- property
- Type
number- Requirement
- required
- Name
reason- Kind
- property
- Type
PaginationChangeReason- Requirement
- required
PaginationPart
typetype PaginationPart = (typeof paginationAnatomy.parts)[number];paginationRange
functionExact port of the frozen ui-core oracle.
declare function paginationRange(page: number, count: number, siblings?: number): (number | "…")[];pagenumbercountnumbersiblingsnumberreturn(number | "…")[]- Name
page- Kind
- parameter
- Type
number- Requirement
- required
- Name
count- Kind
- parameter
- Type
number- Requirement
- required
- Name
siblings- Kind
- parameter
- Type
number- Requirement
- optional
- Name
return- Kind
- return value
- Type
(number | "…")[]- Requirement
- n/a
paginationSelectors
valueexport declare const paginationSelectors: { page: (snapshot: PaginationSnapshot) => number; pageCount: (snapshot: PaginationSnapshot) => number; range: (snapshot: PaginationSnapshot) => readonly (number | "…")[]; canPrevious: (snapshot: PaginationSnapshot) => boolean; canNext: (snapshot: PaginationSnapshot) => boolean;};canNext(snapshot: PaginationSnapshot) => booleancanPrevious(snapshot: PaginationSnapshot) => booleanpage(snapshot: PaginationSnapshot) => numberpageCount(snapshot: PaginationSnapshot) => numberrange(snapshot: PaginationSnapshot) => readonly (number | "…")[]- Name
canNext- Kind
- property
- Type
(snapshot: PaginationSnapshot) => boolean- Requirement
- required
- Name
canPrevious- Kind
- property
- Type
(snapshot: PaginationSnapshot) => boolean- Requirement
- required
- Name
page- Kind
- property
- Type
(snapshot: PaginationSnapshot) => number- Requirement
- required
- Name
pageCount- Kind
- property
- Type
(snapshot: PaginationSnapshot) => number- Requirement
- required
- Name
range- Kind
- property
- Type
(snapshot: PaginationSnapshot) => readonly (number | "…")[]- Requirement
- required
PaginationService
typetype PaginationService = Service<PaginationInput, PaginationStateValue, PaginationContext, PaginationEvent, PaginationCommand>;PaginationSnapshot
typetype PaginationSnapshot = Snapshot<PaginationStateValue, PaginationContext>;PaginationStateValue
typetype PaginationStateValue = "ready";runPaginationCommand
functiondeclare function runPaginationCommand(command: PaginationCommand, _scope: PartScope, options?: PaginationConnectOptions): void;commandPaginationCommand_scopePartScopeoptionsPaginationConnectOptionsreturnvoid- Name
command- Kind
- parameter
- Type
PaginationCommand- Requirement
- required
- Name
_scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
PaginationConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React imports
import { Gap, List, Next, Page, Pages, Pagination, Previous, Root } from "@grassroot/ui-headless-react/pagination"; // +1 more exportsVue imports
<script setup lang="ts">import { PaginationGap, PaginationList, PaginationNext, PaginationPage, PaginationPages, PaginationPrevious, PaginationRoot } from "@grassroot/ui-headless-vue/pagination";</script>Angular imports
import { Component } from "@angular/core";import { GR_PAGINATION_DECLARATIONS } from "@grassroot/ui-headless-angular/pagination"; @Component({ standalone: true, imports: [GR_PAGINATION_DECLARATIONS], template: `<!-- compose the pagination parts here -->` })export class Example {}Svelte imports
<script lang="ts"> import { PaginationGap, PaginationList, PaginationNext, PaginationPage, PaginationPages, PaginationPrevious, PaginationRoot } from "@grassroot/ui-headless-svelte/pagination";</script>Solid imports
import { PaginationGap, PaginationList, PaginationNext, PaginationPage, PaginationPages, PaginationPrevious, PaginationRoot } from "@grassroot/ui-headless-solid/pagination";@grassroot/ui-headless-react/pagination
React adapter
Gap
valueexport declare const Gap: import("react").ForwardRefExoticComponent<GapProps & import("react").RefAttributes<HTMLSpanElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
GapProps
interfaceinterface GapProps extends ComponentPropsWithoutRef<"span">, Shared { readonly index?: number;}indexnumber- Name
index- Kind
- property
- Type
number- Requirement
- optional
List
valueexport declare const List: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & Shared & import("react").RefAttributes<HTMLUListElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Next
valueexport declare const Next: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & Shared & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Page
valueexport declare const Page: import("react").ForwardRefExoticComponent<PageProps & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
PageProps
interfaceinterface PageProps extends ComponentPropsWithoutRef<"button">, Shared { readonly page: number;}pagenumber- Name
page- Kind
- property
- Type
number- Requirement
- required
Pages
functiondeclare function Pages(): import("react").JSX.Element;returnimport("react").JSX.Element- Name
return- Kind
- return value
- Type
import("react").JSX.Element- Requirement
- n/a
Pagination
valueexport declare const Pagination: { Root: import("react").ForwardRefExoticComponent<PaginationRootProps & import("react").RefAttributes<HTMLElement>>; RootProvider: import("react").ForwardRefExoticComponent<PaginationRootProviderProps & import("react").RefAttributes<HTMLElement>>; List: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLUListElement>>; Previous: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLButtonElement>>; Page: import("react").ForwardRefExoticComponent<PageProps & import("react").RefAttributes<HTMLButtonElement>>; Gap: import("react").ForwardRefExoticComponent<GapProps & import("react").RefAttributes<HTMLSpanElement>>; Next: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLButtonElement>>; Pages: typeof Pages;};Gapimport("react").ForwardRefExoticComponent<GapProps & import("react").RefAttributes<HTMLSpanElement>>Listimport("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLUListElement>>Nextimport("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLButtonElement>>Pageimport("react").ForwardRefExoticComponent<PageProps & import("react").RefAttributes<HTMLButtonElement>>Pagestypeof PagesPreviousimport("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
readonly asChild?: boolean;
} & import("react").RefAttributes<HTMLButtonElement>>Rootimport("react").ForwardRefExoticComponent<PaginationRootProps & import("react").RefAttributes<HTMLElement>>RootProviderimport("react").ForwardRefExoticComponent<PaginationRootProviderProps & import("react").RefAttributes<HTMLElement>>- Name
Gap- Kind
- property
- Type
import("react").ForwardRefExoticComponent<GapProps & import("react").RefAttributes<HTMLSpanElement>>- Requirement
- required
- Name
List- Kind
- property
- Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLUListElement>>- Requirement
- required
- Name
Next- Kind
- property
- Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLButtonElement>>- Requirement
- required
- Name
Page- Kind
- property
- Type
import("react").ForwardRefExoticComponent<PageProps & import("react").RefAttributes<HTMLButtonElement>>- Requirement
- required
- Name
Pages- Kind
- property
- Type
typeof Pages- Requirement
- required
- Name
Previous- Kind
- property
- Type
import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & { readonly asChild?: boolean; } & import("react").RefAttributes<HTMLButtonElement>>- Requirement
- required
- Name
Root- Kind
- property
- Type
import("react").ForwardRefExoticComponent<PaginationRootProps & import("react").RefAttributes<HTMLElement>>- Requirement
- required
- Name
RootProvider- Kind
- property
- Type
import("react").ForwardRefExoticComponent<PaginationRootProviderProps & import("react").RefAttributes<HTMLElement>>- Requirement
- required
PaginationContext
valueexport declare const PaginationContext: import("react").Context<PaginationContextValue | null>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
PaginationContextValue
interfaceinterface PaginationContextValue { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: PaginationSnapshot;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotPaginationSnapshot- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
PaginationSnapshot- Requirement
- required
PaginationRootProps
interfaceinterface PaginationRootProps extends Omit<ComponentPropsWithoutRef<"nav">, "onChange"> { readonly asChild?: boolean; readonly total: number; readonly pageSize: number; readonly page?: number; readonly defaultPage?: number; readonly siblingCount?: number; readonly onPageChange?: UsePaginationOptions["onPageChange"]; readonly children?: ReactNode;}asChildbooleanchildrenReactNodedefaultPagenumberonPageChangeUsePaginationOptions["onPageChange"]pagenumberpageSizenumbersiblingCountnumbertotalnumber- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
defaultPage- Kind
- property
- Type
number- Requirement
- optional
- Name
onPageChange- Kind
- property
- Type
UsePaginationOptions["onPageChange"]- Requirement
- optional
- Name
page- Kind
- property
- Type
number- Requirement
- optional
- Name
pageSize- Kind
- property
- Type
number- Requirement
- required
- Name
siblingCount- Kind
- property
- Type
number- Requirement
- optional
- Name
total- Kind
- property
- Type
number- Requirement
- required
PaginationRootProviderProps
interfaceinterface PaginationRootProviderProps extends ComponentPropsWithoutRef<"nav"> { readonly value: UsePaginationResult; readonly asChild?: boolean;}asChildbooleanvalueUsePaginationResult- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
value- Kind
- property
- Type
UsePaginationResult- Requirement
- required
Previous
valueexport declare const Previous: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & Shared & import("react").RefAttributes<HTMLButtonElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Root
valueexport declare const Root: import("react").ForwardRefExoticComponent<PaginationRootProps & import("react").RefAttributes<HTMLElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
RootProvider
valueexport declare const RootProvider: import("react").ForwardRefExoticComponent<PaginationRootProviderProps & import("react").RefAttributes<HTMLElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
usePagination
functiondeclare function usePagination(input: PaginationInput, options?: UsePaginationOptions): UsePaginationResult;inputPaginationInputoptionsUsePaginationOptionsreturnUsePaginationResult- Name
input- Kind
- parameter
- Type
PaginationInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UsePaginationOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UsePaginationResult- Requirement
- n/a
usePaginationContext
functiondeclare function usePaginationContext(partName: string): PaginationContextValue;partNamestringreturnPaginationContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
PaginationContextValue- Requirement
- n/a
UsePaginationOptions
interfaceinterface UsePaginationOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void;}onPageChange(detail: PaginationPageChangeDetail) => void- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
UsePaginationResult
interfaceinterface UsePaginationResult { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: PaginationSnapshot;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotPaginationSnapshot- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
PaginationSnapshot- Requirement
- required
@grassroot/ui-headless-vue/pagination
Vue adapter
PaginationContextKey
valueexport declare const PaginationContextKey: InjectionKey<PaginationContextValue>;PaginationContextValue
interfaceinterface PaginationContextValue { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: ShallowRef<PaginationSnapshot>;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotShallowRef<PaginationSnapshot>- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<PaginationSnapshot>- Requirement
- required
PaginationGap
valueexport declare const PaginationGap: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; index: NumberConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; index: NumberConstructor;}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationList
valueexport declare const PaginationList: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationNext
valueexport declare const PaginationNext: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationPage
valueexport declare const PaginationPage: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; page: { type: NumberConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; page: { type: NumberConstructor; required: true; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationPages
valueexport declare const PaginationPages: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationPrevious
valueexport declare const PaginationPrevious: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor;}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;PaginationRoot
valueexport declare const PaginationRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; total: { type: NumberConstructor; required: true; }; pageSize: { type: NumberConstructor; required: true; }; page: PropType<PaginationInput["page"]>; defaultPage: PropType<PaginationInput["defaultPage"]>; siblingCount: PropType<PaginationInput["siblingCount"]>;}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { pageChange: (_detail: unknown) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: BooleanConstructor; total: { type: NumberConstructor; required: true; }; pageSize: { type: NumberConstructor; required: true; }; page: PropType<PaginationInput["page"]>; defaultPage: PropType<PaginationInput["defaultPage"]>; siblingCount: PropType<PaginationInput["siblingCount"]>;}>> & Readonly<{ onPageChange?: ((_detail: unknown) => any) | undefined;}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;usePagination
functiondeclare function usePagination(input: PaginationInput | (() => PaginationInput), options?: UsePaginationOptions): UsePaginationResult;inputPaginationInput | (() => PaginationInput)optionsUsePaginationOptionsreturnUsePaginationResult- Name
input- Kind
- parameter
- Type
PaginationInput | (() => PaginationInput)- Requirement
- required
- Name
options- Kind
- parameter
- Type
UsePaginationOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UsePaginationResult- Requirement
- n/a
usePaginationContext
functiondeclare function usePaginationContext(partName: string): PaginationContextValue;partNamestringreturnPaginationContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
PaginationContextValue- Requirement
- n/a
UsePaginationOptions
interfaceinterface UsePaginationOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void;}onPageChange(detail: PaginationPageChangeDetail) => void- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
UsePaginationResult
interfaceinterface UsePaginationResult { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: ShallowRef<PaginationSnapshot>;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotShallowRef<PaginationSnapshot>- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<PaginationSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/pagination
Angular adapter
createPaginationStore
functionexport declare function createPaginationStore(input: PaginationInput, options?: CreatePaginationStoreOptions): PaginationStore;inputPaginationInputoptionsCreatePaginationStoreOptionsreturnPaginationStore- Name
input- Kind
- parameter
- Type
PaginationInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
CreatePaginationStoreOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
PaginationStore- Requirement
- n/a
CreatePaginationStoreOptions
interfaceexport interface CreatePaginationStoreOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void; readonly onCommit?: () => void;}onCommit() => voidonPageChange(detail: PaginationPageChangeDetail) => void- Name
onCommit- Kind
- property
- Type
() => void- Requirement
- optional
- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
export declare const GR_PAGINATION_DECLARATIONS: readonly [typeof GrPaginationRoot, typeof GrPaginationList, typeof GrPaginationPrevious, typeof GrPaginationPage, typeof GrPaginationGap, typeof GrPaginationNext, typeof GrPaginationPages];GrPaginationGap
classexport declare class GrPaginationGap implements OnDestroy { readonly index: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationGap, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationGap, "[grPaginationGap]", never, { "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanyindeximport("@angular/core").InputSignal<number>listenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationGap, "[grPaginationGap]", never, { "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationGap, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
index- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationGap, "[grPaginationGap]", never, { "index": { "alias": "index"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationGap, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrPaginationList
classexport declare class GrPaginationList implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationList, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationList, "[grPaginationList]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationList, "[grPaginationList]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationList, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationList, "[grPaginationList]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationList, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrPaginationNext
classexport declare class GrPaginationNext implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationNext, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationNext, "[grPaginationNext]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationNext, "[grPaginationNext]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationNext, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationNext, "[grPaginationNext]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationNext, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrPaginationPage
classexport declare class GrPaginationPage implements OnDestroy { readonly page: import("@angular/core").InputSignal<number>; private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationPage, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationPage, "[grPaginationPage]", never, { "page": { "alias": "page"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationPage, "[grPaginationPage]", never, { "page": { "alias": "page"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationPage, never>pageimport("@angular/core").InputSignal<number>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationPage, "[grPaginationPage]", never, { "page": { "alias": "page"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationPage, never>- Requirement
- required
- Name
page- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrPaginationPages
classexport declare class GrPaginationPages { private readonly store; private readonly template; private readonly view; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationPages, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationPages, "[grPaginationPages]", never, {}, {}, never, never, true, never>;}ngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationPages, "[grPaginationPages]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationPages, never>storeanytemplateanyviewany- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationPages, "[grPaginationPages]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationPages, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
- Name
template- Kind
- property
- Type
any- Requirement
- required
- Name
view- Kind
- property
- Type
any- Requirement
- required
GrPaginationPrevious
classexport declare class GrPaginationPrevious implements OnDestroy { private readonly store; private readonly element; private readonly listeners; private readonly consumer; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationPrevious, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationPrevious, "[grPaginationPrevious]", never, {}, {}, never, never, true, never>;}consumeranyelementanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrPaginationPrevious, "[grPaginationPrevious]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationPrevious, never>storeany- Name
consumer- Kind
- property
- Type
any- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationPrevious, "[grPaginationPrevious]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationPrevious, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrPaginationRoot
classexport declare class GrPaginationRoot { readonly total: import("@angular/core").InputSignal<number>; readonly pageSize: import("@angular/core").InputSignal<number>; readonly page: import("@angular/core").InputSignal<number | undefined>; readonly defaultPage: import("@angular/core").InputSignal<number | undefined>; readonly siblingCount: import("@angular/core").InputSignal<number | undefined>; readonly pageChange: import("@angular/core").OutputEmitterRef<{ page: number; reason: string; }>; readonly store: import("./context.js").PaginationStore; private readonly element; private readonly injector; private readonly listeners; private previous; constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<GrPaginationRoot, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrPaginationRoot, "[grPaginationRoot]", never, { "total": { "alias": "total"; "required": true; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": true; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "defaultPage": { "alias": "defaultPage"; "required": false; "isSignal": true; }; "siblingCount": { "alias": "siblingCount"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; }, never, never, true, never>;}defaultPageimport("@angular/core").InputSignal<number | undefined>elementanyinjectoranylistenersanyɵdiri0.ɵɵDirectiveDeclaration<GrPaginationRoot, "[grPaginationRoot]", never, { "total": { "alias": "total"; "required": true; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": true; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "defaultPage": { "alias": "defaultPage"; "required": false; "isSignal": true; }; "siblingCount": { "alias": "siblingCount"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; }, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrPaginationRoot, never>pageimport("@angular/core").InputSignal<number | undefined>pageChangeimport("@angular/core").OutputEmitterRef<{
page: number;
reason: string;
}>pageSizeimport("@angular/core").InputSignal<number>previousanysiblingCountimport("@angular/core").InputSignal<number | undefined>storeimport("./context.js").PaginationStoretotalimport("@angular/core").InputSignal<number>- Name
defaultPage- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
element- Kind
- property
- Type
any- Requirement
- required
- Name
injector- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrPaginationRoot, "[grPaginationRoot]", never, { "total": { "alias": "total"; "required": true; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": true; "isSignal": true; }; "page": { "alias": "page"; "required": false; "isSignal": true; }; "defaultPage": { "alias": "defaultPage"; "required": false; "isSignal": true; }; "siblingCount": { "alias": "siblingCount"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; }, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrPaginationRoot, never>- Requirement
- required
- Name
page- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
pageChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<{ page: number; reason: string; }>- Requirement
- required
- Name
pageSize- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
- Name
previous- Kind
- property
- Type
any- Requirement
- required
- Name
siblingCount- Kind
- property
- Type
import("@angular/core").InputSignal<number | undefined>- Requirement
- required
- Name
store- Kind
- property
- Type
import("./context.js").PaginationStore- Requirement
- required
- Name
total- Kind
- property
- Type
import("@angular/core").InputSignal<number>- Requirement
- required
PAGINATION_STORE
valueexport declare const PAGINATION_STORE: InjectionToken<PaginationStore>;PaginationStore
interfaceexport interface PaginationStore { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: { total: number; pageSize: number; page?: number; defaultPage?: number; siblingCount?: number; }): void;}connectorPaginationApiscopePartScopeservicePaginationServicestart() => voidstop() => voidsync(input: { total: number; pageSize: number; page?: number; defaultPage?: number; siblingCount?: number; }) => voidversionWritableSignal<number>- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: { total: number; pageSize: number; page?: number; defaultPage?: number; siblingCount?: number; }) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
@grassroot/ui-headless-svelte/pagination
Svelte adapter
createPagination
functionexport declare function createPagination(inputGetter: () => PaginationInput, options?: UsePaginationOptions): UsePaginationResult;inputGetter() => PaginationInputoptionsUsePaginationOptionsreturnUsePaginationResult- Name
inputGetter- Kind
- parameter
- Type
() => PaginationInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UsePaginationOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UsePaginationResult- Requirement
- n/a
PaginationContextValue
interfaceexport interface PaginationContextValue { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly version: () => number;}connectorPaginationApiscopePartScopeservicePaginationServiceversion() => number- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
PaginationGap
valueexport declare const PaginationGap: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationList
valueexport declare const PaginationList: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationNext
valueexport declare const PaginationNext: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationPage
valueexport declare const PaginationPage: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationPages
valueexport declare const PaginationPages: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationPrevious
valueexport declare const PaginationPrevious: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
PaginationRoot
valueexport declare const PaginationRoot: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
usePaginationContext
functionexport declare function usePaginationContext(partName: string): PaginationContextValue;partNamestringreturnPaginationContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
PaginationContextValue- Requirement
- n/a
UsePaginationOptions
interfaceexport interface UsePaginationOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void;}onPageChange(detail: PaginationPageChangeDetail) => void- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
UsePaginationResult
interfaceexport interface UsePaginationResult { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly version: () => number;}connectorPaginationApiscopePartScopeservicePaginationServiceversion() => number- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/pagination
Solid adapter
PaginationContext
valueexport declare const PaginationContext: import("solid-js").Context<PaginationContextValue | undefined>;PaginationContextValue
interfaceexport interface PaginationContextValue { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: Accessor<PaginationSnapshot>;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotAccessor<PaginationSnapshot>- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<PaginationSnapshot>- Requirement
- required
PaginationGap
functionexport declare function PaginationGap(props: PaginationGapProps): JSX.Element;propsPaginationGapPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
PaginationGapProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationGapProps
interfaceexport interface PaginationGapProps extends JSX.HTMLAttributes<HTMLSpanElement> { readonly index?: number;}indexnumber- Name
index- Kind
- property
- Type
number- Requirement
- optional
PaginationList
functionexport declare function PaginationList(props: JSX.HTMLAttributes<HTMLUListElement>): JSX.Element;propsJSX.HTMLAttributes<HTMLUListElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.HTMLAttributes<HTMLUListElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationNext
functionexport declare function PaginationNext(props: JSX.ButtonHTMLAttributes<HTMLButtonElement>): JSX.Element;propsJSX.ButtonHTMLAttributes<HTMLButtonElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.ButtonHTMLAttributes<HTMLButtonElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationPage
functionexport declare function PaginationPage(props: PaginationPageProps): JSX.Element;propsPaginationPagePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
PaginationPageProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationPageProps
interfaceexport interface PaginationPageProps extends JSX.ButtonHTMLAttributes<HTMLButtonElement> { readonly page: number;}pagenumber- Name
page- Kind
- property
- Type
number- Requirement
- required
PaginationPages
functionexport declare function PaginationPages(): JSX.Element;returnJSX.Element- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationPrevious
functionexport declare function PaginationPrevious(props: JSX.ButtonHTMLAttributes<HTMLButtonElement>): JSX.Element;propsJSX.ButtonHTMLAttributes<HTMLButtonElement>returnJSX.Element- Name
props- Kind
- parameter
- Type
JSX.ButtonHTMLAttributes<HTMLButtonElement>- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationRoot
functionexport declare function PaginationRoot(props: PaginationRootProps): JSX.Element;propsPaginationRootPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
PaginationRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
PaginationRootProps
interfaceexport interface PaginationRootProps extends JSX.HTMLAttributes<HTMLElement> { readonly total: number; readonly pageSize: number; readonly page?: PaginationInput["page"]; readonly defaultPage?: PaginationInput["defaultPage"]; readonly siblingCount?: PaginationInput["siblingCount"]; readonly onPageChange?: UsePaginationOptions["onPageChange"];}defaultPagePaginationInput["defaultPage"]onPageChangeUsePaginationOptions["onPageChange"]pagePaginationInput["page"]pageSizenumbersiblingCountPaginationInput["siblingCount"]totalnumber- Name
defaultPage- Kind
- property
- Type
PaginationInput["defaultPage"]- Requirement
- optional
- Name
onPageChange- Kind
- property
- Type
UsePaginationOptions["onPageChange"]- Requirement
- optional
- Name
page- Kind
- property
- Type
PaginationInput["page"]- Requirement
- optional
- Name
pageSize- Kind
- property
- Type
number- Requirement
- required
- Name
siblingCount- Kind
- property
- Type
PaginationInput["siblingCount"]- Requirement
- optional
- Name
total- Kind
- property
- Type
number- Requirement
- required
usePagination
functionexport declare function usePagination(input: Accessor<PaginationInput>, options?: UsePaginationOptions): UsePaginationResult;inputAccessor<PaginationInput>optionsUsePaginationOptionsreturnUsePaginationResult- Name
input- Kind
- parameter
- Type
Accessor<PaginationInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UsePaginationOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UsePaginationResult- Requirement
- n/a
usePaginationContext
functionexport declare function usePaginationContext(partName: string): PaginationContextValue;partNamestringreturnPaginationContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
PaginationContextValue- Requirement
- n/a
UsePaginationOptions
interfaceexport interface UsePaginationOptions { readonly onPageChange?: (detail: PaginationPageChangeDetail) => void;}onPageChange(detail: PaginationPageChangeDetail) => void- Name
onPageChange- Kind
- property
- Type
(detail: PaginationPageChangeDetail) => void- Requirement
- optional
UsePaginationResult
interfaceexport interface UsePaginationResult { readonly service: PaginationService; readonly connector: PaginationApi; readonly scope: PartScope; readonly snapshot: Accessor<PaginationSnapshot>;}connectorPaginationApiscopePartScopeservicePaginationServicesnapshotAccessor<PaginationSnapshot>- Name
connector- Kind
- property
- Type
PaginationApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
PaginationService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<PaginationSnapshot>- Requirement
- required