rei-kit 0.19.0 → 0.20.0

package/dist/components/BaseTable.vue.d.ts

@@ -0,0 +1,44 @@
+export interface Column<Row> {
+    /** Key into the row, and the slot name for a custom cell. */
+    key: string & keyof Row;
+    /** Column heading. Already translated. */
+    label: string;
+    /** `end` for money and counts, which are read by their last digit. */
+    align?: 'start' | 'end' | undefined;
+    /** Stops a column wrapping — dates, short codes. */
+    nowrap?: boolean | undefined;
+}
+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 Column<Row>[];
+        rows: readonly Row[];
+        /** What this table is. Required — an unnamed table is a box of numbers. */
+        caption: string;
+        /** Keeps the caption for assistive tech when the page already shows a heading. */
+        captionHidden?: boolean | undefined;
+        /** Which field identifies a row. Falls back to the index. */
+        rowKey?: (string & keyof Row) | undefined;
+    }> & (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: {};
+}>) => 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/components/EmptyState.vue.d.ts

@@ -1,3 +1,11 @@
+/**
+ * A list with nothing in it yet, said kindly.
+ *
+ * A blank area reads as a page that failed to load, and the reader's first
+ * thought is that something is broken rather than that they have not started.
+ * So there is always a sentence, and the slot below it is where the way out
+ * goes — the button that creates the first one.
+ */
 type __VLS_Props = {
     title: string;
     description?: string | undefined;

package/dist/components/PageHeader.vue.d.ts

@@ -1,3 +1,12 @@
+/**
+ * The bar at the top of a screen: a title with room either side of it.
+ *
+ * Three fixed columns rather than a flex row, so the title is centred on the
+ * screen rather than centred on what is left after the buttons. A back arrow on
+ * one side and nothing on the other would otherwise push every title off centre
+ * by exactly half a button, which is visible the moment two screens sit next to
+ * each other.
+ */
 type __VLS_Props = {
     title: string;
 };

package/dist/components/SettingsGroup.vue.d.ts

@@ -1,3 +1,10 @@
+/**
+ * A titled run of settings rows.
+ *
+ * The heading is a real `h2` rather than styled text, because a settings screen
+ * is long and the headings are how somebody moves through it without reading
+ * all of it. Uppercase and quiet in the design, structural in the markup.
+ */
 type __VLS_Props = {
     title: string;
 };

package/dist/components/StatCard.vue.d.ts

@@ -1,3 +1,12 @@
+/**
+ * One number, with what it means and which way it is going.
+ *
+ * The trend is an arrow and a colour, and neither is allowed to be the whole
+ * message: the direction is also in the arrow's shape, so it survives a reader
+ * who cannot separate the kit's positive and negative hues. `null` is a real
+ * state rather than a missing one — a figure with no comparison yet is not a
+ * flat figure.
+ */
 type __VLS_Props = {
     value: string;
     label: string;

package/dist/index.d.ts

@@ -51,11 +51,16 @@ export { default as BaseInput } from './components/BaseInput.vue';
 export { default as BaseMenu } from './components/BaseMenu.vue';
 export { default as BaseSheet } from './components/BaseSheet.vue';
 export { default as BaseCard } from './components/BaseCard.vue';
+export { default as BaseCombobox } from './components/BaseCombobox.vue';
+export type { ComboboxOption } from './components/BaseCombobox.vue';
 export { default as BaseCheckbox } from './components/BaseCheckbox.vue';
 export { default as BaseRadioGroup } from './components/BaseRadioGroup.vue';
 export { default as BaseSelect } from './components/BaseSelect.vue';
+export { default as BaseSlider } from './components/BaseSlider.vue';
 export { default as BaseSpinner } from './components/BaseSpinner.vue';
 export { default as BaseSwitch } from './components/BaseSwitch.vue';
+export { default as BaseTable } from './components/BaseTable.vue';
+export type { Column } from './components/BaseTable.vue';
 export { default as BaseTextarea } from './components/BaseTextarea.vue';
 export { default as EmptyState } from './components/EmptyState.vue';
 export { default as FormField } from './components/FormField.vue';