@illinois-grad/grad-vue 3.0.5 → 3.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1065,6 +1065,15 @@
1065
1065
  "optional": true,
1066
1066
  "description": "Sidebar channel key for custom elements mode",
1067
1067
  "default": "\"default\""
1068
+ },
1069
+ {
1070
+ "kind": "field",
1071
+ "name": "mediaQuery",
1072
+ "type": {
1073
+ "text": "string"
1074
+ },
1075
+ "optional": true,
1076
+ "description": "Sidebar media query for custom elements mode"
1068
1077
  }
1069
1078
  ],
1070
1079
  "events": [
@@ -1852,6 +1861,15 @@
1852
1861
  "optional": true,
1853
1862
  "description": "Sidebar channel key for custom elements mode",
1854
1863
  "default": "\"default\""
1864
+ },
1865
+ {
1866
+ "kind": "field",
1867
+ "name": "mediaQuery",
1868
+ "type": {
1869
+ "text": "string"
1870
+ },
1871
+ "optional": true,
1872
+ "description": "Sidebar media query for custom elements mode"
1855
1873
  }
1856
1874
  ],
1857
1875
  "events": []
@@ -2867,7 +2885,7 @@
2867
2885
  "text": "string"
2868
2886
  },
2869
2887
  "optional": true,
2870
- "description": "When provided, expanded/collapsed states are saved to `sessionStorage` under this key and restored on page load. Item states are keyed by each the `label` prop."
2888
+ "description": "When provided, expanded/collapsed states are saved to `sessionStorage` under this key and restored on page load. Item states are keyed by each the `label` prop. If the menu is inside a scrollable container such as `GSidebar`, the scroll position is also saved and restored automatically."
2871
2889
  },
2872
2890
  {
2873
2891
  "kind": "field",
@@ -26,7 +26,7 @@
26
26
  * > [!NOTE]
27
27
  * > This button hides itself automatically according to the useSidebar media query.
28
28
  * > In web components mode, use the `sidebar-key` prop to pair this menu with a
29
- * > matching GSidebar instance.
29
+ * > matching GSidebar instance and `media-query` to set the collapsible breakpoint.
30
30
  */
31
31
  declare const _default: typeof __VLS_export;
32
32
  export default _default;
@@ -41,6 +41,11 @@ declare const __VLS_export: import("vue").DefineComponent<{
41
41
  * @demo
42
42
  */
43
43
  sidebarKey?: string;
44
+ /**
45
+ * Sidebar media query for custom elements mode
46
+ * @demo
47
+ */
48
+ mediaQuery?: string;
44
49
  }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
45
50
  toggle: () => any;
46
51
  }, string, import("vue").PublicProps, Readonly<{
@@ -54,6 +59,11 @@ declare const __VLS_export: import("vue").DefineComponent<{
54
59
  * @demo
55
60
  */
56
61
  sidebarKey?: string;
62
+ /**
63
+ * Sidebar media query for custom elements mode
64
+ * @demo
65
+ */
66
+ mediaQuery?: string;
57
67
  }> & Readonly<{
58
68
  onToggle?: (() => any) | undefined;
59
69
  }>, {
@@ -13,7 +13,8 @@
13
13
  * for details.
14
14
  *
15
15
  * In web components mode, use the `sidebar-key` prop to pair this sidebar
16
- * with a matching GHamburgerMenu instance.
16
+ * with a matching GHamburgerMenu instance and `media-query` to set the
17
+ * collapsible breakpoint.
17
18
  */
18
19
  declare const _default: typeof __VLS_export;
19
20
  export default _default;
@@ -53,6 +54,11 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
53
54
  * @demo
54
55
  */
55
56
  sidebarKey?: string;
57
+ /**
58
+ * Sidebar media query for custom elements mode
59
+ * @demo
60
+ */
61
+ mediaQuery?: string;
56
62
  }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
57
63
  /**
58
64
  * Custom background color
@@ -89,6 +95,11 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
89
95
  * @demo
90
96
  */
91
97
  sidebarKey?: string;
98
+ /**
99
+ * Sidebar media query for custom elements mode
100
+ * @demo
101
+ */
102
+ mediaQuery?: string;
92
103
  }> & Readonly<{}>, {
93
104
  width: string;
94
105
  theme: "light" | "dark";
@@ -38,7 +38,9 @@
38
38
  * - `storageKey` - when provided, expanded/collapsed states are persisted to
39
39
  * `sessionStorage` under this key and restored on page load. This is useful
40
40
  * in Web Component / Drupal contexts where every page navigation is a full
41
- * refresh. Item states are keyed by the item's `label` prop.
41
+ * refresh. Item states are keyed by the item's `label` prop. If the menu is
42
+ * inside a scrollable container such as `GSidebar`, the scroll position is
43
+ * also saved and restored automatically.
42
44
  *
43
45
  * **Keyboard navigation** (tree-view style):
44
46
  *
@@ -69,7 +71,8 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
69
71
  /**
70
72
  * When provided, expanded/collapsed states are saved to `sessionStorage`
71
73
  * under this key and restored on page load. Item states are keyed by each
72
- * the `label` prop.
74
+ * the `label` prop. If the menu is inside a scrollable container such as
75
+ * `GSidebar`, the scroll position is also saved and restored automatically.
73
76
  */
74
77
  storageKey?: string;
75
78
  /**
@@ -96,7 +99,8 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
96
99
  /**
97
100
  * When provided, expanded/collapsed states are saved to `sessionStorage`
98
101
  * under this key and restored on page load. Item states are keyed by each
99
- * the `label` prop.
102
+ * the `label` prop. If the menu is inside a scrollable container such as
103
+ * `GSidebar`, the scroll position is also saved and restored automatically.
100
104
  */
101
105
  storageKey?: string;
102
106
  /**
@@ -2,8 +2,9 @@ import { Ref } from "vue";
2
2
  type SidebarChannel = {
3
3
  id: string;
4
4
  open: Ref<boolean>;
5
+ breakpoint: Ref<string>;
5
6
  isCollapsible: Ref<boolean>;
6
7
  toggle: () => void;
7
8
  };
8
- export declare function useWebComponentSidebar(key?: string, breakpoint?: Ref<string> | string): SidebarChannel;
9
+ export declare function useWebComponentSidebar(key?: string, breakpoint?: Ref<string | undefined> | string): SidebarChannel;
9
10
  export {};