@xy-planning-network/trees 0.6.5 → 0.6.6-rc-1

package/types/lib-components/index.d.ts

@@ -15,9 +15,9 @@ import { default as Tooltip } from "./overlays/Tooltip.vue";
 import { default as StackedLayout } from "./layout/StackedLayout.vue";
 import { default as Paginator } from "./navigation/Paginator.vue";
 import { default as Spinner } from "./overlays/Spinner.vue";
-import { default as StaticTable } from "./lists/StaticTable.vue";
+import { default as DataTable } from "./lists/DataTable.vue";
 import { default as Steps } from "./navigation/Steps.vue";
-import { default as Table } from "./lists/Table.vue";
+import { default as DynamicTable } from "./lists/DynamicTable.vue";
 import { default as Tabs } from "./navigation/Tabs.vue";
 import { default as Toggle } from "./forms/Toggle.vue";
 import { default as XYSpinner } from "./indicators/XYSpinner.vue";
@@ -34,7 +34,7 @@ import { default as Select } from "./forms/Select.vue";
 import { default as TextArea } from "./forms/TextArea.vue";
 import { default as YesOrNoRadio } from "./forms/YesOrNoRadio.vue";
 export { ActionsDropdown, Cards, ContentModal, DateFilter, DetailList, DownloadCell, Flash, Modal, SidebarLayout, Slideover, StackedLayout, Popover, PopoverContent, PopoverPosition, // Type export
-Paginator, Spinner, StaticTable, Steps, Table, Tabs, Toggle, Tooltip, BaseInput, Checkbox, DateRangePicker, InputHelp, InputLabel, FieldsetLegend, MultiCheckboxes, Radio, RadioCards, Select, TextArea, YesOrNoRadio, XYSpinner, };
+Paginator, Spinner, DataTable, Steps, DynamicTable, Tabs, Toggle, Tooltip, BaseInput, Checkbox, DateRangePicker, InputHelp, InputLabel, FieldsetLegend, MultiCheckboxes, Radio, RadioCards, Select, TextArea, YesOrNoRadio, XYSpinner, };
 /**
  * declare global component types for App.use(Trees)
  */
@@ -54,9 +54,9 @@ export interface TreesComponents {
     StackedLayout: typeof StackedLayout;
     Paginator: typeof Paginator;
     Spinner: typeof Spinner;
-    StaticTable: typeof StaticTable;
+    DataTable: typeof DataTable;
+    DynamicTable: typeof DynamicTable;
     Steps: typeof Steps;
-    Table: typeof Table;
     Tabs: typeof Tabs;
     Toggle: typeof Toggle;
     Tooltip: typeof Tooltip;

package/types/lib-components/lists/DataTable.vue.d.ts

@@ -0,0 +1,33 @@
+import { TableActions, TableColumns, TableRowsData } from "../../composables/table";
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    tableActions?: TableActions<any> | undefined;
+    tableColumns: TableColumns<any>;
+    tableData: TableRowsData;
+}>, {
+    tableActions: () => never[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    tableActions?: unknown;
+    tableColumns?: unknown;
+    tableData?: unknown;
+} & {
+    tableActions: TableActions<any>;
+    tableColumns: TableColumns<any>;
+    tableData: TableRowsData;
+} & {}>, {
+    tableActions: TableActions<any>;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
+        default: D[K];
+    } : P[K];
+};

package/types/lib-components/lists/DownloadCell.vue.d.ts

@@ -1,12 +1,9 @@
 declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
     propsData: Record<string, unknown>;
-    attribute: string;
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
     propsData?: unknown;
-    attribute?: unknown;
 } & {
     propsData: Record<string, unknown>;
-    attribute: string;
 } & {}>, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/types/lib-components/lists/DynamicTable.vue.d.ts

@@ -0,0 +1,54 @@
+import { DynamicTableAPI, DynamicTableOptions, TableActions, TableColumns } from "../../composables/table";
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    clickable?: boolean | undefined;
+    loader?: boolean | undefined;
+    tableActions?: TableActions<any> | undefined;
+    tableColumns: TableColumns<any>;
+    tableOptions: DynamicTableOptions;
+}>, {
+    clickable: boolean;
+    loader: boolean;
+    tableActions: () => never[];
+}>, {
+    refresh: () => void;
+    reset: () => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "click:row": (v: {
+        [x: string]: any;
+    }, c: DynamicTableAPI) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    tableActions?: unknown;
+    tableColumns?: unknown;
+    clickable?: unknown;
+    loader?: unknown;
+    tableOptions?: unknown;
+} & {
+    tableActions: TableActions<any>;
+    tableColumns: TableColumns<any>;
+    clickable: boolean;
+    loader: boolean;
+    tableOptions: DynamicTableOptions;
+} & {}> & {
+    "onClick:row"?: ((v: {
+        [x: string]: any;
+    }, c: DynamicTableAPI) => any) | undefined;
+}, {
+    tableActions: TableActions<any>;
+    clickable: boolean;
+    loader: boolean;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
+        default: D[K];
+    } : P[K];
+};

package/types/lib-components/lists/StaticTable.vue.d.ts

@@ -1,10 +1,13 @@
-import * as TableTypes from "../../composables/table";
+import type { TableColumn, TableRow } from "../../composables/table";
 declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
-    tableData: TableTypes.Static;
+    columns: TableColumn<TableRow>[];
+    rows: TableRow[];
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    tableData?: unknown;
+    columns?: unknown;
+    rows?: unknown;
 } & {
-    tableData: TableTypes.Static;
+    columns: TableColumn<TableRow>[];
+    rows: TableRow[];
 } & {}>, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/types/lib-components/lists/StaticTableActionSlot.vue.d.ts

@@ -0,0 +1,27 @@
+import * as TableTypes from "../../composables/table";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    tableData: Omit<TableTypes.Static, "currentUser">;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    tableData?: unknown;
+} & {
+    tableData: Omit<TableTypes.Static, "currentUser">;
+} & {}>, {}>, {
+    actions: (_: {
+        row: Record<string, unknown>;
+    }) => any;
+}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/types/lib-components/navigation/ActionsDropdown.vue.d.ts

@@ -1,18 +1,10 @@
-import { MenuItem } from "@headlessui/vue";
-import * as TableTypes from "../../composables/table";
-import User from "../../composables/user";
+import type { ActionMenuItem } from "../../composables/nav";
 declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
-    currentUser: User;
-    items: TableTypes.MenuItem[];
-    propsData: any;
+    items: ActionMenuItem[];
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    currentUser?: unknown;
     items?: unknown;
-    propsData?: unknown;
 } & {
-    currentUser: User;
-    items: TableTypes.MenuItem[];
-    propsData: any;
+    items: ActionMenuItem[];
 } & {}>, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

package/types/lib-components/navigation/ActionsDropdownCallback.vue.d.ts

@@ -0,0 +1,18 @@
+import type { ActionMenuItemCallback } from "../../composables/nav";
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    items: ActionMenuItemCallback[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    items?: unknown;
+} & {
+    items: ActionMenuItemCallback[];
+} & {}>, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/types/lib-components/navigation/ActionsDropdownEmit.vue.d.ts

@@ -0,0 +1,22 @@
+import type { ActionMenuEmit } from "../../composables/nav";
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
+    items: ActionMenuEmit[];
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (v: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
+    items?: unknown;
+} & {
+    items: ActionMenuEmit[];
+} & {}> & {
+    onClick?: ((v: string) => any) | undefined;
+}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/src/lib-components/lists/StaticTable.vue

@@ -1,83 +0,0 @@
-<script setup lang="ts">
-import { ComponentPublicInstance, getCurrentInstance } from "vue"
-import * as TableTypes from "@/composables/table"
-
-defineProps<{
-  tableData: TableTypes.Static
-}>()
-
-const cellValue = (
-  item: Record<string, any>,
-  col: TableTypes.Column
-): string => {
-  if (col.key) {
-    return item[col.key]
-  }
-
-  if (col.presenter) {
-    // TODO: discuss this pattern.  Current usage can be replaced with modules.
-    // https://v3.vuejs.org/api/composition-api.html#getcurrentinstance
-    const internalInstance = getCurrentInstance()
-    return col.presenter(
-      item,
-      internalInstance?.proxy as ComponentPublicInstance
-    )
-  }
-
-  return ""
-}
-</script>
-<template>
-  <div class="flex flex-col">
-    <div class="-my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
-      <div class="inline-block min-w-full py-2 align-middle sm:px-6 lg:px-8">
-        <div
-          class="overflow-hidden border-b border-gray-200 shadow sm:rounded-lg"
-        >
-          <table class="min-w-full divide-y divide-gray-200">
-            <thead>
-              <tr>
-                <th
-                  v-for="(col, idx) in tableData.columns"
-                  :key="idx"
-                  class="px-6 py-3 text-xs font-medium tracking-wider text-left text-gray-900 uppercase bg-gray-50 leading-4"
-                  v-text="col.display"
-                ></th>
-              </tr>
-            </thead>
-            <tbody class="bg-white divide-y divide-gray-200">
-              <tr
-                v-for="(item, rowIdx) in tableData.items"
-                :key="item.id ? (item.id as string) : rowIdx"
-              >
-                <td
-                  v-for="(col, colIdx) in tableData.columns"
-                  :key="rowIdx + '-' + colIdx"
-                  class="px-6 py-4 text-sm text-gray-700 whitespace-nowrap leading-5"
-                >
-                  <component
-                    :is="col.component"
-                    v-if="col.component"
-                    :props-data="item"
-                    :current-user="tableData.currentUser"
-                    :attribute="col.key"
-                  ></component>
-                  <span v-else v-text="cellValue(item, col)"></span>
-                </td>
-              </tr>
-
-              <tr v-if="tableData.items.length == 0">
-                <td
-                  :colspan="tableData.columns.length"
-                  class="px-6 py-4 text-sm text-gray-700 whitespace-nowrap leading-5"
-                >
-                  No items were found!
-                </td>
-              </tr>
-            </tbody>
-          </table>
-        </div>
-      </div>
-    </div>
-  </div>
-</template>