@illinois-grad/grad-vue 1.0.1 → 2.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 University of Illinois Board of Trustees
+Copyright (c) 2026 University of Illinois Board of Trustees
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,6 +2,8 @@
 
 Shared Vue.js components and composable functions for the Graduate College.
 
+**Package has moved in npm** to `@illinois-grad/grad-vue`.
+
 Features:
 
 - **Vue 3**: Built with Vue.js version 3 and the Composition API.

package/dist/components/GClipboard.vue.d.ts

@@ -7,6 +7,10 @@ interface Props {
      * Hide the visible text
      */
     hideText?: boolean;
+    /**
+     * Copy button label
+     */
+    copyLabel?: string;
 }
 declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;

package/dist/components/GSearch.vue.d.ts

@@ -49,7 +49,7 @@ declare const __VLS_export: <T extends {
             option: T;
         }) => any;
     };
-    emit: ((event: "select" | "submit", ...args: any[]) => void) & ((evt: "update:modelValue", value: string | null) => void);
+    emit: ((event: "select" | "submit", ...args: any[]) => void) & ((event: "update:modelValue", value: string | null) => void);
 }>) => import("vue").VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/dist/components/GTable.vue.d.ts

@@ -1,6 +1,20 @@
 import { TableColumn, TableRow } from "./table/TableColumn.ts";
 import { VNode } from "vue";
 import { UseFilteringReturn } from "../compose/useFiltering.ts";
+export interface BulkAction {
+    /**
+     * Action identifier
+     */
+    id: string;
+    /**
+     * Action label
+     */
+    label: string;
+    /**
+     * Action theme/color
+     */
+    theme?: "primary" | "secondary" | "accent" | "danger";
+}
 declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: import("vue").PublicProps & __VLS_PrettifyLocal<({
         /**
@@ -11,20 +25,28 @@ declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS
         columns: C[];
         resultCount?: number;
         groupBy?: keyof T;
-        filtering: UseFilteringReturn<T>;
+        filtering: UseFilteringReturn<any>;
         groupRender?: (groupValue: any, row: T) => VNode;
         rowClickable?: boolean;
         rowClass?: (row: T) => string | string[] | undefined;
         startIndex: number;
+        /**
+         * Enable bulk selection with checkboxes
+         */
+        bulkSelectionEnabled?: boolean;
+        bulkActions?: BulkAction[];
     } & {
         sortField?: keyof T;
         sortOrder?: 1 | -1;
-        filter: Record<keyof T, any>;
+        filter: Partial<Record<keyof T, any>>;
+        selectedRows?: string[];
     }) & {
         "onRow-click"?: ((link: string) => any) | undefined;
         "onUpdate:sortField"?: ((value: keyof T | undefined) => any) | undefined;
         "onUpdate:sortOrder"?: ((value: 1 | -1 | undefined) => any) | undefined;
-        "onUpdate:filter"?: ((value: Record<keyof T, any>) => any) | undefined;
+        "onUpdate:filter"?: ((value: Partial<Record<keyof T, any>>) => any) | undefined;
+        "onUpdate:selectedRows"?: ((value: string[]) => any) | undefined;
+        "onBulk-action"?: ((actionId: string, selectedKeys: string[]) => any) | undefined;
     }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
     } ? P : {});
@@ -33,7 +55,10 @@ declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS
     slots: {
         pagination?: (props: {}) => any;
     };
-    emit: ((e: "row-click", link: string) => void) & (((evt: "update:sortField", value: keyof T | undefined) => void) & ((evt: "update:sortOrder", value: 1 | -1 | undefined) => void) & ((evt: "update:filter", value: Record<keyof T, any>) => void));
+    emit: {
+        (e: "row-click", link: string): void;
+        (e: "bulk-action", actionId: string, selectedKeys: string[]): void;
+    } & (((event: "update:sortField", value: keyof T | undefined) => void) & ((event: "update:sortOrder", value: 1 | -1 | undefined) => void) & ((event: "update:filter", value: Partial<Record<keyof T, any>>) => void) & ((event: "update:selectedRows", value: string[]) => void));
 }>) => import("vue").VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/dist/components/table/GTableBody.vue.d.ts

@@ -9,7 +9,10 @@ declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS
         rowClickable?: boolean;
         rowClass?: (row: T) => string | string[] | undefined;
         startIndex: number;
+        bulkSelectionEnabled?: boolean;
+        selectedRows?: string[];
     } & {
+        "onToggle-row"?: ((rowKey: string, shiftKey: boolean) => any) | undefined;
         "onRow-click"?: ((link: string) => any) | undefined;
     }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
@@ -17,7 +20,10 @@ declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS
     expose: (exposed: {}) => void;
     attrs: any;
     slots: {};
-    emit: (e: "row-click", link: string) => void;
+    emit: {
+        (e: "row-click", link: string): void;
+        (e: "toggle-row", rowKey: string, shiftKey: boolean): void;
+    };
 }>) => import("vue").VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/dist/components/table/TableColumn.d.ts

@@ -19,10 +19,6 @@ export interface MultiSelectColumnFilter {
 export interface ToggleColumnFilter {
     type: 'toggle';
     label: string;
-    trueLabel?: string;
-    falseLabel?: string;
-    trueValue: any;
-    falseValue: any;
     description?: string;
 }
 export interface TableColumn<T extends TableRow, K = keyof T> {

package/dist/compose/useFiltering.d.ts

@@ -1,9 +1,69 @@
-import { type Ref } from "vue";
-export interface UseFilteringReturn<T extends Record<string, any> = Record<string, any>> {
-    filters: Ref<T>;
+import { Reactive, type Ref } from "vue";
+export type FilterLocationQueryValueRaw = string | number;
+/**
+ * Query representation for filtering, compatible with vue-router
+ */
+export type FilterLocationQuery = {
+    [p: string]: string | null | number | undefined | FilterLocationQueryValueRaw[];
+};
+export interface FilteringOptions {
+    syncWith?: Ref<{
+        [p: string]: string | null | (string | null)[] | undefined;
+    }>;
+}
+/**
+ * Represents a type that defines a set of filters for a given record type.
+ * The keys are based on the record, and the values are possible values
+ * for a filter.
+ */
+export type FiltersForRecord<T extends object, F extends {
+    [K in keyof T]?: any;
+}> = {
+    [K in keyof T]?: T[K] extends string | number | boolean | undefined | null ? T[K] | string | string[] : T[K] extends string[] | number[] ? T[K][] : never;
+};
+/**
+ * Represents the return type of a composition function used for handling
+ * filtering logic in a data structure.
+ */
+export interface UseFilteringReturn<T extends Record<string, any> = Record<string, any>, F extends {
+    [K in keyof T]?: any;
+} = Record<keyof T, any>> {
+    filters: Reactive<F>;
     isFiltered: Ref<boolean>;
     clearFilters: () => void;
-    filteredColumns: Ref<Record<keyof T, boolean>>;
+    filteredColumns: Ref<Partial<Record<keyof T, boolean>>>;
 }
+/**
+ * Returns the value if it's not empty, or undefined if it's empty.
+ */
+export declare function emptyAsUndefined<T extends string | number | boolean | string[] | number[] | undefined | null>(value: T): (T & {}) | undefined;
+export declare function filterOmitEmpty<T extends object>(value: T): Partial<T>;
+/**
+ * Return a value as an array if it's not already one, or
+ * undefined if it's undefined.
+ */
+export declare function asArray<T>(value: T | T[]): NonNullable<T>[] | undefined;
+/**
+ * Converts filter criteria into a format suitable for use as a query object
+ * in vue-router.
+ */
+export declare function filterAsQuery<T extends Record<string, any>, F extends {
+    [K in keyof T]?: any;
+} = Record<keyof T, any>>(filters: FiltersForRecord<T, F>): FilterLocationQuery;
+/**
+ * Converts an object of filters into a query parameters object for API calls.
+ *
+ * Transforms the values into strings or arrays of strings. Excludes fields with undefined,
+ * null, empty string, or false values. Supports single values and arrays.
+ */
 export declare function filtersToQueryParams<T extends Record<string, any>>(filters: T): Record<keyof T, string | string[]>;
-export declare function useFiltering<T extends Record<string, any>>(filters: T): UseFilteringReturn<T>;
+/**
+ * Provides a mechanism to manage and synchronize filterable data with given filters and options.
+ *
+ * @param filters An object that defines the filters applicable to the data record.
+ * @param options Configuration options for filtering, such as synchronization.
+ * @return Returns an object that can be used with GTable.
+ */
+export declare function useFiltering<T extends Record<string, any> = Record<string, any>, F extends {
+    [K in keyof T]?: any;
+} = Record<keyof T, any>>(filters: F, options?: FilteringOptions): UseFilteringReturn<T, F>;

package/dist/directives/v-gtooltip.d.ts

@@ -1,7 +1,4 @@
-import type { DirectiveBinding } from "vue";
-declare const VGtooltip: {
-    mounted(el: HTMLElement, binding: DirectiveBinding): void;
-    updated(el: HTMLElement, binding: DirectiveBinding): void;
-    unmounted(el: HTMLElement): void;
-};
+import type { Directive } from "vue";
+export type VGtooltipDirective = Directive<HTMLElement, string>;
+declare const VGtooltip: VGtooltipDirective;
 export default VGtooltip;