@wssto2/vue-core 0.1.0 → 0.3.0

package/dist/collection/CollectionRows.vue.d.ts

@@ -0,0 +1,59 @@
+import { type RouteLocationRaw } from "vue-router";
+import { type Column, type RowAction } from "./columns";
+import type { CollectionDisplay } from "./useCollection";
+import type { SortDirection } from "./types";
+declare const _default: <Row extends object, Col extends Column<Row>>(__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 onSort?: ((key: string) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onSort"> & {
+        columns: readonly Col[];
+        rows: readonly Row[];
+        rowKey: (row: Row) => string | number;
+        display: CollectionDisplay;
+        /** Phone rows instead of a table (see `useRowLayout`). */
+        phone: boolean;
+        /** Where a click on the row goes; null for a row that is not a link. */
+        link: (row: Row) => RouteLocationRaw | null;
+        /** Text to mark in an identity cell. */
+        search?: string;
+        /** The sort the header shows; a header sorts (`sort`) only when the column has a `sort` key. */
+        sorted?: {
+            key: string;
+            direction: SortDirection;
+        } | null;
+        rowActions?: (row: Row) => RowAction[];
+        rowLabel?: (row: Row) => string;
+        /** Pixels. */
+        rowHeight?: number;
+        density?: "regular" | "condensed";
+        actionsVisible?: boolean;
+        skeletonRows: number;
+        /** Rows to reserve the height of while loading, so the card does not jump when they land. */
+        reserveRows?: number;
+        rowClass?: (row: Row) => string | undefined;
+    } & Partial<{}>> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: import("./slots").CellSlots<Row, Col> & {
+        leading?: ((scope: {
+            item: Row;
+            compact: boolean;
+        }) => unknown) | undefined;
+        actions?: ((scope: {
+            item: Row;
+        }) => unknown) | undefined;
+    } & {
+        toolbar?: () => unknown;
+        empty?: () => unknown;
+    } & {
+        /** What a failed load shows. */
+        failed?: () => unknown;
+    };
+    emit: (evt: "sort", key: string) => void;
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/collection/CollectionTable.vue.d.ts

@@ -1,4 +1,4 @@
-import { type Column, type RowAction } from "./columns";
+import type { Column, RowAction } from "./columns";
 import type { CollectionSlots } from "./slots";
 import type { Collection } from "./useCollection";
 declare const _default: <Row extends object, Col extends Column<Row>>(__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<{

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

@@ -0,0 +1,47 @@
+import type { RouteLocationRaw } from "vue-router";
+import type { Column, RowAction } from "./columns";
+declare const _default: <Row extends object, const Col extends Column<Row, never>>(__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<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, never> & {
+        rows: readonly Row[];
+        columns: readonly Col[];
+        rowKey: (row: Row) => string | number;
+        /** Skeleton rows instead of the rows (and instead of the empty state). */
+        loading?: boolean;
+        /** How many skeleton rows `loading` shows. */
+        skeletonRows?: number;
+        /** Where a row's record lives: the row opens it on click, and an identity column links to it. */
+        recordRoute?: (row: Row) => RouteLocationRaw;
+        /** Quick actions per row: swiped in on phones (links), and the row's context menu (long press, right click). */
+        rowActions?: (row: Row) => RowAction[];
+        /** The accessible name of a row's menu and More button, e.g. the record's name. */
+        rowLabel?: (row: Row) => string;
+        /** Pixels. */
+        rowHeight?: number;
+        density?: "regular" | "condensed";
+        /** The row's actions are the only way to perform them, so the More button shows in the row. */
+        actionsVisible?: boolean;
+        /** Extra classes for a row, e.g. to set apart a total or the newest row. */
+        rowClass?: (row: Row) => string | undefined;
+    } & Partial<{}>> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: import("./slots").CellSlots<Row, Col> & {
+        leading?: ((scope: {
+            item: Row;
+            compact: boolean;
+        }) => unknown) | undefined;
+        actions?: ((scope: {
+            item: Row;
+        }) => unknown) | undefined;
+    } & {
+        /** What shows when there are no rows; "No data" by default. */
+        empty?: () => unknown;
+    };
+    emit: {};
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/collection/RowActions.vue.d.ts

@@ -0,0 +1,19 @@
+import type { RowAction } from "./columns";
+/**
+ * The actions of a row as icon buttons in its actions cell: view, edit, delete, download. The same
+ * `RowAction[]` a table gives its swipe and context menu, so a row's actions are written once; the
+ * page builds the array from what the user may do (`access.can(...)`), so there is nothing to hide
+ * here. A link (`href`) is an anchor, a command (`onSelect`) a button; `critical` is red.
+ *
+ *   <template #actions="{ item }"><RowActions :actions="rowActions(item)" :disabled="item.locked" /></template>
+ *
+ * `disabled` greys out every button (a locked row); it does not hide them.
+ */
+type __VLS_Props = {
+    actions: readonly RowAction[];
+    disabled?: boolean;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    disabled: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/collection/columns.d.ts

@@ -84,6 +84,8 @@ export type Column<Row, Sort extends string = string> = ColumnCommon<Row, Sort>
  *   const columns = [{ key: "title", label: t("title"), kind: "identity", mobile: "primary" }] satisfies CollectionColumns<Ticket>;
  */
 export type CollectionColumns<Row, Sort extends string = string> = readonly Column<Row, Sort>[];
+/** The columns of a `DataTable`: the collection's, without a `sort` key (a table over an array keeps its order). */
+export type TableColumns<Row> = readonly Column<Row, never>[];
 /** A quick action of a row: swiped in on phones (links only) and listed in the row's context menu. */
 export interface RowAction {
     key: string;

package/dist/collection/http.d.ts

@@ -1,4 +1,4 @@
-import type { ApiResult, HttpClient, QueryValue } from "../client";
+import type { ApiResult, HttpClient, ListResult, QueryValue } from "../client";
 import type { CollectionLoader, ListPage, CollectionQuery } from "./types";
 /**
  * The query parameters go-core's datatable reads: `page`, `per_page`, `order_col`, `order_dir`,
@@ -8,9 +8,11 @@ export declare function listParams(query: CollectionQuery): Record<string, Query
 /**
  * Reads a list answer into a `ListPage`. Understands go-core's envelope (`data` is the rows,
  * `meta` has `total`, `page`, `per_page`, `last_page`, `from`, `to`, and may carry `views` and lookups)
- * and ARV's older shape with the numbers next to `data` (`current_page`). Missing numbers are derived
+ * and the shape with the numbers next to `data` (`current_page`), which is `ListResult<Row>`: pass a typed
+ * route's result (`client.request(route, input)`) and `Row` is inferred. Missing numbers are derived
  * from what is there rather than becoming 0; `query` supplies the page and size that were asked for.
  */
+export declare function readListPage<Row>(result: ApiResult<ListResult<Row>, unknown>, query: Pick<CollectionQuery, "page" | "pageSize">): ListPage<Row>;
 export declare function readListPage<Row>(result: ApiResult<unknown, unknown>, query: Pick<CollectionQuery, "page" | "pageSize">): ListPage<Row>;
 /**
  * The loader of a go-core list endpoint: the common case of a feature's `api.list`.

package/dist/collection/index.d.ts

@@ -5,7 +5,7 @@ export type { Collection, CollectionDisplay, LinkedQuery, SavedViewsHandle, UseC
 export type { CollectionLoader, ListPage, CollectionQuery, CollectionStateSource, LoadContext, SortDirection } from "./types";
 export { httpList, listParams, readListPage } from "./http";
 export { LIST_CONTEXT_PARAM } from "./location";
-export type { CollectionColumns, Column, ColumnKey, ColumnKind, ColumnValue, MobileRole, RowAction, SlotKey } from "./columns";
+export type { CollectionColumns, Column, ColumnKey, ColumnKind, ColumnValue, MobileRole, RowAction, SlotKey, TableColumns } from "./columns";
 export type { FilterDescriptor, FilterOption, ViewDescriptor } from "./filters";
 export { useCollectionNeighbors } from "./neighbors";
 export type { CollectionNeighbors, Neighbor, NeighborOptions } from "./neighbors";
@@ -14,6 +14,8 @@ export type { SavedView, SavedViews, SavedViewState } from "./savedViews";
 export { default as CollectionPage } from "./CollectionPage.vue";
 export { default as CollectionTable } from "./CollectionTable.vue";
 export { default as CollectionCell } from "./CollectionCell.vue";
+export { default as DataTable } from "./DataTable.vue";
+export { default as RowActions } from "./RowActions.vue";
 export { default as RecordIdentity } from "./RecordIdentity.vue";
 export { DATE_PRESETS, useDatePresetFilter } from "./datePresets";
-export type { CellSlots, CollectionSlots } from "./slots";
+export type { CellSlots, CollectionSlots, RowsSlots } from "./slots";