@illinois-grad/grad-vue 1.0.2 → 2.1.0

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/GTable.vue.d.ts

@@ -25,7 +25,7 @@ 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;
@@ -34,9 +34,6 @@ declare const __VLS_export: <T extends TableRow, C extends TableColumn<T>>(__VLS
          * Enable bulk selection with checkboxes
          */
         bulkSelectionEnabled?: boolean;
-        /**
-         * Array of actions to show in the sticky toolbar when rows are selected
-         */
         bulkActions?: BulkAction[];
     } & {
         sortField?: keyof T;

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

@@ -0,0 +1,41 @@
+interface Props {
+    /**
+     * Title for the popover.
+     */
+    title?: string;
+    /**
+     * Label for year select.
+     */
+    yearLabel?: string;
+    /**
+     * Label for period select.
+     */
+    periodLabel?: string;
+    termYears?: string[];
+    termNames?: string[];
+}
+type __VLS_Props = Required<Props>;
+type __VLS_ModelProps = {
+    modelValue?: {
+        year: string;
+        name: string;
+    };
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: {
+        year: string;
+        name: string;
+    }) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: {
+        year: string;
+        name: string;
+    }) => any) | undefined;
+}>, {
+    title: string;
+    termYears: string[];
+    termNames: string[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/term/GTermSelectorControl.vue.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Prebuilt GSelect and GSelectButton components that can be used to
+ * select a term.
+ */
+interface Props {
+    /**
+     * List of possible term years. Defaults to ["2026"].
+     */
+    termYears?: string[];
+    /**
+     * List of possible term names. Defaults to ["Spring", "Summer", "Fall"].
+     */
+    termNames?: string[];
+    /**
+     * Label for year select. Defaults to "Select Year".
+     */
+    yearLabel?: string;
+    /**
+     * Label for period select. Defaults to "Term".
+     */
+    periodLabel?: string;
+}
+type __VLS_Props = Required<Props>;
+type __VLS_ModelProps = {
+    modelValue?: {
+        year: string;
+        name: string;
+    };
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: {
+        year: string;
+        name: string;
+    }) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: {
+        year: string;
+        name: string;
+    }) => any) | undefined;
+}>, {
+    termYears: string[];
+    termNames: string[];
+    yearLabel: string;
+    periodLabel: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/compose/useFiltering.d.ts

@@ -1,14 +1,69 @@
-import { type Ref } from "vue";
+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;
     }>;
 }
-export interface UseFilteringReturn<T extends Record<string, any> = Record<string, any>> {
-    filters: Ref<Partial<T>>;
+/**
+ * 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<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, options?: FilteringOptions): 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>;