QubeeList

type@qubeejs/angularsrc/lib/types/qubee-list.type.ts

What injectQubeeList() returns for a list definition TList

Reads are signals; writes are functions held as properties, so the handle can be destructured. toggleSort is present when the list declares exactly one sortParam — see QubeeListSortToggle.

Members

Member	Type	Description
href	(changes?: Partial<ListState<TList>>) => string	The href for the current state with changes applied — for links, which stay crawlable and middle-clickable. Built from the draft, so it includes what set() has not committed yet. Reads signals, so a template that calls it updates with the list.
isPending	Signal<boolean>	A debounce is waiting, or a navigation is in flight.
request	Signal<QubeeListRequest<TList>>	{ uri, headers, paginate } for the state in the URL and the input. Changes once per navigation, never per keystroke, and only when the URI or the headers differ, so httpResource() and other fetchers built on it fetch exactly once per page. null while the input is null.
reset	(options?: Omit<QubeeListSetOptions, 'debounce'>) => void	Return every param to its default in one navigation; parameters the list does not own are kept, and a list already at its defaults does not navigate.
set	(changes: Partial<ListState<TList>>, options?: QubeeListSetOptions) => void	Apply changes and navigate — at most one navigation per call. A change to anything but the page returns to page 1; undefined returns a param to its default.
setPage	(page: number, options?: Omit<QubeeListSetOptions, 'debounce'>) => void	set({ page })
state	Signal<ListState<TList>>	The list’s state, including changes not yet in the URL.

Intersected with QubeeListSortToggle<TList>.