@zeyos/zx 4.3.4 → 5.0.0

package/dist/types/components/kanban-view/kanban-view.d.ts

@@ -7,6 +7,9 @@ export type RecordCardLink = import('../card-view/record-card.js').RecordCardLin
 export type RecordCardAction = import('../card-view/record-card.js').RecordCardAction;
 export type MenuItem = import('../menu-button/menu-button.js').MenuItem;
 export type KanbanRule = import('./kanban-policy.js').KanbanRule;
+export type KanbanIndicator = import('./kanban-card.js').KanbanIndicator;
+export type KanbanIndicatorSource = string | KanbanIndicator | ((record: KanbanRecord, index: number) => KanbanIndicator | Node | unknown) | null;
+export type KanbanAssignee = import('./kanban-card.js').KanbanAssignee;
 export type KanbanRejectReason = import('./kanban-policy.js').KanbanRejectReason;
 export type KanbanMoveEvaluation = import('./kanban-policy.js').KanbanMoveEvaluation;
 export type KanbanAccessor = string | ((record: KanbanRecord, index: number) => unknown) | null;
@@ -253,6 +256,10 @@ export type KanbanViewOptions = {
      * Shared selection mode.
      */
     selectable?: false | 'single' | 'multi';
+    /**
+     * Select through a checkbox or the non-interactive card surface.
+     */
+    selectionTrigger?: 'checkbox' | 'card';
     /**
      * Initial record ids.
      */
@@ -266,9 +273,10 @@ export type KanbanViewOptions = {
      */
     hiddenFields?: string[];
     /**
-     * Show shared field controls.
+     * Show shared field controls. Redeclared narrower than `RecordViewOptions` it fails declaration
+     * emit, because the two option types are intersected.
      */
-    fieldControls?: boolean;
+    fieldControls?: boolean | import('../view/record-view.js').ViewFieldControlsConfig;
     /**
      * Empty-board content.
      */
@@ -322,6 +330,54 @@ export type KanbanViewOptions = {
      * pointer drag. Touch drags from the card body require a long press so the board still scrolls.
      */
     dragFrom?: 'card' | 'handle';
+    /**
+     * Move-handle presentation. `keyboard`
+     * keeps it announced and tabbable but out of sight until it takes focus, because the card itself
+     * is already the pointer drag source; `always` shows it alongside the card's other controls.
+     * `dragFrom:'handle'` overrides this — a drag source a pointer user cannot see is not a control.
+     */
+    moveHandle?: 'keyboard' | 'always';
+    /**
+     * Icon
+     * naming what the record is, drawn before the identifier.
+     */
+    entityIcon?: string | ((record: KanbanRecord, index: number) => string | null) | null;
+    /**
+     * Stable record key shown on the card head.
+     */
+    identifier?: KanbanCardField;
+    /**
+     * Status indicator source.
+     */
+    status?: KanbanIndicatorSource;
+    /**
+     * Maps a status value to a semantic tone.
+     */
+    statusTones?: Record<string, string>;
+    /**
+     * Priority indicator source.
+     */
+    priority?: KanbanIndicatorSource;
+    /**
+     * Maps a priority value to a semantic tone.
+     */
+    priorityTones?: Record<string, string>;
+    /**
+     * Completion source; a number or `{value,max,label}`.
+     */
+    progress?: KanbanCardField;
+    /**
+     * Amount that counts as finished.
+     */
+    progressMax?: number;
+    /**
+     * Responsible people; a name, a list, or descriptors.
+     */
+    assignees?: KanbanCardField;
+    /**
+     * Faces drawn before the overflow chip.
+     */
+    maxAvatars?: number;
     /**
      * Move the whole selection when a selected card is picked up.
      */
@@ -380,7 +436,10 @@ export type KanbanViewOptions = {
      */
     contextMenu?: boolean | MenuItem[] | ((context: KanbanCardContext) => MenuItem[]);
     /**
-     * Replaces card content.
+     * Replaces the
+     * shared record-card content — eyebrow, titles, and metadata. The preview, selection control,
+     * action group, move handle, rule badges, and any configured card head and footer still render,
+     * because each of those answers to its own option; clear those options to remove them.
      */
     renderCard?: ((context: KanbanCardContext) => Node | null | undefined) | null;
     /**
@@ -472,6 +531,41 @@ export type KanbanKeyboardMove = {
     from: KanbanMovePoint;
     to: KanbanMovePoint;
 };
+export type KanbanCardReader = ((record: KanbanRecord, index: number) => unknown) | null;
+export type KanbanCardSources = {
+    /**
+     * Record-key reader.
+     */
+    identifier: KanbanCardReader;
+    /**
+     * Status reader.
+     */
+    status: KanbanCardReader;
+    /**
+     * Priority reader.
+     */
+    priority: KanbanCardReader;
+    /**
+     * Completion reader.
+     */
+    progress: KanbanCardReader;
+    /**
+     * Responsible-people reader.
+     */
+    assignees: KanbanCardReader;
+    /**
+     * Entity-icon reader.
+     */
+    entityIcon: KanbanCardReader;
+    /**
+     * Field ids the anatomy consumes.
+     */
+    fieldIds: Set<string>;
+    /**
+     * Whether any source is configured.
+     */
+    any: boolean;
+};
 /**
  * Every user-visible and announced string, so a host can translate the board without patching it.
  * Values run through `printf`, so named placeholders may be reordered or dropped by a translation.
@@ -497,7 +591,14 @@ declare const DEFAULT_LABELS: Readonly<{
     countLimit: "%count% records, work-in-progress limit %limit%";
     countLimitInLane: "%count% records in this lane, %total% of work-in-progress limit %limit% in the column";
     empty: "No records";
-    columnEmpty: "";
+    columnEmpty: "Drop a card here";
+    identifier: "Record";
+    priorityLabel: "Priority";
+    statusLabel: "Status";
+    progress: "Progress";
+    progressValue: "%percent%%";
+    assignees: "Assigned to %names%";
+    assigneeOverflow: "+%count%";
     selected: "Selected";
     notSelected: "Not selected";
     noMatches: "No cards match the current search.";
@@ -526,6 +627,11 @@ declare const DEFAULT_LABELS: Readonly<{
     dragPreview: "%count% cards";
 }>;
 /**
+ * A field consumed by the card head or footer — the `identifier`, `status`, `priority`,
+ * `progress`, or `assignees` source — is dropped from the shared metadata list so the same value
+ * is never shown twice. `field.duplicate === true` opts it back in, extending the rule the shared
+ * record card already applies to title and subtitle fields.
+ *
  * Configurable record board with semantic columns, optional swim lanes, and equivalent pointer,
  * touch, keyboard, context-menu, and programmatic movement. Local moves clone records; callback
  * grouping remains fully usable for display and external moves but cannot be written safely by
@@ -611,6 +717,15 @@ export declare class KanbanView extends RecordView {
     _sectionMeta: WeakMap<object, any>;
     _cardsById: Map<any, any>;
     _visibleIds: Set<any>;
+    _cardSources: KanbanCardSources;
+    _fieldIndex: Map<string, any> | Map<string, import("../view/record-view.js").ViewField>;
+    _cardFields: {
+        all: any[];
+        metadata: any[];
+    } | {
+        all: import("../view/record-view.js").ViewField[];
+        metadata: import("../view/record-view.js").ViewField[];
+    };
     _kanbanMenu: ContextMenu;
     _searchInput: HTMLInputElement;
     _undoButton: HTMLButtonElement;
@@ -820,6 +935,49 @@ export declare class KanbanView extends RecordView {
     }[], hasLanes: boolean): HTMLElement;
     /** @param {KanbanRecord} record @param {number} index @param {string} column @param {string|null} lane @param {boolean} hasLanes @returns {HTMLLIElement} */
     _renderCard(record: KanbanRecord, index: number, column: string, lane: string | null, hasLanes: boolean): HTMLLIElement;
+    /**
+     * Builds the two field arrays every card needs, once per refresh.
+     * @returns {{all:import('../view/record-view.js').ViewField[],metadata:import('../view/record-view.js').ViewField[]}}
+     */
+    _resolvedCardFields(): {
+        all: import('../view/record-view.js').ViewField[];
+        metadata: import('../view/record-view.js').ViewField[];
+    };
+    /**
+     * Returns the fields the shared metadata list may show. A field the card head or footer already
+     * projects is dropped, because repeating it as a labelled row is the same value twice; a field
+     * marked `duplicate` opts back in, matching how title and subtitle already behave.
+     * @returns {import('../view/record-view.js').ViewField[]} Metadata fields.
+     */
+    _cardMetadataFields(): import('../view/record-view.js').ViewField[];
+    /**
+     * Resolves the card-anatomy readers once per refresh. A field id would otherwise be looked up
+     * through `getFields()` — which clones every descriptor — once per source per card, so a board
+     * with six anatomy sources rebuilt the whole field array six times for every card it drew.
+     * @returns {void}
+     */
+    _resolveCardSources(): void;
+    /**
+     * Adds the two Kanban-owned regions that bracket the shared record-card anatomy: a head naming
+     * what the record is and how urgent it is, and a footer carrying completion and the people
+     * responsible. Each part is omitted when its option is unset, so a board that configures none of
+     * them renders exactly the card it rendered before.
+     * @param {HTMLElement} card Card element.
+     * @param {KanbanRecord} record Record.
+     * @param {number} index Display index.
+     * @returns {void}
+     */
+    _applyCardAnatomy(card: HTMLElement, record: KanbanRecord, index: number): void;
+    /**
+     * Resolves one indicator from an already-resolved reader. A reader may return a ready-made
+     * `Node`, which is adopted rather than described, so an application keeps full control.
+     * @param {((record:KanbanRecord,index:number)=>unknown)|null} source Resolved reader.
+     * @param {unknown} tones Value-to-tone map.
+     * @param {KanbanRecord} record Record.
+     * @param {number} index Display index.
+     * @returns {KanbanIndicator|Node|null} Indicator, node, or null.
+     */
+    _cardIndicator(source: ((record: KanbanRecord, index: number) => unknown) | null, tones: unknown, record: KanbanRecord, index: number): KanbanIndicator | Node | null;
     /**
      * Hands card content to `renderCard` while keeping the managed shell: the list item, its
      * selection control, the action group, and the move handle are never given away, because they
@@ -876,6 +1034,14 @@ export declare class KanbanView extends RecordView {
     _resolvedSwimlanes(): KanbanSwimlane[];
     /** @param {KanbanAccessor} accessor @param {KanbanRecord} record @param {number} index @returns {unknown} */
     _readAxis(accessor: KanbanAccessor, record: KanbanRecord, index: number): unknown;
+    /**
+     * Resolves one field descriptor by id through a per-refresh index. `getFields()` rebuilds a Map
+     * and clones every descriptor on each call, and a string column or lane accessor is read once
+     * per record per column per lane — which made this the most expensive line in a board render.
+     * @param {string} id Field id.
+     * @returns {import('../view/record-view.js').ViewField|undefined} Descriptor, if any.
+     */
+    _axisField(id: string): import('../view/record-view.js').ViewField | undefined;
     /** @param {string} column @param {string|null} lane @returns {{record:KanbanRecord,index:number}[]} */
     _recordsIn(column: string, lane: string | null): {
         record: KanbanRecord;