@illinois-grad/grad-vue 0.1.0 → 1.0.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -12,6 +12,12 @@ All grad-vue components are **accessibility-first**. We can't make guarantees ab
 complying with specific accessibility standards, but all components are built with
 consideration for all users.
 
+## Demo Site
+
+View live interactive demos and documentation at: [https://graduatecollege.github.io/grad-vue/](https://graduatecollege.github.io/grad-vue/)
+
+The demo site is located in the [`demo/`](./demo) directory and is built with Nuxt 4.
+
 ## Installation
 
 ```bash
@@ -68,6 +74,59 @@ import { GButton } from '@illinois-grad/grad-vue'
 </template>
 ```
 
+## Development
+
+### Bootstrapping a New Component
+
+```bash
+npm run component:new -- GMyNewComponent
+```
+
+This script creates a new component in the `src/components` directory and adds it to the `playground/`, `demo/`,
+and the package exports.
+
+### Demo Props And Documentation
+
+The `props-config` and `docs` in each component's demo are generated automatically from the component's source:
+
+```bash
+npm run sync-props
+```
+
+Some notes on this process:
+
+- The `docs` section is generated from a jsdoc immediately after the opening `<script setup` tag. It supports markdown formatting.
+- The `props-config` section is generated from the `Props` interface or type in the component script, with default
+  values from the `withDefaults` function call.
+- The `Props` interface can have a `// Demo: <value>` comment to override the default value for the prop in the demo.
+- Props without a jsdoc will not be included in the demo.
+
+> [!TIP]
+> The markdown docs at the top of the component file cannot have a `</script>` because of how Vue.js parses the file.
+> Instead, use `&lt;/script>` in the docs.
+
+### Running Tests
+
+The project uses Vitest 4 for unit and accessibility testing in **browser mode**.
+
+```bash
+# Run tests in watch mode
+npm test
+
+# Run tests once
+npm run test:run
+```
+
+### Building
+
+```bash
+# Build the library
+npm run build
+
+# Watch for changes during development
+npm run watch
+```
+
 ## Release Process
 
 This package is automatically published to NPM when a semantic version tag (prefixed with `v`) is pushed to the repository. For example:
@@ -77,10 +136,3 @@ This package is automatically published to NPM when a semantic version tag (pref
 git tag v1.0.0
 git push origin v1.0.0
 ```
-
-This will:
-1. Build the package
-2. Create a GitHub release with auto-generated release notes
-3. Publish the package to NPM
-
-**Note:** Ensure the version in `package.json` matches the tag version before pushing.

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

@@ -1,11 +1,20 @@
 interface Props {
+    /**
+     * Dialog label
+     */
     label?: string;
+    /**
+     * Accept button text
+     */
     buttonText?: string;
+    /**
+     * Accept button color
+     */
     buttonColor?: "primary" | "secondary" | "danger";
 }
-declare var __VLS_7: {};
+declare var __VLS_13: {};
 type __VLS_Slots = {} & {
-    default?: (props: typeof __VLS_7) => any;
+    default?: (props: typeof __VLS_13) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     cancel: (...args: any[]) => void;

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

@@ -1,12 +1,38 @@
-declare var __VLS_7: {}, __VLS_9: {
+/**
+ * This is a minimal header meant for web apps where a full Illinois
+ * brand header would be too large.
+ *
+ * **Slot** `left` allows replacing the link element in the top-left corner.
+ *
+ * **Slot** `title` is to the right of the logo.
+ *
+ * **Slot** `app-controls` is the remaining area to the right.
+ */
+type Props = {
+    illinois?: boolean;
+    /**
+     * Top-left corner text
+     *
+     * You can customize this text element with the "left" slot.
+     */
+    brand?: string;
+};
+declare var __VLS_1: {}, __VLS_3: {}, __VLS_5: {}, __VLS_7: {
     class: string;
 };
 type __VLS_Slots = {} & {
-    title?: (props: typeof __VLS_7) => any;
+    left?: (props: typeof __VLS_1) => any;
+} & {
+    icon?: (props: typeof __VLS_3) => any;
+} & {
+    title?: (props: typeof __VLS_5) => any;
 } & {
-    'app-controls'?: (props: typeof __VLS_9) => any;
+    'app-controls'?: (props: typeof __VLS_7) => any;
 };
-declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    illinois: boolean;
+    brand: 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;

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

@@ -1,7 +1,19 @@
 interface Props {
+    /**
+     * Button size
+     */
     size?: "small" | "medium" | "large";
+    /**
+     * Button color theme
+     */
     theme?: "primary" | "secondary" | "accent" | "danger" | "none";
+    /**
+     * Use outlined style
+     */
     outlined?: boolean;
+    /**
+     * Use text style
+     */
     text?: boolean;
     to?: string | Record<string, any>;
     component?: string;

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

@@ -0,0 +1,13 @@
+interface Props {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Hide the visible text
+     */
+    hideText?: boolean;
+}
+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;
+export default _default;

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

@@ -0,0 +1,35 @@
+/**
+ * This component is used with the `GDetailListItem` component to display
+ * a list of key-value pairs in a grid or vertical layout.
+ *
+ * For example:
+ *
+ * ```vue-html
+ * <GDetailList>
+ *     <GDetailListItem label="Name">John Doe</GDetailListItem>
+ *     <GDetailListItem label="Age">30</GDetailListItem>
+ *     <GDetailListItem label="City">New York</GDetailListItem>
+ * </GDetailList>
+ * ```
+ */
+interface Props {
+    /**
+     * Layout style for the items.
+     */
+    variant?: "grid" | "vertical";
+}
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    variant: "grid" | "vertical";
+}, {}, {}, {}, 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/GHamburgerMenu.vue.d.ts

@@ -0,0 +1,15 @@
+interface Props {
+    /**
+     * Accessible label
+     */
+    label?: string;
+}
+declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    toggle: () => any;
+}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
+    onToggle?: (() => any) | undefined;
+}>, {
+    label: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -0,0 +1,30 @@
+declare const __VLS_export: <T extends {
+    id: string | number;
+}>(__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;
+        entries: T[];
+    }> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {
+        default?: (props: {
+            entry: T;
+        }) => any;
+    };
+    emit: {};
+}>) => 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/GModal.vue.d.ts

@@ -0,0 +1,39 @@
+interface Props {
+    /**
+     * Modal label
+     */
+    label: string;
+    /**
+     * ID for aria-describedby
+     */
+    describedby?: string;
+    /**
+     * Hide label
+     */
+    hiddenLabel?: boolean;
+    /**
+     * Modal size
+     */
+    size?: "small" | "medium" | "large" | "full";
+}
+declare var __VLS_13: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_13) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
+    onClose?: ((...args: any[]) => any) | undefined;
+}>, {
+    size: "small" | "medium" | "large" | "full";
+    hiddenLabel: boolean;
+    describedby: 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/GOverlay.vue.d.ts

@@ -0,0 +1,3 @@
+declare const __VLS_export: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -1,42 +1,34 @@
+interface Props {
+    /**
+     * Render without padding
+     */
+    minimal?: boolean;
+}
+type __VLS_Props = Props;
 declare function toggle(): void;
+type __VLS_ModelProps = {
+    modelValue?: boolean;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
 declare var __VLS_1: {
-    onToggle: typeof toggle;
+    toggle: typeof toggle;
 }, __VLS_9: {};
 type __VLS_Slots = {} & {
     trigger?: (props: typeof __VLS_1) => any;
 } & {
-    content?: (props: typeof __VLS_9) => any;
+    default?: (props: typeof __VLS_9) => any;
 };
-declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    modelValue: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    minimal: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
+declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     show: (...args: any[]) => void;
     hide: (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    modelValue: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    minimal: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}>> & Readonly<{
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "update:modelValue": (value: boolean) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
     onShow?: ((...args: any[]) => any) | undefined;
     onHide?: ((...args: any[]) => any) | undefined;
 }>, {
-    modelValue: boolean;
     minimal: boolean;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, 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;

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

@@ -1,12 +1,21 @@
 type Props = {
+    /**
+     * Accessible label
+     */
+    label?: string;
+    /**
+     * Progress 1-100 or blank
+     */
     value?: number;
-    size?: "small" | "medium" | "large";
-    ariaLabel?: string;
+    /**
+     * Progress circle size
+     */
+    size?: "tiny" | "small" | "medium" | "large";
 };
 declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
-    size: "small" | "medium" | "large";
+    size: "tiny" | "small" | "medium" | "large";
+    label: string;
     value: number;
-    ariaLabel: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

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

@@ -7,18 +7,31 @@ declare const __VLS_export: <T extends {
     id: string | number;
     title: string;
 }>(__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: __VLS_PrettifyLocal<{
-        modelValue: string | null | undefined;
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<({
         results: GSearchGroup<T>[] | T[];
+        /**
+         * Placeholder
+         */
         placeholder?: string;
-        ariaLabel?: string;
+        /**
+         * Accessible label
+         */
+        label?: string;
+        /**
+         * Automatic search
+         */
         auto?: boolean;
-        loading?: boolean | null | undefined;
+        /**
+         * Show search loading indicator
+         */
+        loading?: boolean;
     } & {
-        "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+        modelValue?: string | null;
+    }) & {
+        "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
         onSelect?: ((...args: any[]) => any) | undefined;
         onSubmit?: ((...args: any[]) => any) | undefined;
-    }> & import("vue").PublicProps & (typeof globalThis extends {
+    }> & (typeof globalThis extends {
         __VLS_PROPS_FALLBACK: infer P;
     } ? P : {});
     expose: (exposed: {}) => void;
@@ -36,7 +49,7 @@ declare const __VLS_export: <T extends {
             option: T;
         }) => any;
     };
-    emit: (event: "update:modelValue" | "select" | "submit", ...args: any[]) => 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/GSelect.vue.d.ts

@@ -3,15 +3,47 @@ interface OptionType {
     value: string | number;
 }
 interface Props {
-    modelValue: string | number | undefined | null;
     options: Array<string | OptionType>;
+    /**
+     * Accessible label
+     */
     label: string;
+    /**
+     * Hide the label visually
+     */
     hiddenLabel?: boolean;
+    /**
+     * Placeholder
+     *
+     * Only used if the component is searchable.
+     */
+    placeholder?: string;
+    /**
+     * Disabled
+     */
     disabled?: boolean;
+    /**
+     * Name
+     */
     name?: string;
+    /**
+     * Searchable
+     */
     searchable?: boolean;
+    /**
+     * Show clear button
+     */
     clearButton?: boolean;
+    /**
+     * Compact
+     */
+    compact?: boolean;
 }
+type __VLS_Props = Props;
+type __VLS_ModelProps = {
+    modelValue?: string | number | null;
+};
+type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
 declare var __VLS_1: {
     option: OptionType;
     selected: boolean;
@@ -20,16 +52,17 @@ declare var __VLS_1: {
 type __VLS_Slots = {} & {
     option?: (props: typeof __VLS_1) => any;
 };
-declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     change: (...args: any[]) => void;
-    "update:modelValue": (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
+    "update:modelValue": (value: string | number | null | undefined) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     onChange?: ((...args: any[]) => any) | undefined;
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string | number | null | undefined) => any) | undefined;
 }>, {
     disabled: boolean;
     name: string;
     searchable: boolean;
+    compact: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;

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

@@ -4,22 +4,36 @@ interface OptionType {
 }
 interface Props {
     options: Array<string | OptionType>;
-    modelValue: string | number;
+    /**
+     * Accessible label
+     */
+    label: string;
+    /**
+     * Size
+     */
     size?: "small" | "medium" | "large";
-    theme?: "primary" | "secondary" | "accent" | "danger";
+    /**
+     * Name
+     */
     name?: string;
+    /**
+     * Disabled
+     */
     disabled?: boolean;
-    label: string;
 }
-declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+type __VLS_Props = Props;
+type __VLS_ModelProps = {
+    modelValue?: string | number;
+};
+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": (...args: any[]) => void;
-}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{
+    "update:modelValue": (value: string | number) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     onChange?: ((...args: any[]) => any) | undefined;
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string | number) => any) | undefined;
 }>, {
     size: "small" | "medium" | "large";
-    theme: "primary" | "secondary" | "accent" | "danger";
     disabled: boolean;
     name: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

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

@@ -0,0 +1,42 @@
+interface Props {
+    /**
+     * Custom background color
+     */
+    backgroundColor?: string;
+    /**
+     * Custom background image
+     */
+    backgroundImage?: string;
+    /**
+     * Sidebar theme
+     */
+    theme?: "light" | "dark";
+    topOffset?: string;
+    topOffsetVar?: string;
+    /**
+     * Width
+     *
+     * Width of the sidebar
+     */
+    width?: string;
+}
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    theme: "light" | "dark";
+    width: string;
+    backgroundColor: string;
+    backgroundImage: string;
+    topOffset: string;
+    topOffsetVar: 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;
+    };
+};