@xy-planning-network/trees 0.6.6-rc-7 → 0.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xy-planning-network/trees",
-  "version": "0.6.6-rc-7",
+  "version": "0.6.6",
   "description": "",
   "license": "MIT",
   "repository": "github:xy-planning-network/trees",

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

@@ -12,13 +12,11 @@ import { toRef } from "vue"
 const props = withDefaults(
   defineProps<{
     tableActions?: TableActions<any>
-    tableActionsType?: "dropdown" | "buttons"
     tableColumns: TableColumns<any>
     tableData: TableRowsData
   }>(),
   {
-    tableActions: () => [],
-    tableActionsType: "dropdown",
+    tableActions: () => ({ type: "dropdown", actions: [] }),
   }
 )
 
@@ -78,7 +76,7 @@ const { columns, hasActions, isEmptyCellValue, rows } = useTable(
                   class="px-6 py-4 text-sm text-gray-700 whitespace-nowrap leading-5"
                 >
                   <ActionsDropdown
-                    v-if="tableActionsType === 'dropdown'"
+                    v-if="tableActions.type === 'dropdown'"
                     :actions="row.actions"
                   />
                   <template v-else>

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

@@ -17,23 +17,17 @@ import TableActionButtons from "./TableActionButtons.vue"
 
 const props = withDefaults(
   defineProps<{
-    clickable?: boolean
-    loader?: boolean
     tableActions?: TableActions<any>
-    tableActionsType?: "dropdown" | "buttons"
     tableColumns: TableColumns<any>
     tableOptions: DynamicTableOptions
   }>(),
   {
-    clickable: false,
-    loader: true,
-    tableActions: () => [],
-    tableActionsType: "dropdown",
+    tableActions: () => ({ type: "dropdown", actions: [] }),
   }
 )
 
 defineEmits<{
-  (e: "click:row", v: any, i: number, c: typeof publicMethods): void
+  (e: "click:row", v: any): void
 }>()
 
 const loadAndRender = (): void => {
@@ -49,7 +43,7 @@ const loadAndRender = (): void => {
 
   BaseAPI.get<TrailsRespPaged<unknown>>(
     props.tableOptions.url,
-    { skipLoader: !props.loader },
+    { skipLoader: true },
     params
   ).then(
     (success) => {
@@ -266,18 +260,13 @@ loadAndRender()
           <tr
             v-for="(row, rowIdx) in rows"
             :key="rowIdx"
-            class="group"
-            :class="{ 'cursor-pointer': clickable }"
-            @click.stop="$emit('click:row', row.rowData, rowIdx, publicMethods)"
+            @click="$emit('click:row', row.rowData)"
           >
             <template v-for="(cell, cellIdx) in row.cells" :key="cellIdx">
               <component
                 :is="'td'"
                 class="px-6 py-4 text-sm text-gray-700 whitespace-nowrap leading-5"
-                :class="{
-                  [cell.alignment]: true,
-                  'group-hover:bg-gray-50': clickable,
-                }"
+                :class="cell.alignment"
               >
                 <template v-if="cell.isComponent">
                   <component :is="cell.val" />
@@ -295,7 +284,7 @@ loadAndRender()
               class="px-6 py-4 text-sm text-gray-700 whitespace-nowrap leading-5"
             >
               <ActionsDropdown
-                v-if="tableActionsType === 'dropdown'"
+                v-if="tableActions.type === 'dropdown'"
                 :actions="row.actions"
               />
               <template v-else>

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

@@ -29,7 +29,7 @@ const { actions, hasActions } = useActionItems(toRef(props, "actions"))
           'rounded-r-md': actionIdx === actions.length - 1,
         }"
         :disabled="action.disabled"
-        @click="action.event"
+        @click.stop="action.onClick"
       >
         <span class="relative inline-flex items-center gap-x-1.5">
           <component

package/src/lib-components/navigation/ActionsDropdown.vue

@@ -46,7 +46,7 @@ const { actions, hasActions } = useActionItems(toRef(props, "actions"))
                   active ? 'bg-gray-100 text-gray-900' : 'text-gray-700',
                   'block w-full text-left px-4 py-2 text-sm font-semibold disabled:cursor-not-allowed',
                 ]"
-                @click="action.event"
+                @click="action.onClick"
               >
                 <span class="relative inline-flex items-center gap-x-1.5">
                   <component

package/types/composables/nav.d.ts

@@ -13,7 +13,7 @@ export interface Pagination {
 }
 export interface ActionItem {
     disabled?: boolean | ((...args: any[]) => boolean);
-    event: (...args: any[]) => void;
+    onClick: (...args: any[]) => void;
     icon?: FunctionalComponent | RenderFunction;
     label: string;
     show?: boolean | ((...args: any[]) => boolean);

package/types/composables/table.d.ts

@@ -22,10 +22,41 @@ export interface DynamicTableAPI {
     reset: () => void;
 }
 export interface TableActionItem<T = TableRowData> extends ActionItem {
+    /**
+     * The disabled property determines the value of the disabled attribute on the button
+     * attached to the action.  Allowing the action to stay visible to the user, but keeping the action
+     * disabled from use.
+     *
+     * disabled accepts a boolean value or a function with the table row data as
+     * the first argument and the row index as the second.
+     */
     disabled?: boolean | ((rowData: T, rowIndex: number) => boolean);
-    event: (rowData: T, rowIndex: number, tableAPI: DynamicTableAPI) => void;
+    /**
+     * onClick is the callback function triggered by the button rendered in the table actions.
+     * @param rowData T
+     * @param rowIndex number
+     * @param tableAPI DynamicTableAPI
+     * @returns void
+     */
+    onClick: (rowData: T, rowIndex: number, tableAPI: DynamicTableAPI) => void;
+    /**
+     * The show property determines whether the action is visible.
+     *
+     * show accepts a boolean value or a function with the table row data as
+     * the first argument and the row index as the second.
+     */
     show?: boolean | ((rowData: T, rowIndex: number) => boolean);
 }
+export interface TableActions<T = TableRowData> {
+    /**
+     * an array of TableActionItem definitions
+     */
+    actions: TableActionItem<T>[];
+    /**
+     * type determines what component will render the actions
+     */
+    type: "dropdown" | "buttons";
+}
 export interface TableColumn<T = TableRowData> {
     /**
      * The alignment the table cell should have
@@ -51,7 +82,6 @@ export interface TableColumn<T = TableRowData> {
      */
     sort?: string;
 }
-export type TableActions<T = TableRowData> = TableActionItem<T>[];
 export type TableCellAlignment = "left" | "center" | "right";
 export type TableRowData = Record<string, any>;
 export type TableColumns<T = TableRowData> = TableColumn<T>[];

package/types/composables/useActionItems.d.ts

@@ -4,7 +4,7 @@ export declare const useActionItems: (items: ActionItem[] | Ref<ActionItem[]>) =
     actions: import("vue").ComputedRef<{
         disabled: boolean;
         show: boolean;
-        event: (...args: any[]) => void;
+        onClick: (...args: any[]) => void;
         icon?: import("vue").RenderFunction | import("vue").FunctionalComponent<{}, {}> | undefined;
         label: string;
     }[]>;

package/types/composables/useTable.d.ts

@@ -13,7 +13,7 @@ export declare const useTable: (rowData: TableRowsData | Ref<TableRowsData>, col
     rows: import("vue").ComputedRef<{
         actions: {
             disabled: boolean | undefined;
-            event: () => void;
+            onClick: () => void;
             show: boolean | undefined;
             icon?: import("vue").RenderFunction | import("vue").FunctionalComponent<{}, {}> | undefined;
             label: string;

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

@@ -1,25 +1,23 @@
 import type { TableActions, TableColumns, TableRowsData } from "../../composables/table";
 declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
     tableActions?: TableActions<any> | undefined;
-    tableActionsType?: "dropdown" | "buttons" | undefined;
     tableColumns: TableColumns<any>;
     tableData: TableRowsData;
 }>, {
-    tableActions: () => never[];
-    tableActionsType: string;
+    tableActions: () => {
+        type: string;
+        actions: never[];
+    };
 }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
     tableActions?: unknown;
-    tableActionsType?: unknown;
     tableColumns?: unknown;
     tableData?: unknown;
 } & {
     tableActions: TableActions<any>;
-    tableActionsType: "dropdown" | "buttons";
     tableColumns: TableColumns<any>;
     tableData: TableRowsData;
 } & {}>, {
     tableActions: TableActions<any>;
-    tableActionsType: "dropdown" | "buttons";
 }>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

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

@@ -1,42 +1,30 @@
-import type { DynamicTableAPI, DynamicTableOptions, TableActions, TableColumns } from "../../composables/table";
+import type { 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;
-    tableActionsType?: "dropdown" | "buttons" | undefined;
     tableColumns: TableColumns<any>;
     tableOptions: DynamicTableOptions;
 }>, {
-    clickable: boolean;
-    loader: boolean;
-    tableActions: () => never[];
-    tableActionsType: string;
+    tableActions: () => {
+        type: string;
+        actions: never[];
+    };
 }>, {
     refresh: () => void;
     reset: () => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "click:row": (v: any, i: number, c: DynamicTableAPI) => void;
+    "click:row": (v: any) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    clickable?: unknown;
-    loader?: unknown;
     tableActions?: unknown;
-    tableActionsType?: unknown;
     tableColumns?: unknown;
     tableOptions?: unknown;
 } & {
-    clickable: boolean;
-    loader: boolean;
     tableActions: TableActions<any>;
-    tableActionsType: "dropdown" | "buttons";
     tableColumns: TableColumns<any>;
     tableOptions: DynamicTableOptions;
 } & {}> & {
-    "onClick:row"?: ((v: any, i: number, c: DynamicTableAPI) => any) | undefined;
+    "onClick:row"?: ((v: any) => any) | undefined;
 }, {
-    clickable: boolean;
-    loader: boolean;
     tableActions: TableActions<any>;
-    tableActionsType: "dropdown" | "buttons";
 }>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;

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

@@ -1,21 +0,0 @@
-import type { TableColumn, TableRow } from "../../composables/table";
-declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
-    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<{
-    columns?: unknown;
-    rows?: unknown;
-} & {
-    columns: TableColumn<TableRow>[];
-    rows: TableRow[];
-} & {}>, {}>;
-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/lists/StaticTableActionSlot.vue.d.ts

@@ -1,27 +0,0 @@
-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/lists/Table.vue.d.ts

@@ -1,39 +0,0 @@
-import * as TableTypes from "../../composables/table";
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
-    clickable?: boolean | undefined;
-    loader?: boolean | undefined;
-    tableData: TableTypes.Dynamic;
-}>, {
-    clickable: boolean;
-    loader: boolean;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    handleClick: (v: any) => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<{
-    tableData?: unknown;
-    clickable?: unknown;
-    loader?: unknown;
-} & {
-    tableData: TableTypes.Dynamic;
-    clickable: boolean;
-    loader: boolean;
-} & {}> & {
-    onHandleClick?: ((v: any) => any) | undefined;
-}, {
-    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/navigation/ActionsDropdownCallback.vue.d.ts

@@ -1,18 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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;
-    };
-};