@openrails/contentkit-ui 0.103.2 → 0.104.0-rc.2

package/dist/components/content/grid.d.ts

@@ -1,8 +1,8 @@
 import { CSSProperties, ReactNode } from 'react';
 import { ContentKitUiAppearance } from '../../appearance.js';
 import { ContentKitClient } from '../../client/client.js';
-import { ContentQuery, HistoryQuery, RailQuery, SearchQuery } from '../../client/discovery.js';
-import { Card } from '../../client/generated/wire.js';
+import { AccessMode, ContentQuery, HistoryQuery, RailQuery, SearchQuery } from '../../client/discovery.js';
+import { Card, ListingSummary } from '../../client/generated/wire.js';
 import { UseList } from '../../react/use-resource.js';
 import { ContentCardProps } from './card.js';
 export interface CardListProps extends Omit<ContentCardProps, "card" | "onOpen" | "children" | "className"> {
@@ -18,8 +18,30 @@ export interface CardListProps extends Omit<ContentCardProps, "card" | "onOpen"
     client?: ContentKitClient;
     className?: string;
     appearance?: ContentKitUiAppearance;
+    /** Collapse paid/locked cards into a counted tile, or hide them; default show. */
+    locked?: LockedCards;
+    /** Optional-filter summary tiles are on by default; hosts may suppress them in previews. */
+    showFilteredSummary?: boolean;
+    /** Show the collapsed locked tile only at this measured grid width. Default 0. */
+    lockedSummaryMinColumns?: number;
+    /** Limit rendered preview tiles without changing the matching selection or summary counts. */
+    cardLimit?: number;
+    /** Limit cards in mobile previews without mounting their images. */
+    mobileCardLimit?: number;
+    /** Host-specific nouns for summary controls. */
+    summaryLabels?: {
+        premium?: (count: number) => string;
+        filtered?: (count: number) => string;
+    };
     /** Opt into a fluid grid, optionally with a desktop column ceiling. */
     grid?: CardGridLayout;
+    /** Numbered pages with a shown range instead of load more or infinite scroll. */
+    pagination?: "pages";
+    /** The numbered page, from 1; with onPageChange the host keeps it (in its URL). */
+    page?: number;
+    onPageChange?: (page: number) => void;
+    /** Each numbered page's link, for crawlers and opening in a new tab. */
+    pageHref?: (page: number) => string;
 }
 export interface CardGridLayout {
     /** Minimum desktop card width: CSS pixels or a CSS length such as clamp(...). Cards fill the available space. */
@@ -34,30 +56,36 @@ export declare function cardGridLayout(layout?: CardGridLayout): {
     className: string;
     style?: CSSProperties;
 };
-/** A list's cards in a responsive grid, paged, with exposures and click signals. */
-export declare function CardGrid({ list, render, ...p }: CardListProps & {
-    list: UseList<Card>;
+/** A list carries exact selection-wide counts when the API was asked for them. */
+type SummaryList = UseList<Card> & {
+    summary?: ListingSummary;
+};
+type GridProps = CardListProps & {
+    list: SummaryList;
     render: string;
-}): import('react').JSX.Element;
+    filterKinds?: readonly string[];
+    filterLanguage?: string;
+    horizontal?: boolean;
+};
+/** A list's cards and summary controls share one responsive, animated grid. */
+export declare function CardGrid(p: GridProps): import('react').JSX.Element;
 /**
  * What a list does with cards the reader doesn't open: shows them marked
- * (show), leaves them out (hide), or lists them apart, counted, behind a
- * toggle that loads them when opened (collapse).
+ * (show), leaves them out (hide), or replaces them with a counted tile
+ * that reveals the cached previews in place (collapse).
  */
 export type LockedCards = "show" | "hide" | "collapse";
-/** Contents as cards (GET /v1/contents): any sort and filter, paged. */
-export declare function ContentGrid({ query, locked, ...p }: CardListProps & {
+/** Settle locked-card admission before pagination, retaining explicit reader modes otherwise. */
+export declare function cardListMode(locked: LockedCards | undefined, mode?: AccessMode): AccessMode | undefined;
+/** Contents as cards (GET /v1/contents): any sort and filter, paged by load more, infinite scroll or numbered pages. */
+export declare function ContentGrid(p: CardListProps & {
     query: ContentQuery;
-    locked?: LockedCards;
 }): import('react').JSX.Element;
 /** Search results as cards; nothing until the query has text. */
-export declare function SearchResults({ query, ...p }: CardListProps & {
+export declare function SearchResults(p: CardListProps & {
     query: SearchQuery;
-}): import('react').JSX.Element | null;
-/** The signed-in reader's history as cards, each removable, with a clear-all. */
-export declare function ContentHistory({ query, ...p }: CardListProps & {
-    query?: HistoryQuery;
 }): import('react').JSX.Element;
+export { ContentHistory } from './history.js';
 export interface ContentRailProps extends Omit<CardListProps, "infinite" | "empty"> {
     /** The rail's heading. */
     title: ReactNode;