@nxgt/material 3.91.0 → 3.92.0

package/dist/lib/components/ui/media/file-list/file-list-describe.d.ts

@@ -0,0 +1,8 @@
+import { NetworkUploadDisplayItem } from '../upload/network-upload-field/network-upload-item.js';
+import { FileDescription } from './types.js';
+/**
+ * The committed rows, named, sized and typed by `describe`; uploads are left
+ * alone. A described `href` that is not safe to link (`javascript:` …) is
+ * `null`, and the row then has no Download link.
+ */
+export declare function describeItems(items: NetworkUploadDisplayItem[], describe?: (value: string) => FileDescription | null | undefined): NetworkUploadDisplayItem[];

package/dist/lib/components/ui/media/file-list/file-list-field-row.d.ts

@@ -1,4 +1,5 @@
 import { NetworkUploadDisplayItem } from '../upload/network-upload-field/network-upload-item.js';
+import { FileListReorder } from './use-file-list-move.js';
 export type FileListFieldRowProps = {
     item: NetworkUploadDisplayItem;
     accept?: string;
@@ -6,5 +7,7 @@ export type FileListFieldRowProps = {
     onReplace: (item: NetworkUploadDisplayItem, file: File) => void;
     onRetry: (item: NetworkUploadDisplayItem) => void;
     onRemove: (item: NetworkUploadDisplayItem) => void;
+    /** Present when the field is reorderable. */
+    reorder?: FileListReorder;
 };
-export declare function FileListFieldRow({ item, accept, disabled, onReplace, onRetry, onRemove, }: FileListFieldRowProps): import("react").JSX.Element;
+export declare function FileListFieldRow({ item, accept, disabled, onReplace, onRetry, onRemove, reorder, }: FileListFieldRowProps): import("react").JSX.Element;

package/dist/lib/components/ui/media/file-list/file-list-field.d.ts

@@ -1,5 +1,6 @@
 import { ReactNode } from 'react';
 import { NetworkUploadFieldProps } from '../upload/network-upload-field/network-upload-field.js';
+import { FileDescription } from './types.js';
 type MultipleUploadProps = Extract<NetworkUploadFieldProps, {
     mode: 'multiple';
 }>;
@@ -7,6 +8,18 @@ export type FileListFieldProps = Omit<MultipleUploadProps, 'mode' | 'value'> & {
     value?: string[];
     required?: boolean;
     empty?: ReactNode;
+    /**
+     * Describes a kept value (an id, a key) so its row shows a name, a size
+     * and a type instead of the value: `describe={(id) => files[id]}`. Return
+     * `undefined` for a value you know nothing about. Called on every render,
+     * so keep it pure and cheap.
+     */
+    describe?: (value: string) => FileDescription | null | undefined;
+    /**
+     * Lets the user reorder the kept files with move up / move down buttons
+     * (reachable by keyboard); `onValueChange` receives the new order.
+     */
+    reorderable?: boolean;
 };
 export declare function FileListField(props: FileListFieldProps): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/media/file-list/index.d.ts

@@ -7,4 +7,4 @@ export * from './file-list-form-field.js';
 export type { FileListS3FieldProps } from './file-list-s3-field.js';
 export { FileListS3Field } from './file-list-s3-field.js';
 export * from './file-list-s3-form-field.js';
-export type { FileListItem } from './types.js';
+export type { FileDescription, FileListItem } from './types.js';

package/dist/lib/components/ui/media/file-list/partials/file-list-items.d.ts

@@ -1,14 +1,18 @@
 import { ReactNode } from 'react';
 import { NetworkUploadDisplayItem } from '../../upload/network-upload-field/network-upload-item.js';
+import { FileListReorder } from '../use-file-list-move.js';
 type Props = {
     items: NetworkUploadDisplayItem[];
     accept?: string;
     disabled?: boolean;
     empty?: ReactNode;
+    reorder?: FileListReorder;
+    /** Receives the list, so the focus can be put back after a move. */
+    listRef?: (node: HTMLUListElement | null) => void;
     onReplace: (item: NetworkUploadDisplayItem, file: File) => void;
     onRetry: (item: NetworkUploadDisplayItem) => void;
     onRemove: (item: NetworkUploadDisplayItem) => void;
 };
 /** The field's rows, or its empty message. */
-export declare function FileListItems({ items, empty, ...row }: Props): import("react").JSX.Element;
+export declare function FileListItems({ items, empty, reorder, listRef, ...row }: Props): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/media/file-list/partials/file-list-move-buttons.d.ts

@@ -0,0 +1,9 @@
+import { NetworkUploadDisplayItem } from '../../upload/network-upload-field/network-upload-item.js';
+import { FileListReorder } from '../use-file-list-move.js';
+type Props = {
+    item: NetworkUploadDisplayItem;
+    reorder: FileListReorder;
+};
+/** A kept row's move up / move down buttons, disabled where it cannot move. */
+export declare function FileListMoveButtons({ item, reorder }: Props): import("react").JSX.Element;
+export {};

package/dist/lib/components/ui/media/file-list/partials/file-list-row-actions.d.ts

@@ -1,4 +1,5 @@
 import { NetworkUploadDisplayItem } from '../../upload/network-upload-field/network-upload-item.js';
+import { FileListReorder } from '../use-file-list-move.js';
 type Props = {
     item: NetworkUploadDisplayItem;
     accept?: string;
@@ -6,7 +7,8 @@ type Props = {
     onReplace: (item: NetworkUploadDisplayItem, file: File) => void;
     onRetry: (item: NetworkUploadDisplayItem) => void;
     onRemove: (item: NetworkUploadDisplayItem) => void;
+    reorder?: FileListReorder;
 };
 /** A row's trailing buttons: retry, download, replace (with its hidden input) and remove. */
-export declare function FileListRowActions({ item, accept, disabled, onReplace, onRetry, onRemove, }: Props): import("react").JSX.Element;
+export declare function FileListRowActions({ item, accept, disabled, onReplace, onRetry, onRemove, reorder, }: Props): import("react").JSX.Element;
 export {};

package/dist/lib/components/ui/media/file-list/types.d.ts

@@ -15,3 +15,12 @@ export type FileListProps = {
     className?: string;
     'aria-label'?: string;
 };
+/** What a file list field can show of a value it holds: only the value is stored. */
+export type FileDescription = {
+    name?: string;
+    size?: number;
+    /** MIME type; an `image/*` type gets an image icon. */
+    type?: string;
+    /** Download link, when the value is not itself a URL. */
+    href?: string;
+};

package/dist/lib/components/ui/media/file-list/use-file-list-field.d.ts

@@ -1,6 +1,6 @@
 import { FileListFieldProps } from './file-list-field.js';
 /** The ids, the accessible group and the upload state behind a file list field. */
-export declare function useFileListField({ required, value, className: _className, empty: _empty, ...props }: FileListFieldProps): {
+export declare function useFileListField({ required, value, className: _className, empty: _empty, describe, reorderable, ...props }: FileListFieldProps): {
     inputId: string;
     inputRef: import('react').RefObject<HTMLInputElement | null>;
     helperId: string;
@@ -30,4 +30,10 @@ export declare function useFileListField({ required, value, className: _classNam
         handleItemRetry: (item: import('../upload/network-upload-field/network-upload-item.js').NetworkUploadDisplayItem) => void;
         handleItemRemove: (item: import('../upload/network-upload-field/network-upload-item.js').NetworkUploadDisplayItem) => void;
     };
+    displayItems: import('../upload/network-upload-field/network-upload-item.js').NetworkUploadDisplayItem[];
+    move: {
+        setRoot: (node: Element | null) => void;
+        message: string;
+        reorder: import('./use-file-list-move.js').FileListReorder | undefined;
+    };
 };

package/dist/lib/components/ui/media/file-list/use-file-list-move.d.ts

@@ -0,0 +1,24 @@
+import { RowMoveDirection } from '@nxgt/material-core/repeatable-group';
+import { NetworkUploadDisplayItem } from '../upload/network-upload-field/network-upload-item.js';
+export type FileListReorder = {
+    disabled: boolean;
+    canMove: (item: NetworkUploadDisplayItem, direction: RowMoveDirection) => boolean;
+    onMove: (item: NetworkUploadDisplayItem, direction: RowMoveDirection) => void;
+};
+type Options = {
+    reorderable?: boolean;
+    disabled?: boolean;
+    kept: readonly string[] | undefined;
+    onValueChange?: (value: string[]) => void;
+};
+/**
+ * Reordering the kept files: which row can move where (the rules are
+ * `@nxgt/material-core`'s, shared with RepeatableGroup), the focus once the
+ * value changed, and what the polite live region says.
+ */
+export declare function useFileListMove({ reorderable, disabled, kept, onValueChange, }: Options): {
+    setRoot: (node: Element | null) => void;
+    message: string;
+    reorder: FileListReorder | undefined;
+};
+export {};

package/dist/lib/components/ui/media/upload/network-upload-field/network-upload-item.d.ts

@@ -4,6 +4,13 @@ export type NetworkUploadDisplayItem = {
     id: string;
     name: string;
     size?: number;
+    /** MIME type of a committed value, when the host described it. */
+    type?: string;
+    /**
+     * Download link of a committed value: the value itself when `undefined`,
+     * none when `null` (described with a link that is not safe).
+     */
+    href?: string | null;
     status: NetworkUploadItemStatus;
     progress?: number;
     file?: File;

package/dist/lib/components/ui/widgets/editor/extensions/marks/compact-mark-buttons.d.ts

@@ -1,5 +1,9 @@
 import { Editor } from '@tiptap/react';
-/** Bold, italic and strikethrough: the marks of a comment or a chat message. */
+/**
+ * Bold, italic and strikethrough: the marks of a comment or a chat message.
+ * The strikethrough button is left out when the schema has no `strike` mark
+ * (`marks({ strike: false })`, or a starter kit configured with `strike: false`).
+ */
 export declare function CompactMarkButtons({ editor }: {
     editor: Editor;
 }): import("react").JSX.Element;

package/dist/lib/components/ui/widgets/editor/kit/editor-features.d.ts

@@ -74,8 +74,9 @@ export declare const editorFeatures: {
     readonly markdownPaste: () => import('./types.js').EditorFeature & {
         key: string;
     };
-    readonly marks: ({ compact }?: {
+    readonly marks: ({ compact, strike, }?: {
         compact?: boolean;
+        strike?: boolean;
     }) => import('./types.js').EditorFeature & {
         key: string;
     };

package/dist/lib/components/ui/widgets/editor/kit/features/marks.d.ts

@@ -1,9 +1,14 @@
 /**
  * `compact` keeps the content's marks but shows only bold, italic and
  * strikethrough in the toolbar and bubble menu (comments, chat).
+ * `strike` (default `true`, compact and full editors alike) set to `false`
+ * leaves strikethrough out: no mark, no button, and no `~~` written to
+ * Markdown. Pasted or loaded Markdown with `~~x~~` does not throw: it reads as
+ * the plain text `x`, the markers dropped.
  */
-export declare const marks: ({ compact }?: {
+export declare const marks: ({ compact, strike, }?: {
     compact?: boolean;
+    strike?: boolean;
 }) => import('../types.js').EditorFeature & {
     key: string;
 };

package/dist/lib/i18n/resources/en/en.d.ts

@@ -1336,6 +1336,9 @@ export declare const en: {
             remove: string;
             replace: string;
             retry: string;
+            "move-up": string;
+            "move-down": string;
+            moved: string;
         };
         "inline-edit": {
             edit: string;

package/dist/lib/i18n/resources/en/material.json.d.ts

@@ -1325,7 +1325,10 @@ declare const _default: {
 		"download": "Download",
 		"remove": "Remove",
 		"replace": "Replace",
-		"retry": "Retry"
+		"retry": "Retry",
+		"move-up": "Move {name} up",
+		"move-down": "Move {name} down",
+		"moved": "Moved {name} to position {to}"
 	},
 	"inline-edit": {
 		"edit": "Edit",

package/dist/lib/i18n/resources/fr/fr.d.ts

@@ -1336,6 +1336,9 @@ export declare const fr: {
             remove: string;
             replace: string;
             retry: string;
+            "move-up": string;
+            "move-down": string;
+            moved: string;
         };
         "inline-edit": {
             edit: string;

package/dist/lib/i18n/resources/fr/material.json.d.ts

@@ -1325,7 +1325,10 @@ declare const _default: {
 		"download": "Télécharger",
 		"remove": "Retirer",
 		"replace": "Remplacer",
-		"retry": "Réessayer"
+		"retry": "Réessayer",
+		"move-up": "Monter {name}",
+		"move-down": "Descendre {name}",
+		"moved": "{name} déplacé en position {to}"
 	},
 	"inline-edit": {
 		"edit": "Modifier",

package/dist/lib/i18n/resources/resources.d.ts

@@ -1334,6 +1334,9 @@ export declare const resources: {
                 remove: string;
                 replace: string;
                 retry: string;
+                "move-up": string;
+                "move-down": string;
+                moved: string;
             };
             "inline-edit": {
                 edit: string;
@@ -4883,6 +4886,9 @@ export declare const resources: {
                 remove: string;
                 replace: string;
                 retry: string;
+                "move-up": string;
+                "move-down": string;
+                moved: string;
             };
             "inline-edit": {
                 edit: string;