@illinois-grad/grad-vue 0.1.0 → 1.0.2

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

@@ -0,0 +1,39 @@
+type MenuItem = {
+    label: string;
+    href?: string;
+    to?: string;
+};
+interface Props {
+    /**
+     * Title and accessible name
+     */
+    title?: string;
+    items: MenuItem[];
+    offset?: number;
+    spy?: boolean;
+    /**
+     * Sidebar theme
+     */
+    theme?: "light" | "dark";
+    /**
+     * Use compact layout
+     */
+    compact?: boolean;
+}
+type __VLS_Props = Props;
+type __VLS_ModelProps = {
+    modelValue?: string | null;
+};
+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: string | null) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
+}>, {
+    theme: "light" | "dark";
+    compact: boolean;
+    offset: number;
+    spy: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -0,0 +1,74 @@
+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<({
+        /**
+         * Accessible label
+         */
+        label: string;
+        data: T[];
+        columns: C[];
+        resultCount?: number;
+        groupBy?: keyof T;
+        filtering: UseFilteringReturn<T>;
+        groupRender?: (groupValue: any, row: T) => VNode;
+        rowClickable?: boolean;
+        rowClass?: (row: T) => string | string[] | undefined;
+        startIndex: number;
+        /**
+         * 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;
+        sortOrder?: 1 | -1;
+        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: 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 : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {
+        pagination?: (props: {}) => any;
+    };
+    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>;
+};
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

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

@@ -1,14 +1,35 @@
 type Props = {
+    /**
+     * Label
+     */
+    label?: string;
+    /**
+     * Placeholder text
+     */
     placeholder?: string;
+    /**
+     * Disabled
+     */
     disabled?: boolean;
+    /**
+     * Error message
+     */
     error?: string;
+    /**
+     * Instructions
+     */
+    instructions?: string;
 };
 type __VLS_Props = Props;
 type __VLS_ModelProps = {
     modelValue?: string | null;
 };
 type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
-declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    instructions?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     change: (args_0: {
         was: string | null | undefined;
         to: string | null;
@@ -21,9 +42,17 @@ declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {},
     }) => any) | undefined;
     "onUpdate:modelValue"?: ((value: string | null | undefined) => any) | undefined;
 }>, {
+    label: string;
     placeholder: string;
     disabled: boolean;
     error: string;
+    instructions: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,29 @@
+interface Props {
+    /**
+     * Accessible label
+     */
+    label: string;
+    describedby?: string;
+    /**
+     * Error message
+     */
+    error?: string;
+    /**
+     * Disabled
+     */
+    disabled?: boolean;
+}
+type __VLS_Props = Props;
+type __VLS_ModelProps = {
+    modelValue?: boolean | null;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    change: (...args: any[]) => void;
+    "update:modelValue": (value: boolean | null) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: boolean | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/detail-list/GDetailListItem.vue.d.ts

@@ -0,0 +1,21 @@
+interface Props {
+    /**
+     * Label shown for the item.
+     */
+    label: string;
+}
+declare var __VLS_1: {}, __VLS_3: {};
+type __VLS_Slots = {} & {
+    label?: (props: typeof __VLS_1) => any;
+} & {
+    default?: (props: typeof __VLS_3) => any;
+};
+declare const __VLS_base: 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 __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,36 @@
+import { type VNode } from "vue";
+import { TableColumn, TableRow } from "./TableColumn.ts";
+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<{
+        data: T[];
+        groupBy?: keyof T;
+        columns: C[];
+        groupRender?: (groupValue: any, row: T) => VNode;
+        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;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {};
+    emit: {
+        (e: "row-click", link: string): void;
+        (e: "toggle-row", rowKey: string, shiftKey: boolean): void;
+    };
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};

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

@@ -0,0 +1,20 @@
+type __VLS_Props = {
+    start: number;
+    pageSize: number;
+    total: number;
+    pageSizes?: number[];
+};
+type __VLS_ModelProps = {
+    "start"?: number;
+    "pageSize"?: number;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
+declare const __VLS_export: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:start": (value: number | undefined) => any;
+    "update:pageSize": (value: number | undefined) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:start"?: ((value: number | undefined) => any) | undefined;
+    "onUpdate:pageSize"?: ((value: number | undefined) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -0,0 +1,35 @@
+import { VNode } from "vue";
+export type TableColumnFilter = SelectColumnFilter | MultiSelectColumnFilter | ToggleColumnFilter;
+export interface SelectColumnFilter {
+    type: 'select';
+    options: Array<{
+        label: string;
+        value: any;
+    }>;
+    placeholder?: string;
+}
+export interface MultiSelectColumnFilter {
+    type: 'multi-select';
+    options: Array<{
+        label: string;
+        value: any;
+    }>;
+    placeholder?: string;
+}
+export interface ToggleColumnFilter {
+    type: 'toggle';
+    label: string;
+    description?: string;
+}
+export interface TableColumn<T extends TableRow, K = keyof T> {
+    key: K;
+    label: string;
+    sortable?: boolean;
+    filter?: TableColumnFilter;
+    display?: (row: T) => string | VNode;
+    tdClass?: string | ((row: T) => string);
+    trClass?: string | ((row: T) => string);
+}
+export interface TableRow extends Record<string, any> {
+    key: string;
+}

package/dist/compose/useActiveLink.d.ts

@@ -0,0 +1,13 @@
+import { Ref } from "vue";
+/**
+ * Monitor a list of elements' intersection with the viewport to update active links.
+ *
+ * This updates the activeLink store with the active content's ID for use in menus.
+ *
+ * @param element Children of this element will be observed
+ * @param topOffset Offset from the top of the window to consider not visible
+ * @param activeId Ref to store the active element ID
+ */
+export declare function useActiveLinkContent(element: Ref<HTMLElement | null>, topOffset: number, activeId: Ref<string>): {
+    stop: () => void;
+};

package/dist/compose/useFiltering.d.ts

@@ -0,0 +1,14 @@
+import { type Ref } from "vue";
+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>>;
+    isFiltered: Ref<boolean>;
+    clearFilters: () => void;
+    filteredColumns: Ref<Partial<Record<keyof T, boolean>>>;
+}
+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>;

package/dist/compose/useOverlayStack.d.ts

@@ -1,10 +1,24 @@
-export declare function useOverlayStack(modal?: boolean): {
+import { Ref } from "vue";
+export type OverlayStack = {
     push: () => void;
     pop: () => void;
-    isTop: import("vue").ComputedRef<boolean>;
-    id: string;
+    isTop: Ref<boolean>;
+    zIndex: Ref<number>;
 };
-export declare function useOverlayStackState(): {
-    hasModal: import("vue").ComputedRef<boolean>;
-    hasOverlay: import("vue").ComputedRef<boolean>;
+declare global {
+    interface Window {
+        _g_overlay_stack_state: {
+            stack: Ref<string[]>;
+            modalStack: Ref<string[]>;
+            scrollLockStack: Ref<string[]>;
+            updateBodyScrollLock: () => void;
+        };
+    }
+}
+export declare function useOverlayStack(id: string, modal?: boolean, lockScroll?: boolean): OverlayStack;
+export type OverlayStackState = {
+    hasModal: Ref<boolean>;
+    hasOverlay: Ref<boolean>;
+    hasScrollLock: Ref<boolean>;
 };
+export declare function useOverlayStackState(): OverlayStackState;

package/dist/compose/useSidebar.d.ts

@@ -0,0 +1,12 @@
+import { Ref } from "vue";
+/**
+ * Composable to manage sidebar state and link components together.
+ *
+ * @param breakpoint Media query string for when the sidebar should be collapsible
+ */
+export declare function useSidebar(breakpoint?: Ref<string> | string): {
+    id: string;
+    open: Ref<boolean, boolean>;
+    isCollapsible: Ref<boolean, boolean>;
+    toggle: () => boolean;
+};

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

@@ -0,0 +1,4 @@
+import type { Directive } from "vue";
+export type VGtooltipDirective = Directive<HTMLElement, string>;
+declare const VGtooltip: VGtooltipDirective;
+export default VGtooltip;