vueye-table 2.0.0-alpha.9 → 3.0.0-alpha.2

package/dist/index.d.ts

@@ -1 +1,671 @@
-export * from './components/index'
+import { CellChange, RowKey, TableIssue, TableRow, TableState } from "@vueye-table/core";
+import { GridCellSlotProps } from "@vueye-table/headless";
+import { Plugin, PropType, SlotsType, VNode } from "vue";
+export * from "@vueye-table/core";
+export * from "@vueye-table/headless";
+export * from "@vueye-table/styled";
+export * from "@vueye-table/vue";
+//#region src/plugin.d.ts
+/** Register `<VueyeTable>` and `<VueyeGrid>` globally. */
+declare const VueyeTablePlugin: Plugin;
+//#endregion
+//#region src/vueye-grid.d.ts
+/**
+ * An editable spreadsheet over an array. Cells are edited in place with the keyboard or a double
+ * click, ranges are selected with Shift or by dragging, and copy, cut, paste, clear, undo, and
+ * redo work like a spreadsheet application. Every edit produces a new array through
+ * `update:data`; the array passed in is never mutated.
+ */
+declare const VueyeGrid: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  searchable: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columnToggle: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  /** Page the grid. By default every row is on one page. */
+  pagination: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  /** Columns are editable unless their definition says otherwise. Set `false` to lock all. */
+  editable: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  rowNumbers: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columnLetters: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  label: {
+    type: StringConstructor;
+    default: string;
+  };
+  /** Show undo, redo, and CSV export buttons. */
+  toolbar: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columns: {
+    readonly type: PropType<readonly import("@vueye-table/core").AnyColumnDef[]>;
+    readonly default: undefined;
+  };
+  rowKey: {
+    readonly type: PropType<string | ((row: any, index: number) => import("@vueye-table/core").RowKey)>;
+    readonly default: undefined;
+  };
+  caption: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  loading: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  density: {
+    readonly type: PropType<import("@vueye-table/styled").Density>;
+    readonly default: "comfortable";
+  };
+  striped: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  bordered: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  hover: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  stickyHeader: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  theme: {
+    readonly type: PropType<"light" | "dark">;
+    readonly default: undefined;
+  };
+  maxHeight: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  searchPlaceholder: {
+    readonly type: StringConstructor;
+    readonly default: "Search…";
+  };
+  pageSizeOptions: {
+    readonly type: PropType<readonly number[]>;
+    readonly default: () => number[];
+  };
+  page: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  pageSize: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  sorting: {
+    readonly type: PropType<readonly import("@vueye-table/core").SortRule[]>;
+    readonly default: undefined;
+  };
+  search: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  filters: {
+    readonly type: PropType<Readonly<Record<string, unknown>>>;
+    readonly default: undefined;
+  };
+  hiddenColumns: {
+    readonly type: PropType<readonly string[]>;
+    readonly default: undefined;
+  };
+  selectScope: {
+    readonly type: PropType<import("@vueye-table/core").SelectScope>;
+    readonly default: "all";
+  };
+  data: {
+    type: PropType<readonly unknown[]>;
+    required: true;
+  };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  "update:page": null;
+  "update:pageSize": null;
+  "update:sorting": null;
+  "update:search": null;
+  "update:filters": null;
+  "update:hiddenColumns": null;
+  "update:selected": null;
+} & {
+  "state-change": (state: TableState) => boolean;
+  "update:data": (data: readonly unknown[]) => boolean;
+  edit: (changes: readonly CellChange<unknown>[]) => boolean;
+  "edit-error": (issues: readonly TableIssue[]) => boolean;
+  export: (csv: string) => boolean;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  searchable: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columnToggle: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  /** Page the grid. By default every row is on one page. */
+  pagination: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  /** Columns are editable unless their definition says otherwise. Set `false` to lock all. */
+  editable: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  rowNumbers: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columnLetters: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  label: {
+    type: StringConstructor;
+    default: string;
+  };
+  /** Show undo, redo, and CSV export buttons. */
+  toolbar: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  columns: {
+    readonly type: PropType<readonly import("@vueye-table/core").AnyColumnDef[]>;
+    readonly default: undefined;
+  };
+  rowKey: {
+    readonly type: PropType<string | ((row: any, index: number) => import("@vueye-table/core").RowKey)>;
+    readonly default: undefined;
+  };
+  caption: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  loading: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  density: {
+    readonly type: PropType<import("@vueye-table/styled").Density>;
+    readonly default: "comfortable";
+  };
+  striped: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  bordered: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  hover: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  stickyHeader: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  theme: {
+    readonly type: PropType<"light" | "dark">;
+    readonly default: undefined;
+  };
+  maxHeight: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  searchPlaceholder: {
+    readonly type: StringConstructor;
+    readonly default: "Search…";
+  };
+  pageSizeOptions: {
+    readonly type: PropType<readonly number[]>;
+    readonly default: () => number[];
+  };
+  page: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  pageSize: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  sorting: {
+    readonly type: PropType<readonly import("@vueye-table/core").SortRule[]>;
+    readonly default: undefined;
+  };
+  search: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  filters: {
+    readonly type: PropType<Readonly<Record<string, unknown>>>;
+    readonly default: undefined;
+  };
+  hiddenColumns: {
+    readonly type: PropType<readonly string[]>;
+    readonly default: undefined;
+  };
+  selectScope: {
+    readonly type: PropType<import("@vueye-table/core").SelectScope>;
+    readonly default: "all";
+  };
+  data: {
+    type: PropType<readonly unknown[]>;
+    required: true;
+  };
+}>> & Readonly<{
+  "onUpdate:page"?: (...args: any[]) => any;
+  "onUpdate:pageSize"?: (...args: any[]) => any;
+  "onUpdate:sorting"?: (...args: any[]) => any;
+  "onUpdate:search"?: (...args: any[]) => any;
+  "onUpdate:filters"?: (...args: any[]) => any;
+  "onUpdate:hiddenColumns"?: (...args: any[]) => any;
+  "onUpdate:selected"?: (...args: any[]) => any;
+  "onState-change"?: (state: TableState) => any;
+  onEdit?: (changes: readonly CellChange<unknown>[]) => any;
+  "onUpdate:data"?: (data: readonly unknown[]) => any;
+  "onEdit-error"?: (issues: readonly TableIssue[]) => any;
+  onExport?: (csv: string) => any;
+}>, {
+  page: number;
+  columns: readonly import("@vueye-table/core").AnyColumnDef[];
+  rowKey: string | ((row: any, index: number) => import("@vueye-table/core").RowKey);
+  caption: string;
+  loading: boolean;
+  density: import("@vueye-table/styled").Density;
+  striped: boolean;
+  bordered: boolean;
+  hover: boolean;
+  stickyHeader: boolean;
+  theme: "light" | "dark";
+  maxHeight: string;
+  searchable: boolean;
+  searchPlaceholder: string;
+  columnToggle: boolean;
+  pagination: boolean;
+  pageSizeOptions: readonly number[];
+  pageSize: number;
+  sorting: readonly import("@vueye-table/core").SortRule[];
+  search: string;
+  filters: Readonly<Record<string, unknown>>;
+  hiddenColumns: readonly string[];
+  selectScope: import("@vueye-table/core").SelectScope;
+  label: string;
+  toolbar: boolean;
+  editable: boolean;
+  rowNumbers: boolean;
+  columnLetters: boolean;
+}, SlotsType<{
+  [key: `cell.${string}`]: GridCellSlotProps & {
+    readonly item: unknown;
+  };
+} & {
+  default?: (props: Record<string, unknown>) => VNode[];
+}>, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+//#endregion
+//#region src/vueye-table.d.ts
+/** Slot props of `cell.<column id>` and `cell`. */
+interface CellSlotProps {
+  readonly item: unknown;
+  readonly row: TableRow<unknown>;
+  readonly value: unknown;
+  readonly display: string;
+  readonly column: {
+    readonly id: string;
+    readonly header: string;
+  };
+}
+/** Slot props of `status`, the "1–10 of 57 rows" line. */
+interface StatusSlotProps {
+  readonly start: number;
+  readonly end: number;
+  readonly rowCount: number;
+  readonly totalRowCount: number;
+  readonly selectedCount: number;
+}
+/**
+ * A complete data table: search, column visibility, sorting, selection, pagination, a live
+ * status line, loading and empty states, and theming. Every piece of state is available as a
+ * `v-model`, and `manual` hands searching, sorting, and paging to a server.
+ */
+declare const VueyeTable: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  /** `true` or `"multiple"` for checkboxes, `"single"` for one row at a time. */
+  selectable: {
+    type: PropType<boolean | "single" | "multiple">;
+    default: boolean;
+  };
+  selected: {
+    type: PropType<readonly RowKey[]>;
+    default: undefined;
+  };
+  /** The data is one page from a server; `rowCount` is the total. */
+  manual: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  rowCount: {
+    type: PropType<number | undefined>;
+    default: undefined;
+  };
+  /** Shown instead of the empty state while `loading` and there are no rows yet. */
+  loadingText: {
+    type: StringConstructor;
+    default: string;
+  };
+  columns: {
+    readonly type: PropType<readonly import("@vueye-table/core").AnyColumnDef[]>;
+    readonly default: undefined;
+  };
+  rowKey: {
+    readonly type: PropType<string | ((row: any, index: number) => RowKey)>;
+    readonly default: undefined;
+  };
+  caption: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  loading: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  density: {
+    readonly type: PropType<import("@vueye-table/styled").Density>;
+    readonly default: "comfortable";
+  };
+  striped: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  bordered: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  hover: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  stickyHeader: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  theme: {
+    readonly type: PropType<"light" | "dark">;
+    readonly default: undefined;
+  };
+  maxHeight: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  searchable: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  searchPlaceholder: {
+    readonly type: StringConstructor;
+    readonly default: "Search…";
+  };
+  columnToggle: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  pagination: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  pageSizeOptions: {
+    readonly type: PropType<readonly number[]>;
+    readonly default: () => number[];
+  };
+  page: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  pageSize: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  sorting: {
+    readonly type: PropType<readonly import("@vueye-table/core").SortRule[]>;
+    readonly default: undefined;
+  };
+  search: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  filters: {
+    readonly type: PropType<Readonly<Record<string, unknown>>>;
+    readonly default: undefined;
+  };
+  hiddenColumns: {
+    readonly type: PropType<readonly string[]>;
+    readonly default: undefined;
+  };
+  selectScope: {
+    readonly type: PropType<import("@vueye-table/core").SelectScope>;
+    readonly default: "all";
+  };
+  data: {
+    type: PropType<readonly unknown[]>;
+    required: true;
+  };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  "update:page": null;
+  "update:pageSize": null;
+  "update:sorting": null;
+  "update:search": null;
+  "update:filters": null;
+  "update:hiddenColumns": null;
+  "update:selected": null;
+} & {
+  "state-change": (state: TableState) => boolean;
+  "row-click": (item: unknown, row: TableRow<unknown>) => boolean;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  /** `true` or `"multiple"` for checkboxes, `"single"` for one row at a time. */
+  selectable: {
+    type: PropType<boolean | "single" | "multiple">;
+    default: boolean;
+  };
+  selected: {
+    type: PropType<readonly RowKey[]>;
+    default: undefined;
+  };
+  /** The data is one page from a server; `rowCount` is the total. */
+  manual: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  rowCount: {
+    type: PropType<number | undefined>;
+    default: undefined;
+  };
+  /** Shown instead of the empty state while `loading` and there are no rows yet. */
+  loadingText: {
+    type: StringConstructor;
+    default: string;
+  };
+  columns: {
+    readonly type: PropType<readonly import("@vueye-table/core").AnyColumnDef[]>;
+    readonly default: undefined;
+  };
+  rowKey: {
+    readonly type: PropType<string | ((row: any, index: number) => RowKey)>;
+    readonly default: undefined;
+  };
+  caption: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  loading: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  density: {
+    readonly type: PropType<import("@vueye-table/styled").Density>;
+    readonly default: "comfortable";
+  };
+  striped: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  bordered: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  hover: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  stickyHeader: {
+    readonly type: BooleanConstructor;
+    readonly default: false;
+  };
+  theme: {
+    readonly type: PropType<"light" | "dark">;
+    readonly default: undefined;
+  };
+  maxHeight: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  searchable: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  searchPlaceholder: {
+    readonly type: StringConstructor;
+    readonly default: "Search…";
+  };
+  columnToggle: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  pagination: {
+    readonly type: BooleanConstructor;
+    readonly default: true;
+  };
+  pageSizeOptions: {
+    readonly type: PropType<readonly number[]>;
+    readonly default: () => number[];
+  };
+  page: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  pageSize: {
+    readonly type: NumberConstructor;
+    readonly default: undefined;
+  };
+  sorting: {
+    readonly type: PropType<readonly import("@vueye-table/core").SortRule[]>;
+    readonly default: undefined;
+  };
+  search: {
+    readonly type: StringConstructor;
+    readonly default: undefined;
+  };
+  filters: {
+    readonly type: PropType<Readonly<Record<string, unknown>>>;
+    readonly default: undefined;
+  };
+  hiddenColumns: {
+    readonly type: PropType<readonly string[]>;
+    readonly default: undefined;
+  };
+  selectScope: {
+    readonly type: PropType<import("@vueye-table/core").SelectScope>;
+    readonly default: "all";
+  };
+  data: {
+    type: PropType<readonly unknown[]>;
+    required: true;
+  };
+}>> & Readonly<{
+  "onUpdate:page"?: (...args: any[]) => any;
+  "onUpdate:pageSize"?: (...args: any[]) => any;
+  "onUpdate:sorting"?: (...args: any[]) => any;
+  "onUpdate:search"?: (...args: any[]) => any;
+  "onUpdate:filters"?: (...args: any[]) => any;
+  "onUpdate:hiddenColumns"?: (...args: any[]) => any;
+  "onUpdate:selected"?: (...args: any[]) => any;
+  "onState-change"?: (state: TableState) => any;
+  "onRow-click"?: (item: unknown, row: TableRow<unknown>) => any;
+}>, {
+  page: number;
+  selectable: boolean | "single" | "multiple";
+  selected: readonly RowKey[];
+  manual: boolean;
+  rowCount: number | undefined;
+  loadingText: string;
+  columns: readonly import("@vueye-table/core").AnyColumnDef[];
+  rowKey: string | ((row: any, index: number) => RowKey);
+  caption: string;
+  loading: boolean;
+  density: import("@vueye-table/styled").Density;
+  striped: boolean;
+  bordered: boolean;
+  hover: boolean;
+  stickyHeader: boolean;
+  theme: "light" | "dark";
+  maxHeight: string;
+  searchable: boolean;
+  searchPlaceholder: string;
+  columnToggle: boolean;
+  pagination: boolean;
+  pageSizeOptions: readonly number[];
+  pageSize: number;
+  sorting: readonly import("@vueye-table/core").SortRule[];
+  search: string;
+  filters: Readonly<Record<string, unknown>>;
+  hiddenColumns: readonly string[];
+  selectScope: import("@vueye-table/core").SelectScope;
+}, SlotsType<{
+  [key: `cell.${string}`]: CellSlotProps;
+  [key: `header.${string}`]: {
+    column: {
+      id: string;
+      header: string;
+    };
+  };
+} & {
+  toolbar: {
+    table: unknown;
+  };
+  empty: Record<string, never>;
+  loading: Record<string, never>;
+  footer: {
+    table: unknown;
+  };
+  status: StatusSlotProps;
+}>, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+//#endregion
+//#region src/index.d.ts
+declare module "vue" {
+  interface GlobalComponents {
+    VueyeTable: typeof VueyeTable;
+    VueyeGrid: typeof VueyeGrid;
+  }
+}
+//#endregion
+export { type CellSlotProps, type StatusSlotProps, VueyeGrid, VueyeTable, VueyeTablePlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/plugin.ts","../src/vueye-grid.ts","../src/vueye-table.ts","../src/index.ts"],"mappings":";;;;;;;;;cAMa,kBAAkB;;;;;;;;;cCqBlB,yBAAS,8BAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAQK,MAAA;;;;;;;;;;;;;;EAsBP,iBAAC,OAAO;EACT,gBAAC;EACV,OAAC,kBAAkB;EACX,eAAC,iBAAiB;EACxB,SAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA1Bc,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aALyC;;;EACpD,WAAC,OAAO,4BAA4B;kCA+IlD;;;;UC/Ie;WACN;WACA,KAAK;WACL;WACA;WACA;aAAmB;aAAqB;;;;UAIlC;WACN;WACA;WACA;WACA;WACA;;;;;;;cAQE,0BAAU,8BAAA;;;IAOU,MAAA;;;;IAGF,MAAA,kBAAkB;;;;;;;;;IAGjB,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAVL,MAAA;;;;;;;;;;;;;;EAqBP,iBAAC,OAAO;EACX,cAAC,eAAe,KAAK;;;;IAlBL,MAAA;;;;IAGF,MAAA,kBAAkB;;;;;;;;;IAGjB,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAVL,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2BgB;MAAE;MAAY;;;;EAE1C;IAAE;;EACJ,OAAA;EACE,SAAA;EACD;IAAE;;EACF,QAAA;kCAqKZ;;;;YClPiB;IACf,mBAAmB;IACnB,kBAAkB"}