@guiexpert/demo-table-models 1.1.105 → 1.1.106

package/lib/createCoverGridModel.d.ts

@@ -0,0 +1,59 @@
+import { AreaIdent, AreaModelIf, CellRendererIf, CoverGridTableModel, RendererCleanupFnType, TableOptionsIf } from '@guiexpert/table';
+import { BookIf } from '../model/book.if.js';
+
+/**
+ * A fixed book collection for cover grid demos: `count` books with title, author, genre, year, pages and a cover hue.
+ * The same count gives the same books (no randomness) – titles repeat with a volume number after 288 books.
+ *
+ * @param count - number of books (default 10,000)
+ */
+export declare function generateBooks(count?: number): BookIf[];
+/** Sort orders of the cover grid demo – for `tableApi.sort(compareFn)`. */
+export declare const BOOK_SORTS: Record<"title" | "author" | "year" | "id", (a: BookIf, b: BookIf) => number>;
+/** What {@link BookCoverRenderer} asks the page. */
+export interface BookCoverContextIf {
+    /** The selected book gets a frame. */
+    isSelected?(book: BookIf): boolean;
+}
+/**
+ * Draws one book as a tile of the cover grid: a generated cover (gradient, genre, title, author) and a caption.
+ * Plain DOM, no framework. The book data is set as text (`textContent`), never as HTML.
+ * The tile fills the cell, so it follows `bodyModel.coverWidth` / `coverHeight`.
+ */
+export declare class BookCoverRenderer implements CellRendererIf {
+    private readonly ctx;
+    constructor(ctx?: BookCoverContextIf);
+    render(cellDiv: HTMLDivElement, _rowIndex: number, _columnIndex: number, _areaIdent: AreaIdent, areaModel: AreaModelIf, cellValue: unknown): RendererCleanupFnType | undefined;
+}
+/** Result of {@link createCoverGridModelAndOptions}. */
+export interface CoverGridModelAndOptionsIf {
+    tableModel: CoverGridTableModel<BookIf>;
+    tableOptions: TableOptionsIf;
+}
+/**
+ * Cover grid demo: books as tiles in a grid that fills the width of the table. The number of columns follows the
+ * width (`floor(width / coverWidth)`); only the visible rows are in the DOM.
+ *
+ * - filter: `filter` becomes `externalFilterFunction` – call `tableApi.externalFilterChanged()` after a change
+ * - sort: `tableApi.sort(BOOK_SORTS.title)`
+ * - size: `tableModel.bodyModel.coverWidth/coverHeight = …` + `tableApi.repaintHard()`
+ *
+ * @param books - the items (default: {@link generateBooks})
+ * @param coverWidth - width of a tile in px (default 160)
+ * @param coverHeight - height of a tile in px (default 260)
+ * @param ctx - `filter` (which books are shown) and `isSelected` (frame)
+ */
+export declare function createCoverGridModelAndOptions(books?: BookIf[], coverWidth?: number, coverHeight?: number, ctx?: BookCoverContextIf & {
+    filter?: (book: BookIf) => boolean;
+}): CoverGridModelAndOptionsIf;
+/**
+ * Stretches the tiles so that the columns fill the width of the grid (no gap on the right). The number of columns
+ * stays `floor(width / baseWidth)`, the height grows with the width (same aspect ratio). Call it after the width of
+ * the table changed (e.g. `tableApi.recalcColumnWidths()` from your own `ResizeObserver`), then `tableApi.repaintHard()`.
+ *
+ * @param tableModel - the cover grid model (its `bodyModel.width` is the width the table set)
+ * @param baseWidth - the wanted (minimal) tile width
+ * @param baseHeight - the tile height at `baseWidth`
+ * @returns `true` if the tile size changed
+ */
+export declare function fitCoversToWidth(tableModel: CoverGridTableModel<unknown>, baseWidth: number, baseHeight: number): boolean;

package/model/book.if.d.ts

@@ -0,0 +1,11 @@
+/** A book of the cover grid demo (`createCoverGridModelAndOptions`). */
+export interface BookIf {
+    id: number;
+    title: string;
+    author: string;
+    genre: string;
+    year: number;
+    pages: number;
+    /** Base hue (0…359) of the generated cover. */
+    hue: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/demo-table-models",
-  "version": "1.1.105",
+  "version": "1.1.106",
   "license": "MIT",
   "author": "Dr. Marc Kronberg <info@gui.expert> (https://gui.expert)",
   "repository": {
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@guiexpert/table": "^1.1.105"
+    "@guiexpert/table": "^1.1.106"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",