@metreeca/tile
    Preparing search index...
    • Creates a windowed collection list.

      Lists the items of a collection held by the shared store, rendering each through children, and keeps in step with the store as useCollection does. Only the items in view are retrieved, in batches of 100 together with the batch before and the one after them, while the list takes the room the whole collection would, as estimated from the height of the rows on show, so the scrollbar of whatever area the list scrolls in spans the collection; the items on show stay where they stand while the batches for a new position are on their way.

      Filters and sort order are stated in the model as criteria on the collection, as the store takes them: the list sets the offset and limit alone, overriding any the model states, and starts again from the first items whenever it is handed a model stating something different.

      Where a placeholder is supplied, a list with nothing to show fills its area with it, worded as still loading or as matching nothing. A failed exchange is shown as a critical note in place of the list.

      Type Parameters

      • S extends Lazy<ResourceShape>

        The shape describing the resource holding the collection

      • T extends
            | Model<S, T>
            | Template & Entries<S, T>
            | Template & Entries<S, T> & {
                readonly [F in string | number | symbol]: F extends Repeated<S>
                    ? Collecting<S, F, T[F]>
                    : never
            }

        The model naming the property collecting the items and stating which values of each item are wanted

      Parameters

      • options: {
            entry: string;
            shape: S;
            model: T;
            placeholder?: ComponentChildren;
            children: (item: Frame<S, T>) => ComponentChildren;
        }

        The widget configuration

        • entry: string

          The identifier of the resource holding the collection, either absolute or relative to the current location.

        • shape: S

          The shape describing the resource holding the collection, possibly deferred to break definition cycles.

        • model: T

          The model naming the multi-valued property collecting the items, stating the values wanted from each item along with the criteria filtering and sorting them; compared by content, so a model may be written inline and a copy stating the same leaves the list where it stands.

        • Optionalplaceholder?: ComponentChildren

          The glyph marking the area while the list has nothing to show; nothing is rendered in its place if omitted.

        • children: (item: Frame<S, T>) => ComponentChildren

          Renders an item of the collection.

      Returns false | "" | 0 | 0n | Element | null | undefined

      The list