@illinois-grad/grad-vue 3.0.14 → 3.0.16

package/custom-elements.json

@@ -1274,6 +1274,16 @@
               "optional": true,
               "description": "Name for form registration"
             },
+            {
+              "kind": "field",
+              "name": "searchDescription",
+              "type": {
+                "text": "boolean"
+              },
+              "optional": true,
+              "description": "Include the option `description` in the searchable text match. Enabled by default; set to `false` to match on the label only.",
+              "default": "true"
+            },
             {
               "kind": "field",
               "name": "errors",
@@ -1628,6 +1638,16 @@
               "description": "Searchable",
               "default": "false"
             },
+            {
+              "kind": "field",
+              "name": "searchDescription",
+              "type": {
+                "text": "boolean"
+              },
+              "optional": true,
+              "description": "Include the option `description` in the searchable text match. Enabled by default; set to `false` to match on the label only.",
+              "default": "true"
+            },
             {
               "kind": "field",
               "name": "clearButton",

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

@@ -8,7 +8,12 @@ import { type SelectOption } from "../compose/useSelectDropdown.ts";
  * next to each selected option.
  *
  * The `options` prop accepts an array of strings or `{ label, value }`
- * objects. The `v-model` binds to an array of `string | number` values.
+ * objects. Options may also include an optional `description`, which renders
+ * as a smaller second line beneath the label in the dropdown. Selected chips
+ * only show the `label` (first part) to keep the control compact. The search
+ * filter matches both the label and the `description`; set `searchDescription`
+ * to `false` to match on the label only. The `v-model` binds to an array of
+ * `string | number` values.
  *
  * In standard Vue usage, this registers with the nearest parent `GForm` via
  * injection. In custom-elements mode, use matching `form-key` values to pair
@@ -58,6 +63,12 @@ declare const __VLS_export: import("vue").DefineComponent<{
      * Name for form registration
      */
     name?: string;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Enabled by default; set to `false` to match on the label only.
+     * @demo
+     */
+    searchDescription?: boolean;
     /**
      * Error messages array (supports multiple validation errors)
      */
@@ -110,6 +121,12 @@ declare const __VLS_export: import("vue").DefineComponent<{
      * Name for form registration
      */
     name?: string;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Enabled by default; set to `false` to match on the label only.
+     * @demo
+     */
+    searchDescription?: boolean;
     /**
      * Error messages array (supports multiple validation errors)
      */
@@ -133,4 +150,5 @@ declare const __VLS_export: import("vue").DefineComponent<{
     required: boolean;
     disabled: boolean;
     hiddenLabel: boolean;
+    searchDescription: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

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

@@ -9,10 +9,15 @@ import { type SelectOption } from "../compose/useSelectDropdown.ts";
  *
  * The component can be marked `searchable` to enable search functionality.
  * This turns it into a text input that filters the options. Filtering is
- * done with a simple lower-case string search.
+ * done with a simple lower-case string search that matches both the option
+ * label and its `description`. Set `searchDescription` to `false` to match
+ * on the label only.
  *
  * The `options` prop can be an array of strings or objects with `label`
- * and `value` properties.
+ * and `value` properties. Options may also include an optional
+ * `description`, which renders as a smaller second line beneath the label
+ * in the dropdown to give extra context (for example a code and its full
+ * name).
  */
 declare const _default: typeof __VLS_export;
 export default _default;
@@ -57,6 +62,12 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
      * @demo
      */
     searchable?: boolean;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Enabled by default; set to `false` to match on the label only.
+     * @demo
+     */
+    searchDescription?: boolean;
     /**
      * Show clear button
      * @demo
@@ -120,6 +131,12 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
      * @demo
      */
     searchable?: boolean;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Enabled by default; set to `false` to match on the label only.
+     * @demo
+     */
+    searchDescription?: boolean;
     /**
      * Show clear button
      * @demo
@@ -146,6 +163,7 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
     errors: string[];
     required: boolean;
     disabled: boolean;
+    searchDescription: boolean;
     searchable: boolean;
     compact: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, {

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

@@ -131,7 +131,8 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
     headingLevel: "h2" | "h3";
     smallHeading: boolean;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, {
-    default?: (props: {}) => any;
+    default?: () => any;
+    heading?: () => any;
 }>;
 type __VLS_WithSlots<T, S> = T & {
     new (): {

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

@@ -5,8 +5,14 @@ export interface SelectColumnFilter {
     options: Array<{
         label: string;
         value: any;
+        description?: string;
     }>;
     placeholder?: string;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Enabled by default; set to `false` to match on the label only.
+     */
+    searchDescription?: boolean;
 }
 export interface SearchColumnFilter {
     type: 'search';
@@ -20,6 +26,7 @@ export interface MultiSelectColumnFilter {
     options: Array<{
         label: string;
         value: any;
+        description?: string;
     }>;
     placeholder?: string;
     /**
@@ -27,6 +34,12 @@ export interface MultiSelectColumnFilter {
      * list of checkboxes. Recommended when there are many options.
      */
     searchable?: boolean;
+    /**
+     * Include the option `description` in the searchable text match.
+     * Only applies when `searchable` is true. Enabled by default; set to
+     * `false` to match on the label only.
+     */
+    searchDescription?: boolean;
 }
 export interface ToggleColumnFilter {
     type: 'toggle';

package/dist/compose/useSelectDropdown.d.ts

@@ -3,10 +3,16 @@ import { type Ref } from "vue";
  * A normalized select option with a label and a value.
  * Both GSelect and GMultiSelect accept `Array<string | SelectOption>` and
  * normalize the strings to this shape internally.
+ *
+ * An optional `description` renders as a smaller second line beneath the
+ * label in the dropdown, useful for adding context to short codes (for
+ * example a college code `KP` with the description
+ * `Grainger College of Engineering`).
  */
 export type SelectOption = {
     label: string;
     value: string | number;
+    description?: string;
 };
 /**
  * Normalizes a mixed `Array<string | SelectOption>` into a uniform