module@warp-drive/experiments/pagination @experimental

Interface PaginationLinksSubscription<RT, E> sincev5.9.0

interface PaginationLinksSubscription<RT, E> {
  get paginationLinks(): Readonly<PaginationLinks<RT, E>>;
  (symbol) dispose(): void;
}

Defined in: node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts:941

Hideconstructor

The framework-agnostic core of a pagination links component (for example the <EachLink /> component of @warp-drive/ember): it owns the component lifecycle, while the links themselves live on the PaginationLinks it exposes.

Given the PagedPaginationState a <Paginate /> component is driving, paginationLinks derives that state's PaginationLinks — the numbered links (with placeholders for gaps) and the relational first/prev/next/last links a component yields for the consumer to render. All of them read from the same shared page graph as the <Paginate /> component, so they stay in sync as pages load and the active page changes.

Type Parameters

RT

RT

E

E

Methods

(symbol) dispose()

(symbol) dispose(): void;

Defined in: node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts:946

The method to call when the component this subscription is attached to unmounts.

Returns

void

Properties

paginationLinks

Get Signature

get paginationLinks(): Readonly<PaginationLinks<RT, E>>;

Defined in: node_modules/.pnpm/@warp-d_5e1563e0e582c8365bb74466d3761d6d/node_modules/@warp-drive/core/dist/signals/-leaked.d.ts:982

The PaginationLinks derived from the PagedPaginationState passed as an arg — the surface a links component yields to its consumer: the numbered links (empty for cursor-based collections) and the relational first/ prev/next/ last links.

Recomputes when the pages arg changes, so a component whose pagination resets to a different collection derives fresh links automatically.

Returns

Readonly<PaginationLinks<RT, E>>