rei-kit 2.6.0 → 2.8.0

package/dist/web/CommandMenu.vue.d.ts

@@ -0,0 +1,50 @@
+import { Component } from 'vue';
+export interface CommandItem<Id extends string> {
+    id: Id;
+    /** Already translated. */
+    label: string;
+    /** A line under it, or a shortcut to show on the right. */
+    hint?: string | undefined;
+    icon?: Component | undefined;
+    /** Extra words that should find it — synonyms, the English name. */
+    keywords?: readonly string[] | undefined;
+}
+export interface CommandGroup<Id extends string> {
+    /** Already translated. Omitted, the items sit without a heading. */
+    label?: string | undefined;
+    items: readonly CommandItem<Id>[];
+}
+declare const __VLS_export: <Id extends string>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: import('vue').PublicProps & __VLS_PrettifyLocal<({
+        groups: readonly CommandGroup<Id>[];
+        /** The dialog's accessible name, e.g. "Commands". */
+        label: string;
+        /** The field's placeholder, e.g. "Type a command or search". */
+        placeholder: string;
+        /** Shown when nothing matches, e.g. "Nothing found". */
+        emptyLabel: string;
+        /** The letter that opens it with ⌘ or Ctrl. Unset, the app opens it itself. */
+        hotkey?: string | undefined;
+    } & {
+        /** Open or closed, with `v-model`. */
+        modelValue?: boolean;
+    }) & {
+        onSelect?: (id: Id) => any;
+        "onUpdate:modelValue"?: (value: boolean) => any;
+    }> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {};
+    emit: ((evt: "select", id: Id) => void) & ((event: "update:modelValue", value: boolean) => void);
+}>) => import('vue').VNode & {
+    __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
+};
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

package/dist/web/DataTable.vue.d.ts

@@ -0,0 +1,61 @@
+import { Column } from '../components/BaseTable.vue';
+export interface DataColumn<Row> extends Column<Row> {
+    /** Adds a button to the header that sorts by this column. */
+    sortable?: boolean | undefined;
+}
+export interface TableSort<Row> {
+    key: string & keyof Row;
+    direction: 'asc' | 'desc';
+}
+declare const __VLS_export: <Row extends 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_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: import('vue').PublicProps & __VLS_PrettifyLocal<({
+        columns: readonly DataColumn<Row>[];
+        rows: readonly Row[];
+        /** What this table is. Required — an unnamed table is a box of numbers. */
+        caption: string;
+        captionHidden?: boolean | undefined;
+        /** Which field identifies a row. Required for selection. */
+        rowKey?: (string & keyof Row) | undefined;
+        /** Given with `rowKey`, the table grows a checkbox column. Names the header one. */
+        selectAllLabel?: string | undefined;
+        /** Names each row's checkbox from the row: `(row) => \`Select ${row.name}\``. */
+        rowLabel?: ((row: Row) => string) | undefined;
+        /** Report the sort instead of doing it — for a server that pages the data. */
+        manualSort?: boolean | undefined;
+        /** Draws skeleton rows instead of the body. */
+        loading?: boolean | undefined;
+        loadingRows?: number | undefined;
+        /** Keeps the header on screen while the body scrolls under it. */
+        stickyHeader?: boolean | undefined;
+    } & {
+        /** Which column is sorted, and which way. `v-model:sort`. */
+        sort?: TableSort<Row> | undefined;
+        /** The chosen rows' keys. `v-model:selected`. */
+        selected?: string[];
+    }) & {
+        "onUpdate:sort"?: (value: TableSort<Row> | undefined) => any;
+        "onUpdate:selected"?: (value: string[]) => any;
+    }> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {
+        [key: string]: (props: {
+            row: Row;
+            value: unknown;
+        }) => unknown;
+        /** Shown instead of the body when there are no rows. */
+        empty?: () => unknown;
+    };
+    emit: ((event: "update:sort", value: TableSort<Row> | undefined) => void) & ((event: "update:selected", value: string[]) => void);
+}>) => import('vue').VNode & {
+    __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
+};
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

package/dist/web/index.d.ts

@@ -34,6 +34,19 @@ export { default as BaseDisclosure } from './BaseDisclosure.vue';
  */
 export { default as BaseModal } from './BaseModal.vue';
 export { default as BasePagination } from './BasePagination.vue';
+/**
+ * Everything the app can do, behind ⌘K. In the wide entry because it is a
+ * keyboard shortcut first: a phone has no ⌘, and an app that is only ever a
+ * phone should not download it.
+ */
+export { default as CommandMenu } from './CommandMenu.vue';
+export type { CommandGroup, CommandItem } from './CommandMenu.vue';
+/**
+ * `BaseTable` with a sort, a selection and a loading state. Wide because a
+ * table of nine columns is not a thing a phone shows; a phone shows a list.
+ */
+export { default as DataTable } from './DataTable.vue';
+export type { DataColumn, TableSort } from './DataTable.vue';
 export { default as BaseTabs } from './BaseTabs.vue';
 export type { TabPanel } from './BaseTabs.vue';
 export { default as BaseTooltip } from './BaseTooltip.vue';