@kong/kongponents 9.29.10 → 9.29.11

package/dist/types/components/KTable/KTable.vue.d.ts

@@ -1,89 +1,6 @@
-import type { Ref, PropType } from 'vue';
-import KButton from '../../components/KButton/KButton.vue';
-import KEmptyState from '../../components/KEmptyState/KEmptyState.vue';
-import KSkeleton from '../../components/KSkeleton/KSkeleton.vue';
-import KPagination from '../../components/KPagination/KPagination.vue';
-import KTooltip from '../../components/KTooltip/KTooltip.vue';
-import { InfoIcon, ArrowDownIcon } from '@kong/icons';
-import type { TablePreferences, TableHeader, TableColumnSlotName, TableColumnTooltipSlotName, SwrvStateData, PageChangeData, PageSizeChangeData, SortColumnOrder, TableSortPayload, TableStatePayload, EmptyStateIconVariant } from '../../../types';
+import type { PropType } from 'vue';
+import type { TablePreferences, TableHeader, SwrvStateData, TableSortPayload, TableStatePayload, EmptyStateIconVariant } from '../../../types';
 import { EmptyStateIconVariants } from '../../../types';
-import { KUI_COLOR_TEXT_NEUTRAL, KUI_ICON_SIZE_30 } from '@kong/design-tokens';
-import ColumnVisibilityMenu from './../KTableView/ColumnVisibilityMenu.vue';
-declare const tableId: string;
-declare const data: Ref<Record<string, any>[], Record<string, any>[]>;
-declare const headerRow: Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
-declare const visibleHeaders: Ref<{
-    key: string;
-    label?: string | undefined;
-    sortable?: boolean | undefined;
-    hidable?: boolean | undefined;
-    tooltip?: string | undefined;
-    hideLabel?: boolean | undefined;
-    useSortHandlerFunction?: boolean | undefined;
-}[], TableHeader[] | {
-    key: string;
-    label?: string | undefined;
-    sortable?: boolean | undefined;
-    hidable?: boolean | undefined;
-    tooltip?: string | undefined;
-    hideLabel?: boolean | undefined;
-    useSortHandlerFunction?: boolean | undefined;
-}[]>;
-declare const resizingColumn: Ref<string, string>;
-declare const resizerHoveredColumn: Ref<string, string>;
-declare const currentHoveredColumn: Ref<string, string>;
-declare const hasColumnVisibilityMenu: import("vue").ComputedRef<boolean>;
-declare const visibilityColumns: import("vue").ComputedRef<TableHeader[]>;
-declare const visibilityPreferences: import("vue").ComputedRef<Record<string, boolean>>;
-declare const columnVisibility: Ref<Record<string, boolean>, Record<string, boolean>>;
-declare const total: Ref<number, number>;
-declare const isScrolled: Ref<boolean, boolean>;
-declare const page: Ref<number, number>;
-declare const pageSize: Ref<number, number>;
-declare const sortColumnKey: Ref<string, string>;
-declare const sortColumnOrder: Ref<SortColumnOrder, SortColumnOrder>;
-declare const hasNextPage: Ref<boolean, boolean>;
-declare const isClickable: Ref<boolean, boolean>;
-declare const hasToolbarSlot: import("vue").ComputedRef<boolean>;
-declare const tableWrapperStyles: import("vue").ComputedRef<Record<string, string>>;
-/**
- * Utilize a helper function to generate the column slot name.
- * This helps TypeScript infer the slot name in the template section so that the slot props can be resolved.
- * @param {string} columnKey The column.key
- */
-declare const getColumnSlotName: (columnKey: string) => TableColumnSlotName;
-/**
- * Utilize a helper function to generate the column tooltip slot name.
- * This helps TypeScript infer the slot name in the template section so that the slot props can be resolved.
- * @param {string} columnKey The column.key
- */
-declare const getColumnTooltipSlotName: (columnKey: string) => TableColumnTooltipSlotName;
-/**
- * To avoid requiring the consuming app to typecast if they want to use `row` or `column`
- * we strip the types to something generic before we put it in the slot for use.
- * @param obj The object to strip the type from
- */
-declare const getGeneric: (obj: Record<string, any>) => any;
-declare const tdlisteners: import("vue").ComputedRef<any>;
-declare const columnStyles: import("vue").ComputedRef<Record<string, any>>;
-declare const getHeaderClasses: (column: TableHeader, index: number) => Record<string, boolean>;
-declare const resizeHoverColumn: import("vue").ComputedRef<string>;
-declare const headerHeight: import("vue").ComputedRef<string>;
-declare const startResize: (evt: MouseEvent, colKey: string) => void;
-declare const previousOffset: import("vue").ComputedRef<string | null>;
-declare const nextOffset: Ref<string | null, string | null>;
-declare const isTableLoading: Ref<boolean, boolean>;
-declare const stateData: import("vue").ComputedRef<SwrvStateData>;
-declare const sortClickHandler: (header: TableHeader) => void;
-declare const pageChangeHandler: ({ page: newPage }: PageChangeData) => void;
-declare const pageSizeChangeHandler: ({ pageSize: newPageSize }: PageSizeChangeData) => void;
-declare const scrollHandler: (event: any) => void;
-declare const getNextOffsetHandler: () => void;
-declare const getPrevOffsetHandler: () => void;
-declare const shouldShowPagination: import("vue").ComputedRef<boolean>;
-declare const getTestIdString: (message: string) => string;
-declare const isRevalidating: Ref<boolean, boolean>;
-declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
 declare var __VLS_1: {
     state: SwrvStateData;
 }, __VLS_13: {}, __VLS_25: {}, __VLS_37: {}, __VLS_40: `column-${string}`, __VLS_41: {
@@ -95,7 +12,7 @@ declare var __VLS_1: {
     rowKey: number;
     rowValue: any;
 };
-type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
+type __VLS_Slots = {} & {
     [K in NonNullable<typeof __VLS_40>]?: (props: typeof __VLS_41) => any;
 } & {
     [K in NonNullable<typeof __VLS_51>]?: (props: typeof __VLS_52) => any;
@@ -109,554 +26,7 @@ type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$
     'empty-state'?: (props: typeof __VLS_25) => any;
 } & {
     'empty-state-action-icon'?: (props: typeof __VLS_37) => any;
-}>;
-declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    /**
-     * Allow columns to be resized
-     */
-    resizeColumns: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Used to customize the initial state of the table.
-     * Column visibility/width.
-     */
-    tablePreferences: {
-        type: PropType<TablePreferences>;
-        default: () => {};
-    };
-    /**
-     * Enable client side sort - only do this if using a fetcher
-     * that returns static data
-     */
-    clientSort: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Enables hover highlighting to table rows
-     */
-    rowHover: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    sortHandlerFunction: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A function that conditionally specifies row attributes on each row
-     */
-    rowAttrs: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A function that conditionally specifies cell attributes
-     */
-    cellAttrs: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A prop that enables a loading skeleton
-     */
-    loading: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass in a custom empty state title
-     */
-    emptyStateTitle: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state message
-     */
-    emptyStateMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state action route
-     */
-    emptyStateActionRoute: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state action message
-     */
-    emptyStateActionMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    emptyStateIconVariant: {
-        type: PropType<EmptyStateIconVariant>;
-        default: EmptyStateIconVariants;
-    };
-    /**
-     * A prop that enables the error state
-     */
-    error: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass in a custom error state title
-     */
-    errorStateTitle: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state message
-     */
-    errorStateMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state action route
-     */
-    errorStateActionRoute: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state action message
-     */
-    errorStateActionMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a fetcher function to enable server-side search, sort
-     * and pagination
-     */
-    fetcher: {
-        type: FunctionConstructor;
-        default: undefined;
-        required: true;
-    };
-    /**
-     * A prop to trigger a revalidate of the fetcher function. Modifying this value
-     * will trigger a manual refetch of the table data.
-     */
-    fetcherCacheKey: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop used to uniquely identify this table in the swrv cache
-     */
-    cacheIdentifier: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a search string for server-side search
-     */
-    searchInput: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in an array of headers for the table
-     */
-    headers: {
-        type: PropType<TableHeader[]>;
-        default: () => never[];
-    };
-    /**
-     * A prop to pass in an object of intial params for the initial fetcher function call
-     */
-    initialFetcherParams: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    /**
-     * A prop to pass in the number of pagination neighbors used by the pagination component
-     */
-    paginationNeighbors: {
-        type: NumberConstructor;
-        default: number;
-    };
-    /**
-     * A prop to pass in an array of page sizes used by the pagination component
-     */
-    paginationPageSizes: {
-        type: PropType<number[]>;
-        default: () => number[];
-        validator: (pageSizes: number[]) => boolean;
-    };
-    /**
-     * A prop to pass the total number of items in the set for the pagination text
-     */
-    paginationTotalItems: {
-        type: NumberConstructor;
-        default: null;
-    };
-    disablePaginationPageJump: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    sortable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    disablePagination: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    paginationOffset: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass to hide pagination for total table records is less than or equal to pagesize
-     */
-    hidePaginationWhenOptional: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    maxHeight: {
-        type: StringConstructor;
-        default: string;
-    };
-}>, {
-    KButton: typeof KButton;
-    KEmptyState: typeof KEmptyState;
-    KSkeleton: typeof KSkeleton;
-    KPagination: typeof KPagination;
-    KTooltip: typeof KTooltip;
-    InfoIcon: typeof InfoIcon;
-    ArrowDownIcon: typeof ArrowDownIcon;
-    KUI_COLOR_TEXT_NEUTRAL: typeof KUI_COLOR_TEXT_NEUTRAL;
-    KUI_ICON_SIZE_30: typeof KUI_ICON_SIZE_30;
-    ColumnVisibilityMenu: typeof ColumnVisibilityMenu;
-    tableId: typeof tableId;
-    data: typeof data;
-    headerRow: typeof headerRow;
-    visibleHeaders: typeof visibleHeaders;
-    resizingColumn: typeof resizingColumn;
-    resizerHoveredColumn: typeof resizerHoveredColumn;
-    currentHoveredColumn: typeof currentHoveredColumn;
-    hasColumnVisibilityMenu: typeof hasColumnVisibilityMenu;
-    visibilityColumns: typeof visibilityColumns;
-    visibilityPreferences: typeof visibilityPreferences;
-    columnVisibility: typeof columnVisibility;
-    total: typeof total;
-    isScrolled: typeof isScrolled;
-    page: typeof page;
-    pageSize: typeof pageSize;
-    sortColumnKey: typeof sortColumnKey;
-    sortColumnOrder: typeof sortColumnOrder;
-    hasNextPage: typeof hasNextPage;
-    isClickable: typeof isClickable;
-    hasToolbarSlot: typeof hasToolbarSlot;
-    tableWrapperStyles: typeof tableWrapperStyles;
-    getColumnSlotName: typeof getColumnSlotName;
-    getColumnTooltipSlotName: typeof getColumnTooltipSlotName;
-    getGeneric: typeof getGeneric;
-    tdlisteners: typeof tdlisteners;
-    columnStyles: typeof columnStyles;
-    getHeaderClasses: typeof getHeaderClasses;
-    resizeHoverColumn: typeof resizeHoverColumn;
-    headerHeight: typeof headerHeight;
-    startResize: typeof startResize;
-    previousOffset: typeof previousOffset;
-    nextOffset: typeof nextOffset;
-    isTableLoading: typeof isTableLoading;
-    stateData: typeof stateData;
-    sortClickHandler: typeof sortClickHandler;
-    pageChangeHandler: typeof pageChangeHandler;
-    pageSizeChangeHandler: typeof pageSizeChangeHandler;
-    scrollHandler: typeof scrollHandler;
-    getNextOffsetHandler: typeof getNextOffsetHandler;
-    getPrevOffsetHandler: typeof getPrevOffsetHandler;
-    shouldShowPagination: typeof shouldShowPagination;
-    getTestIdString: typeof getTestIdString;
-    isRevalidating: typeof isRevalidating;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
-    sort: (value: TableSortPayload) => any;
-    "error-action-click": () => any;
-    "empty-state-action-click": () => any;
-    state: (value: TableStatePayload) => any;
-    "cell-click": (value: {
-        data: any;
-    }) => any;
-    "row-click": (value: {
-        data: any;
-    }) => any;
-    "update:table-preferences": (preferences: TablePreferences) => any;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * Allow columns to be resized
-     */
-    resizeColumns: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Used to customize the initial state of the table.
-     * Column visibility/width.
-     */
-    tablePreferences: {
-        type: PropType<TablePreferences>;
-        default: () => {};
-    };
-    /**
-     * Enable client side sort - only do this if using a fetcher
-     * that returns static data
-     */
-    clientSort: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Enables hover highlighting to table rows
-     */
-    rowHover: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    sortHandlerFunction: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A function that conditionally specifies row attributes on each row
-     */
-    rowAttrs: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A function that conditionally specifies cell attributes
-     */
-    cellAttrs: {
-        type: FunctionConstructor;
-        default: () => {};
-    };
-    /**
-     * A prop that enables a loading skeleton
-     */
-    loading: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass in a custom empty state title
-     */
-    emptyStateTitle: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state message
-     */
-    emptyStateMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state action route
-     */
-    emptyStateActionRoute: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom empty state action message
-     */
-    emptyStateActionMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    emptyStateIconVariant: {
-        type: PropType<EmptyStateIconVariant>;
-        default: EmptyStateIconVariants;
-    };
-    /**
-     * A prop that enables the error state
-     */
-    error: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass in a custom error state title
-     */
-    errorStateTitle: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state message
-     */
-    errorStateMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state action route
-     */
-    errorStateActionRoute: {
-        type: (ObjectConstructor | StringConstructor)[];
-        default: string;
-    };
-    /**
-     * A prop to pass in a custom error state action message
-     */
-    errorStateActionMessage: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a fetcher function to enable server-side search, sort
-     * and pagination
-     */
-    fetcher: {
-        type: FunctionConstructor;
-        default: undefined;
-        required: true;
-    };
-    /**
-     * A prop to trigger a revalidate of the fetcher function. Modifying this value
-     * will trigger a manual refetch of the table data.
-     */
-    fetcherCacheKey: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop used to uniquely identify this table in the swrv cache
-     */
-    cacheIdentifier: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in a search string for server-side search
-     */
-    searchInput: {
-        type: StringConstructor;
-        default: string;
-    };
-    /**
-     * A prop to pass in an array of headers for the table
-     */
-    headers: {
-        type: PropType<TableHeader[]>;
-        default: () => never[];
-    };
-    /**
-     * A prop to pass in an object of intial params for the initial fetcher function call
-     */
-    initialFetcherParams: {
-        type: ObjectConstructor;
-        default: null;
-    };
-    /**
-     * A prop to pass in the number of pagination neighbors used by the pagination component
-     */
-    paginationNeighbors: {
-        type: NumberConstructor;
-        default: number;
-    };
-    /**
-     * A prop to pass in an array of page sizes used by the pagination component
-     */
-    paginationPageSizes: {
-        type: PropType<number[]>;
-        default: () => number[];
-        validator: (pageSizes: number[]) => boolean;
-    };
-    /**
-     * A prop to pass the total number of items in the set for the pagination text
-     */
-    paginationTotalItems: {
-        type: NumberConstructor;
-        default: null;
-    };
-    disablePaginationPageJump: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    sortable: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    disablePagination: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    paginationOffset: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * A prop to pass to hide pagination for total table records is less than or equal to pagesize
-     */
-    hidePaginationWhenOptional: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    maxHeight: {
-        type: StringConstructor;
-        default: string;
-    };
-}>> & Readonly<{
-    onSort?: ((value: TableSortPayload) => any) | undefined;
-    "onError-action-click"?: (() => any) | undefined;
-    "onEmpty-state-action-click"?: (() => any) | undefined;
-    onState?: ((value: TableStatePayload) => any) | undefined;
-    "onCell-click"?: ((value: {
-        data: any;
-    }) => any) | undefined;
-    "onRow-click"?: ((value: {
-        data: any;
-    }) => any) | undefined;
-    "onUpdate:table-preferences"?: ((preferences: TablePreferences) => any) | undefined;
-}>, {
-    maxHeight: string;
-    error: boolean;
-    loading: boolean;
-    headers: TableHeader[];
-    fetcher: Function;
-    fetcherCacheKey: string;
-    cacheIdentifier: string;
-    searchInput: string;
-    initialFetcherParams: Record<string, any>;
-    clientSort: boolean;
-    sortHandlerFunction: Function;
-    sortable: boolean;
-    emptyStateTitle: string;
-    emptyStateMessage: string;
-    emptyStateActionRoute: string | Record<string, any>;
-    emptyStateActionMessage: string;
-    emptyStateIconVariant: "search" | "default" | "error" | "kong";
-    errorStateTitle: string;
-    errorStateMessage: string;
-    errorStateActionRoute: string | Record<string, any>;
-    errorStateActionMessage: string;
-    paginationNeighbors: number;
-    paginationPageSizes: number[];
-    paginationTotalItems: number;
-    disablePaginationPageJump: boolean;
-    disablePagination: boolean;
-    hidePaginationWhenOptional: boolean;
-    paginationOffset: boolean;
-    resizeColumns: boolean;
-    tablePreferences: TablePreferences;
-    rowHover: boolean;
-    rowAttrs: Function;
-    cellAttrs: Function;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+};
 declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
     /**
      * Allow columns to be resized