@danxbot/ui 20.12.2 → 20.13.0

package/dist/types/components/Board.d.ts

@@ -1,9 +1,16 @@
 import { type ReactNode } from "react";
 import type { AutoScrollOptions, DragStrings } from "../lib/dnd";
 import type { BoardColumnModel, BoardItemId, UseBoardOptions, UseBoardResult } from "../lib/board";
+import { type BoardReorderLabels } from "./board/context";
 export interface BoardProps<T> extends UseBoardOptions<T> {
     /** Forwarded to `DragDrop` — announcement grammar, localisation. */
     strings?: Partial<DragStrings>;
+    /**
+     * DX-4575: the words for each card menu's two within-column items. Partial,
+     * so a consumer renames one and keeps the other. Omitted, "Move to top" and
+     * "Move to bottom".
+     */
+    reorderLabels?: Partial<BoardReorderLabels>;
     /** Forwarded to `DragDrop` — see its own doc; cannot be turned off. */
     autoScroll?: AutoScrollOptions;
     className?: string;
@@ -42,7 +49,7 @@ export interface BoardProps<T> extends UseBoardOptions<T> {
      *  returns. */
     children: (board: UseBoardResult<T>) => ReactNode;
 }
-export declare function Board<T>({ items, columns, accessors, validateMove, onMove, selection, strings, autoScroll, className, columnsClassName, renderDragging, children, }: BoardProps<T>): import("react").JSX.Element;
+export declare function Board<T>({ items, columns, accessors, validateMove, onMove, selection, strings, reorderLabels, autoScroll, className, columnsClassName, renderDragging, children, }: BoardProps<T>): import("react").JSX.Element;
 export interface BoardCardSurfaceProps {
     className?: string;
     children?: ReactNode;

package/dist/types/components/board/context.d.ts

@@ -21,7 +21,16 @@ export interface BoardContextValue<T> {
      * convention.
      */
     requestMove: (request: BoardMoveRequest) => BoardMoveVerdict;
+    /** The words for the card menu's within-column items (`Board`'s `reorderLabels`). */
+    reorderLabels: BoardReorderLabels;
 }
+/** The card menu's within-column items. DX-4575: a consumer that calls moving inside a list something else renames them. */
+export interface BoardReorderLabels {
+    toTop: string;
+    toBottom: string;
+}
+/** What the menu says when `Board` is given no `reorderLabels`. */
+export declare const DEFAULT_REORDER_LABELS: BoardReorderLabels;
 export interface BoardColumnContextValue {
     columnId: BoardColumnId;
     label: string;

package/dist/types/components/board/recipe.d.ts

@@ -27,6 +27,7 @@ export declare const board: import("tailwind-variants").TVReturnType<{
     empty: string;
     handleCluster: string;
     menuTrigger: string[];
+    reorderLocked: string[];
     rejection: string[];
 }, undefined, {
     overWip: {
@@ -57,6 +58,7 @@ export declare const board: import("tailwind-variants").TVReturnType<{
     empty: string;
     handleCluster: string;
     menuTrigger: string[];
+    reorderLocked: string[];
     rejection: string[];
 }, import("tailwind-variants").TVReturnTypeLike<{
     overWip: {
@@ -87,5 +89,6 @@ export declare const board: import("tailwind-variants").TVReturnType<{
     empty: string;
     handleCluster: string;
     menuTrigger: string[];
+    reorderLocked: string[];
     rejection: string[];
 }>>;

package/dist/types/index.d.ts

@@ -113,6 +113,7 @@ export { DragDrop, DragDropContainer, DragDropItem, DragDropHandle, DragDropSurf
 export { KanbanBoard, type KanbanBoardProps, type KanbanLane, type KanbanMove, type KanbanRefusal, } from "./components/kanban/KanbanBoard";
 export { DEFAULT_DRAG_STRINGS, DRAG_INSTRUCTIONS_ID, DragInstructions, DragLiveRegion, DragSession, DragSessionProvider, applyMove, attachAutoScroll, attachKeyboardSensor, attachPointerSensor, attachSessionWindowListeners, isNoOp, resolveTarget, sameTarget, scrollVelocity, useCreateDragSession, useDragAnnouncements, useDragSession, useDragState, useDragLive, useDraggable, useDropContainer, type ContainerId, type DragAxis, type DragCancelEvent, type DragEndEvent, type DragId, type DragMode, type DragPhase, type DragSessionCallbacks, type DragStartEvent, type DragState, type AutoScrollOptions, type DragAnnouncementContext, type DragAnnouncementOptions, type DragAnnouncements, type DragInstructionsProps, type DragLiveRegionProps, type DragStrings, type DropTarget, type KeyboardSensorOptions, type PointerActivation, } from "./lib/dnd";
 export { Board, BoardColumn, BoardCard, BoardCardSurface, type BoardProps, type BoardColumnProps, type BoardCardProps, type BoardCardSurfaceProps, } from "./components/Board";
+export type { BoardReorderLabels } from "./components/board/context";
 export { buildBoardModel, resolveMove, applyBoardMoves, useBoard, moveAnchor, columnLength, positionInColumn, type BoardModel, type MoveAnchor, type UseBoardResult, } from "./lib/board";
 export type { BoardAccessors, BoardColumnDef, BoardEdge, BoardColumnId, BoardColumnModel, BoardItemId, BoardMove, BoardMoveRequest, BoardMoveSource, BoardMoveVerdict, UseBoardOptions, } from "./lib/board";
 export { PagedWindowList, type PagedWindowItemPosition, type PagedWindowListProps, type PagedWindowStrings, } from "./components/PagedWindowList";

package/dist/types/lib/board/types.d.ts

@@ -94,6 +94,16 @@ export interface BoardColumnDef {
      * of the column. @default 0
      */
     offset?: number;
+    /**
+     * DX-4575: turns OFF reordering inside this column, and is the sentence shown
+     * in it while a card from it is dragged over it. Moves to and from OTHER
+     * columns are untouched. Text, not a boolean: supplying it is what turns the
+     * rule on, and the consumer owns the words (a column sorted by something its
+     * order cannot express, say, would tell the person what to sort by first).
+     * Enforced in `resolveMove`, so the drag, the keyboard, the menu and a bulk
+     * move all obey it, and the menu stops offering the within-column items.
+     */
+    reorderLocked?: string;
 }
 /**
  * Where a move lands beyond what is loaded. In a windowed column `to.index` can
@@ -174,6 +184,8 @@ export interface BoardColumnModel<T> {
     wipLimit: number | undefined;
     /** `true` when `count` exceeds `wipLimit`. Always false with no limit set, and while `counting`. */
     overWip: boolean;
+    /** The definition's `reorderLocked` sentence; `undefined` when the column can be reordered. */
+    reorderLocked: string | undefined;
 }
 export interface UseBoardOptions<T> {
     items: readonly T[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "20.12.2",
+  "version": "20.13.0",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",