@illinois-grad/grad-vue 3.0.6 → 3.0.8

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,25 @@
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"
1077
+ },
1078
+ {
1079
+ "kind": "field",
1080
+ "name": "labelVisible",
1081
+ "type": {
1082
+ "text": "boolean"
1083
+ },
1084
+ "optional": true,
1085
+ "description": "Show a visible label",
1086
+ "default": "false"
1068
1087
  }
1069
1088
  ],
1070
1089
  "events": [
@@ -1852,6 +1871,15 @@
1852
1871
  "optional": true,
1853
1872
  "description": "Sidebar channel key for custom elements mode",
1854
1873
  "default": "\"default\""
1874
+ },
1875
+ {
1876
+ "kind": "field",
1877
+ "name": "mediaQuery",
1878
+ "type": {
1879
+ "text": "string"
1880
+ },
1881
+ "optional": true,
1882
+ "description": "Sidebar media query for custom elements mode"
1855
1883
  }
1856
1884
  ],
1857
1885
  "events": []
@@ -2878,6 +2906,26 @@
2878
2906
  "optional": true,
2879
2907
  "description": "Show an expand/collapse all button",
2880
2908
  "default": "false"
2909
+ },
2910
+ {
2911
+ "kind": "field",
2912
+ "name": "headingLevel",
2913
+ "type": {
2914
+ "text": "\"h2\" | \"h3\""
2915
+ },
2916
+ "optional": true,
2917
+ "description": "Heading level for the heading element",
2918
+ "default": "\"h2\""
2919
+ },
2920
+ {
2921
+ "kind": "field",
2922
+ "name": "smallHeading",
2923
+ "type": {
2924
+ "text": "boolean"
2925
+ },
2926
+ "optional": true,
2927
+ "description": "Render the heading in a compact style and omit the divider line",
2928
+ "default": "false"
2881
2929
  }
2882
2930
  ],
2883
2931
  "events": []
@@ -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,16 @@ 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;
49
+ /**
50
+ * Show a visible label
51
+ * @demo
52
+ */
53
+ labelVisible?: boolean;
44
54
  }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
45
55
  toggle: () => any;
46
56
  }, string, import("vue").PublicProps, Readonly<{
@@ -54,9 +64,20 @@ declare const __VLS_export: import("vue").DefineComponent<{
54
64
  * @demo
55
65
  */
56
66
  sidebarKey?: string;
67
+ /**
68
+ * Sidebar media query for custom elements mode
69
+ * @demo
70
+ */
71
+ mediaQuery?: string;
72
+ /**
73
+ * Show a visible label
74
+ * @demo
75
+ */
76
+ labelVisible?: boolean;
57
77
  }> & Readonly<{
58
78
  onToggle?: (() => any) | undefined;
59
79
  }>, {
60
80
  label: string;
61
81
  sidebarKey: string;
82
+ labelVisible: boolean;
62
83
  }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
@@ -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";
@@ -80,6 +80,16 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
80
80
  * @demo
81
81
  */
82
82
  showExpandAll?: boolean;
83
+ /**
84
+ * Heading level for the heading element
85
+ * @demo
86
+ */
87
+ headingLevel?: "h2" | "h3";
88
+ /**
89
+ * Render the heading in a compact style and omit the divider line
90
+ * @demo
91
+ */
92
+ smallHeading?: boolean;
83
93
  }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
84
94
  /**
85
95
  * Heading and accessible name for the nav landmark
@@ -108,10 +118,22 @@ declare const __VLS_export: __VLS_WithSlots<import("vue").DefineComponent<{
108
118
  * @demo
109
119
  */
110
120
  showExpandAll?: boolean;
121
+ /**
122
+ * Heading level for the heading element
123
+ * @demo
124
+ */
125
+ headingLevel?: "h2" | "h3";
126
+ /**
127
+ * Render the heading in a compact style and omit the divider line
128
+ * @demo
129
+ */
130
+ smallHeading?: boolean;
111
131
  }> & Readonly<{}>, {
112
132
  theme: "light" | "dark";
113
133
  listType: "ul" | "ol";
114
134
  showExpandAll: boolean;
135
+ headingLevel: "h2" | "h3";
136
+ smallHeading: boolean;
115
137
  }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, {
116
138
  default?: (props: {}) => any;
117
139
  }>;
@@ -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 {};