@webx-ui/core 0.18.0 → 0.19.0

package/dist/components/Repeater/Repeater.d.ts

@@ -0,0 +1,58 @@
+import { SortableMove } from '../SortableList/types';
+import { RepeaterProps } from './types';
+declare const _default: <T extends object = Record<string, unknown>>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
+        readonly "onUpdate:modelValue"?: ((value: T[]) => any) | undefined;
+        readonly onAdd?: ((item: T, index: number) => any) | undefined;
+        readonly onRemove?: ((item: T, index: number) => any) | undefined;
+        readonly onMove?: ((move: SortableMove<T>) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onUpdate:modelValue" | "onRemove" | "onMove" | "onAdd"> & ({
+        modelValue?: T[];
+    } & RepeaterProps<T>) & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: Readonly<{
+        /** Replaces the title. */
+        header?: () => unknown;
+        /** The end of the heading — whatever else the repeater can do. */
+        extra?: () => unknown;
+        /** The fields of one row. */
+        default?: (props: {
+            item: T;
+            index: number;
+            update: (patch: Partial<T>) => void;
+        }) => unknown;
+        /** Row actions, before the one that removes it. */
+        actions?: (props: {
+            item: T;
+            index: number;
+        }) => unknown;
+        /** Shown in place of an empty repeater. */
+        empty?: () => unknown;
+    }> & {
+        /** Replaces the title. */
+        header?: () => unknown;
+        /** The end of the heading — whatever else the repeater can do. */
+        extra?: () => unknown;
+        /** The fields of one row. */
+        default?: (props: {
+            item: T;
+            index: number;
+            update: (patch: Partial<T>) => void;
+        }) => unknown;
+        /** Row actions, before the one that removes it. */
+        actions?: (props: {
+            item: T;
+            index: number;
+        }) => unknown;
+        /** Shown in place of an empty repeater. */
+        empty?: () => unknown;
+    };
+    emit: (((evt: "add", item: T, index: number) => void) & ((evt: "remove", item: T, index: number) => void) & ((evt: "move", move: SortableMove<T>) => void)) & ((evt: "update:modelValue", value: T[]) => void);
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/Repeater/index.d.ts

@@ -0,0 +1,2 @@
+export { default as WxRepeater } from './Repeater';
+export type * from './types';

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

@@ -0,0 +1,48 @@
+import { SortableMove } from '../SortableList/types';
+export type RepeaterSize = 'sm' | 'md';
+/** One row of the model, plus the ways of writing it back. */
+export interface RepeaterItemSlot<T extends object> {
+    item: T;
+    index: number;
+    /** Replaces the item with a copy carrying these keys — the model stays immutable. */
+    update: (patch: Partial<T>) => void;
+}
+export interface RepeaterProps<T extends object = Record<string, unknown>> {
+    /** Heading above the rows. */
+    title?: string;
+    /**
+     * What a row is called in its header and to a screen reader: a key of the item, or a
+     * function. Falls back to the position.
+     */
+    itemLabel?: string | ((item: T, index: number) => string);
+    /** Builds what `Add` appends. Defaults to an empty object. */
+    newItem?: () => T;
+    addLabel?: string;
+    removeLabel?: string;
+    /** Rows fold to their header, so a long form stays readable. */
+    collapsible?: boolean;
+    /** Rows that were already there start folded. Implies `collapsible`. */
+    collapsed?: boolean;
+    /** Fewer rows than this cannot be removed. */
+    min?: number;
+    /** More rows than this cannot be added. */
+    max?: number;
+    /** Rows can be reordered. */
+    sortable?: boolean;
+    disabled?: boolean;
+    /** Shown when there is nothing yet. */
+    emptyText?: string;
+    size?: RepeaterSize;
+    /** Drops the frame, for a repeater that already sits in a card. */
+    plain?: boolean;
+    /** Accessible name for the list of rows. */
+    ariaLabel?: string;
+}
+export interface RepeaterEmits<T extends object = Record<string, unknown>> {
+    /** A row was appended. The model already holds it. */
+    add: [item: T, index: number];
+    /** A row was dropped. The model no longer holds it. */
+    remove: [item: T, index: number];
+    /** A row changed position. */
+    move: [move: SortableMove<T>];
+}

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

@@ -18,6 +18,12 @@ export interface SortableListProps<T = unknown> {
     handle?: 'grip' | 'row' | string;
     /** Field to key a row by, or a function. Falls back to the position. */
     itemKey?: string | ((item: T, index: number) => string | number);
+    /**
+     * What a row is called out loud — in the grip's name and in every move a keyboard
+     * announces: a field of the item, or a function. Falls back to its `title`, `name` or
+     * `label`, and to the position when it has none of those.
+     */
+    itemLabel?: string | ((item: T, index: number) => string);
     /** Lists that share a name pass rows between them. */
     group?: string;
     /** Nothing can be moved. */

package/dist/components/index.d.ts

@@ -64,6 +64,7 @@ export * from './Prose';
 export * from './Radio';
 export * from './RadioGroup';
 export * from './Rate';
+export * from './Repeater';
 export * from './Result';
 export * from './RichText';
 export * from './Row';