@aotearoan/neon 21.0.3 → 22.0.0

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.
Files changed (25) hide show
  1. package/dist/components/user-input/search/NeonSearch.cjs.js +1 -1
  2. package/dist/components/user-input/search/NeonSearch.cjs.js.map +1 -1
  3. package/dist/components/user-input/search/NeonSearch.es.js +95 -82
  4. package/dist/components/user-input/search/NeonSearch.es.js.map +1 -1
  5. package/dist/components/user-input/search/NeonSearch.vue.cjs.js +1 -1
  6. package/dist/components/user-input/search/NeonSearch.vue.cjs.js.map +1 -1
  7. package/dist/components/user-input/search/NeonSearch.vue.es.js +19 -19
  8. package/dist/components/user-input/search/NeonSearch.vue.es.js.map +1 -1
  9. package/dist/components/user-input/toggle/NeonToggle.cjs.js +1 -1
  10. package/dist/components/user-input/toggle/NeonToggle.cjs.js.map +1 -1
  11. package/dist/components/user-input/toggle/NeonToggle.es.js +10 -10
  12. package/dist/components/user-input/toggle/NeonToggle.es.js.map +1 -1
  13. package/dist/components/user-input/toggle/NeonToggle.vue.cjs.js +1 -1
  14. package/dist/components/user-input/toggle/NeonToggle.vue.cjs.js.map +1 -1
  15. package/dist/components/user-input/toggle/NeonToggle.vue.es.js +1 -1
  16. package/dist/components/user-input/toggle/NeonToggle.vue.es.js.map +1 -1
  17. package/dist/src/components/user-input/search/NeonSearch.d.ts +179 -182
  18. package/dist/src/components/user-input/toggle/NeonToggle.d.ts +1 -1
  19. package/package.json +1 -1
  20. package/src/sass/components/_badge.scss +1 -0
  21. package/src/sass/components/_card.scss +7 -7
  22. package/src/sass/components/_skeleton-loader.scss +3 -4
  23. package/src/sass/components/_slider.scss +1 -1
  24. package/src/sass/components/_toggle.scss +9 -3
  25. package/src/sass/variables.scss +10 -7
@@ -13,12 +13,12 @@ import { NeonInputMode } from '@/common/enums/NeonInputMode';
13
13
  */
14
14
  declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
15
15
  /**
16
- * Either a string indicating the key of the selected option ('' if there is no selection) or an array of selected
17
- * NeonSearchOption in the case when multiple = true (necessary to display them as chips).
16
+ * The selected model value(s). In the case of single select this should be set to a single NeonSearchOption or null.
17
+ * In the case of multiple selection (multiple=true) pass an Array of selected NeonSearchOptions or an empty array
18
+ * if nothing is selected.
18
19
  */
19
20
  modelValue: {
20
- type: (StringConstructor | (() => Array<NeonSearchOption>))[];
21
- required: true;
21
+ type: ((() => NeonSearchOption) | (() => Array<NeonSearchOption>))[];
22
22
  };
23
23
  /**
24
24
  * Placeholder to display in search input when there is no search string entered.
@@ -126,7 +126,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
126
126
  default: NeonSize;
127
127
  };
128
128
  color: {
129
- type: () => NeonFunctionalColor;
129
+ type: () => NeonFunctionalColor; /**
130
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
131
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
132
+ */
130
133
  default: NeonFunctionalColor;
131
134
  };
132
135
  alternateColor: {
@@ -139,8 +142,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
139
142
  };
140
143
  placement: {
141
144
  type: () => NeonDropdownPlacement;
142
- default: NeonDropdownPlacement;
143
- };
145
+ default: NeonDropdownPlacement; /**
146
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
147
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
148
+ * for multiple selection an empty array is returned.
149
+ */
150
+ }; /**
151
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
152
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
153
+ * for multiple selection an empty array is returned.
154
+ */
144
155
  placementContainer: {
145
156
  type: () => HTMLElement;
146
157
  default: null;
@@ -229,12 +240,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
229
240
  };
230
241
  imageAlt: {
231
242
  type: StringConstructor;
232
- default: string; /**
233
- * Disable the search
234
- */
235
- }; /**
236
- * Disable the search
237
- */
243
+ default: string;
244
+ };
238
245
  }>, {
239
246
  svg: import("vue").ComputedRef<string | null>;
240
247
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -276,12 +283,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
276
283
  };
277
284
  imageAlt: {
278
285
  type: StringConstructor;
279
- default: string; /**
280
- * Disable the search
281
- */
282
- }; /**
283
- * Disable the search
284
- */
286
+ default: string;
287
+ };
285
288
  }>> & Readonly<{}>, {
286
289
  disabled: boolean;
287
290
  label: string;
@@ -314,9 +317,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
314
317
  }>, {
315
318
  attrs: {
316
319
  [x: string]: unknown;
317
- }; /**
318
- * The color of the search.
319
- */
320
+ };
320
321
  icon: import("vue").ComputedRef<string>;
321
322
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
322
323
  name: {
@@ -370,14 +371,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
370
371
  type: StringConstructor;
371
372
  default: null;
372
373
  };
373
- /**
374
- * Disable the search
375
- */
376
374
  iconAriaLabel: {
377
375
  type: StringConstructor;
378
- }; /**
379
- * The size of the dropdown - Small, Medium or Large.
380
- */
376
+ };
381
377
  iconPosition: {
382
378
  type: () => import("../../../neon").NeonHorizontalPosition;
383
379
  default: import("../../../neon").NeonHorizontalPosition;
@@ -470,14 +466,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
470
466
  type: StringConstructor;
471
467
  default: null;
472
468
  };
473
- /**
474
- * Disable the search
475
- */
476
469
  iconAriaLabel: {
477
470
  type: StringConstructor;
478
- }; /**
479
- * The size of the dropdown - Small, Medium or Large.
480
- */
471
+ };
481
472
  iconPosition: {
482
473
  type: () => import("../../../neon").NeonHorizontalPosition;
483
474
  default: import("../../../neon").NeonHorizontalPosition;
@@ -599,9 +590,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
599
590
  }>, {
600
591
  attrs: {
601
592
  [x: string]: unknown;
602
- }; /**
603
- * The color of the search.
604
- */
593
+ };
605
594
  icon: import("vue").ComputedRef<string>;
606
595
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
607
596
  name: {
@@ -696,9 +685,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
696
685
  }>, {
697
686
  attrs: {
698
687
  [x: string]: unknown;
699
- }; /**
700
- * The color of the search.
701
- */
688
+ };
702
689
  icon: import("vue").ComputedRef<string>;
703
690
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
704
691
  name: {
@@ -811,7 +798,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
811
798
  default: NeonSize;
812
799
  };
813
800
  color: {
814
- type: () => NeonFunctionalColor;
801
+ type: () => NeonFunctionalColor; /**
802
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
803
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
804
+ */
815
805
  default: NeonFunctionalColor;
816
806
  };
817
807
  alternateColor: {
@@ -824,8 +814,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
824
814
  };
825
815
  placement: {
826
816
  type: () => NeonDropdownPlacement;
827
- default: NeonDropdownPlacement;
828
- };
817
+ default: NeonDropdownPlacement; /**
818
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
819
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
820
+ * for multiple selection an empty array is returned.
821
+ */
822
+ }; /**
823
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
824
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
825
+ * for multiple selection an empty array is returned.
826
+ */
829
827
  placementContainer: {
830
828
  type: () => HTMLElement;
831
829
  default: null;
@@ -914,7 +912,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
914
912
  default: NeonSize;
915
913
  };
916
914
  color: {
917
- type: () => NeonFunctionalColor;
915
+ type: () => NeonFunctionalColor; /**
916
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
917
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
918
+ */
918
919
  default: NeonFunctionalColor;
919
920
  };
920
921
  alternateColor: {
@@ -927,8 +928,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
927
928
  };
928
929
  placement: {
929
930
  type: () => NeonDropdownPlacement;
930
- default: NeonDropdownPlacement;
931
- };
931
+ default: NeonDropdownPlacement; /**
932
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
933
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
934
+ * for multiple selection an empty array is returned.
935
+ */
936
+ }; /**
937
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
938
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
939
+ * for multiple selection an empty array is returned.
940
+ */
932
941
  placementContainer: {
933
942
  type: () => HTMLElement;
934
943
  default: null;
@@ -1017,12 +1026,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1017
1026
  };
1018
1027
  imageAlt: {
1019
1028
  type: StringConstructor;
1020
- default: string; /**
1021
- * Disable the search
1022
- */
1023
- }; /**
1024
- * Disable the search
1025
- */
1029
+ default: string;
1030
+ };
1026
1031
  }>, {
1027
1032
  svg: import("vue").ComputedRef<string | null>;
1028
1033
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -1064,12 +1069,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1064
1069
  };
1065
1070
  imageAlt: {
1066
1071
  type: StringConstructor;
1067
- default: string; /**
1068
- * Disable the search
1069
- */
1070
- }; /**
1071
- * Disable the search
1072
- */
1072
+ default: string;
1073
+ };
1073
1074
  }>> & Readonly<{}>, {
1074
1075
  disabled: boolean;
1075
1076
  label: string;
@@ -1102,9 +1103,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1102
1103
  }>, {
1103
1104
  attrs: {
1104
1105
  [x: string]: unknown;
1105
- }; /**
1106
- * The color of the search.
1107
- */
1106
+ };
1108
1107
  icon: import("vue").ComputedRef<string>;
1109
1108
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
1110
1109
  name: {
@@ -1158,14 +1157,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1158
1157
  type: StringConstructor;
1159
1158
  default: null;
1160
1159
  };
1161
- /**
1162
- * Disable the search
1163
- */
1164
1160
  iconAriaLabel: {
1165
1161
  type: StringConstructor;
1166
- }; /**
1167
- * The size of the dropdown - Small, Medium or Large.
1168
- */
1162
+ };
1169
1163
  iconPosition: {
1170
1164
  type: () => import("../../../neon").NeonHorizontalPosition;
1171
1165
  default: import("../../../neon").NeonHorizontalPosition;
@@ -1258,14 +1252,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1258
1252
  type: StringConstructor;
1259
1253
  default: null;
1260
1254
  };
1261
- /**
1262
- * Disable the search
1263
- */
1264
1255
  iconAriaLabel: {
1265
1256
  type: StringConstructor;
1266
- }; /**
1267
- * The size of the dropdown - Small, Medium or Large.
1268
- */
1257
+ };
1269
1258
  iconPosition: {
1270
1259
  type: () => import("../../../neon").NeonHorizontalPosition;
1271
1260
  default: import("../../../neon").NeonHorizontalPosition;
@@ -1387,9 +1376,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1387
1376
  }>, {
1388
1377
  attrs: {
1389
1378
  [x: string]: unknown;
1390
- }; /**
1391
- * The color of the search.
1392
- */
1379
+ };
1393
1380
  icon: import("vue").ComputedRef<string>;
1394
1381
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
1395
1382
  name: {
@@ -1484,9 +1471,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1484
1471
  }>, {
1485
1472
  attrs: {
1486
1473
  [x: string]: unknown;
1487
- }; /**
1488
- * The color of the search.
1489
- */
1474
+ };
1490
1475
  icon: import("vue").ComputedRef<string>;
1491
1476
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
1492
1477
  name: {
@@ -1599,7 +1584,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1599
1584
  default: NeonSize;
1600
1585
  };
1601
1586
  color: {
1602
- type: () => NeonFunctionalColor;
1587
+ type: () => NeonFunctionalColor; /**
1588
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
1589
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
1590
+ */
1603
1591
  default: NeonFunctionalColor;
1604
1592
  };
1605
1593
  alternateColor: {
@@ -1612,8 +1600,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1612
1600
  };
1613
1601
  placement: {
1614
1602
  type: () => NeonDropdownPlacement;
1615
- default: NeonDropdownPlacement;
1616
- };
1603
+ default: NeonDropdownPlacement; /**
1604
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
1605
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
1606
+ * for multiple selection an empty array is returned.
1607
+ */
1608
+ }; /**
1609
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
1610
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
1611
+ * for multiple selection an empty array is returned.
1612
+ */
1617
1613
  placementContainer: {
1618
1614
  type: () => HTMLElement;
1619
1615
  default: null;
@@ -1698,12 +1694,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1698
1694
  };
1699
1695
  state: {
1700
1696
  type: () => import("../../../neon").NeonState;
1701
- default: import("../../../neon").NeonState; /**
1702
- * The color of the search.
1703
- */
1704
- }; /**
1705
- * The color of the search.
1706
- */
1697
+ default: import("../../../neon").NeonState;
1698
+ };
1707
1699
  rows: {
1708
1700
  type: NumberConstructor;
1709
1701
  default: null;
@@ -1713,6 +1705,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1713
1705
  default: null;
1714
1706
  };
1715
1707
  iconReadonly: {
1708
+ /**
1709
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
1710
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
1711
+ */
1716
1712
  type: BooleanConstructor;
1717
1713
  default: boolean;
1718
1714
  };
@@ -1725,7 +1721,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1725
1721
  default: number;
1726
1722
  };
1727
1723
  disabled: {
1728
- type: BooleanConstructor;
1724
+ type: BooleanConstructor; /**
1725
+ * Placement of the dropdown contents.
1726
+ */
1729
1727
  default: boolean;
1730
1728
  };
1731
1729
  stateHighlight: {
@@ -1807,9 +1805,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1807
1805
  }>, {
1808
1806
  attrs: {
1809
1807
  [x: string]: unknown;
1810
- }; /**
1811
- * The color of the search.
1812
- */
1808
+ };
1813
1809
  icon: import("vue").ComputedRef<string>;
1814
1810
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
1815
1811
  name: {
@@ -1875,12 +1871,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1875
1871
  };
1876
1872
  state: {
1877
1873
  type: () => import("../../../neon").NeonState;
1878
- default: import("../../../neon").NeonState; /**
1879
- * The color of the search.
1880
- */
1881
- }; /**
1882
- * The color of the search.
1883
- */
1874
+ default: import("../../../neon").NeonState;
1875
+ };
1884
1876
  rows: {
1885
1877
  type: NumberConstructor;
1886
1878
  default: null;
@@ -1890,6 +1882,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1890
1882
  default: null;
1891
1883
  };
1892
1884
  iconReadonly: {
1885
+ /**
1886
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
1887
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
1888
+ */
1893
1889
  type: BooleanConstructor;
1894
1890
  default: boolean;
1895
1891
  };
@@ -1902,7 +1898,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1902
1898
  default: number;
1903
1899
  };
1904
1900
  disabled: {
1905
- type: BooleanConstructor;
1901
+ type: BooleanConstructor; /**
1902
+ * Placement of the dropdown contents.
1903
+ */
1906
1904
  default: boolean;
1907
1905
  };
1908
1906
  stateHighlight: {
@@ -1998,12 +1996,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
1998
1996
  };
1999
1997
  state: {
2000
1998
  type: () => import("../../../neon").NeonState;
2001
- default: import("../../../neon").NeonState; /**
2002
- * The color of the search.
2003
- */
2004
- }; /**
2005
- * The color of the search.
2006
- */
1999
+ default: import("../../../neon").NeonState;
2000
+ };
2007
2001
  rows: {
2008
2002
  type: NumberConstructor;
2009
2003
  default: null;
@@ -2013,6 +2007,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2013
2007
  default: null;
2014
2008
  };
2015
2009
  iconReadonly: {
2010
+ /**
2011
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
2012
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
2013
+ */
2016
2014
  type: BooleanConstructor;
2017
2015
  default: boolean;
2018
2016
  };
@@ -2025,7 +2023,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2025
2023
  default: number;
2026
2024
  };
2027
2025
  disabled: {
2028
- type: BooleanConstructor;
2026
+ type: BooleanConstructor; /**
2027
+ * Placement of the dropdown contents.
2028
+ */
2029
2029
  default: boolean;
2030
2030
  };
2031
2031
  stateHighlight: {
@@ -2107,9 +2107,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2107
2107
  }>, {
2108
2108
  attrs: {
2109
2109
  [x: string]: unknown;
2110
- }; /**
2111
- * The color of the search.
2112
- */
2110
+ };
2113
2111
  icon: import("vue").ComputedRef<string>;
2114
2112
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
2115
2113
  name: {
@@ -2175,12 +2173,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2175
2173
  };
2176
2174
  state: {
2177
2175
  type: () => import("../../../neon").NeonState;
2178
- default: import("../../../neon").NeonState; /**
2179
- * The color of the search.
2180
- */
2181
- }; /**
2182
- * The color of the search.
2183
- */
2176
+ default: import("../../../neon").NeonState;
2177
+ };
2184
2178
  rows: {
2185
2179
  type: NumberConstructor;
2186
2180
  default: null;
@@ -2190,6 +2184,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2190
2184
  default: null;
2191
2185
  };
2192
2186
  iconReadonly: {
2187
+ /**
2188
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
2189
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
2190
+ */
2193
2191
  type: BooleanConstructor;
2194
2192
  default: boolean;
2195
2193
  };
@@ -2202,7 +2200,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2202
2200
  default: number;
2203
2201
  };
2204
2202
  disabled: {
2205
- type: BooleanConstructor;
2203
+ type: BooleanConstructor; /**
2204
+ * Placement of the dropdown contents.
2205
+ */
2206
2206
  default: boolean;
2207
2207
  };
2208
2208
  stateHighlight: {
@@ -2278,14 +2278,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2278
2278
  changeHighlighted: (key: string) => void;
2279
2279
  showOptions: () => boolean;
2280
2280
  removeSelected: (removed: NeonSearchOption) => void;
2281
+ activeDescendant: import("vue").ComputedRef<string | null>;
2281
2282
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "filter-changed")[], "update:modelValue" | "filter-changed", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
2282
2283
  /**
2283
- * Either a string indicating the key of the selected option ('' if there is no selection) or an array of selected
2284
- * NeonSearchOption in the case when multiple = true (necessary to display them as chips).
2284
+ * The selected model value(s). In the case of single select this should be set to a single NeonSearchOption or null.
2285
+ * In the case of multiple selection (multiple=true) pass an Array of selected NeonSearchOptions or an empty array
2286
+ * if nothing is selected.
2285
2287
  */
2286
2288
  modelValue: {
2287
- type: (StringConstructor | (() => Array<NeonSearchOption>))[];
2288
- required: true;
2289
+ type: ((() => NeonSearchOption) | (() => Array<NeonSearchOption>))[];
2289
2290
  };
2290
2291
  /**
2291
2292
  * Placeholder to display in search input when there is no search string entered.
@@ -2455,9 +2456,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2455
2456
  }>, {
2456
2457
  attrs: {
2457
2458
  [x: string]: unknown;
2458
- }; /**
2459
- * The color of the search.
2460
- */
2459
+ };
2461
2460
  icon: import("vue").ComputedRef<string>;
2462
2461
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
2463
2462
  name: {
@@ -2522,7 +2521,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2522
2521
  default: NeonSize;
2523
2522
  };
2524
2523
  color: {
2525
- type: () => NeonFunctionalColor;
2524
+ type: () => NeonFunctionalColor; /**
2525
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
2526
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
2527
+ */
2526
2528
  default: NeonFunctionalColor;
2527
2529
  };
2528
2530
  alternateColor: {
@@ -2535,8 +2537,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2535
2537
  };
2536
2538
  placement: {
2537
2539
  type: () => NeonDropdownPlacement;
2538
- default: NeonDropdownPlacement;
2539
- };
2540
+ default: NeonDropdownPlacement; /**
2541
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
2542
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
2543
+ * for multiple selection an empty array is returned.
2544
+ */
2545
+ }; /**
2546
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
2547
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
2548
+ * for multiple selection an empty array is returned.
2549
+ */
2540
2550
  placementContainer: {
2541
2551
  type: () => HTMLElement;
2542
2552
  default: null;
@@ -2606,7 +2616,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2606
2616
  default: NeonSize;
2607
2617
  };
2608
2618
  color: {
2609
- type: () => NeonFunctionalColor;
2619
+ type: () => NeonFunctionalColor; /**
2620
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
2621
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
2622
+ */
2610
2623
  default: NeonFunctionalColor;
2611
2624
  };
2612
2625
  alternateColor: {
@@ -2619,8 +2632,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2619
2632
  };
2620
2633
  placement: {
2621
2634
  type: () => NeonDropdownPlacement;
2622
- default: NeonDropdownPlacement;
2623
- };
2635
+ default: NeonDropdownPlacement; /**
2636
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
2637
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
2638
+ * for multiple selection an empty array is returned.
2639
+ */
2640
+ }; /**
2641
+ * @type {NeonSearchOption | NeonSearchOption[] | null} either the selected option (single select) or an array of
2642
+ * the selected options (multi-select). In the case nothing is selected in single select mode <null> is returned &
2643
+ * for multiple selection an empty array is returned.
2644
+ */
2624
2645
  placementContainer: {
2625
2646
  type: () => HTMLElement;
2626
2647
  default: null;
@@ -2688,12 +2709,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2688
2709
  };
2689
2710
  imageAlt: {
2690
2711
  type: StringConstructor;
2691
- default: string; /**
2692
- * Disable the search
2693
- */
2694
- }; /**
2695
- * Disable the search
2696
- */
2712
+ default: string;
2713
+ };
2697
2714
  }>, {
2698
2715
  svg: import("vue").ComputedRef<string | null>;
2699
2716
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -2735,12 +2752,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2735
2752
  };
2736
2753
  imageAlt: {
2737
2754
  type: StringConstructor;
2738
- default: string; /**
2739
- * Disable the search
2740
- */
2741
- }; /**
2742
- * Disable the search
2743
- */
2755
+ default: string;
2756
+ };
2744
2757
  }>> & Readonly<{}>, {
2745
2758
  disabled: boolean;
2746
2759
  label: string;
@@ -2773,9 +2786,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2773
2786
  }>, {
2774
2787
  attrs: {
2775
2788
  [x: string]: unknown;
2776
- }; /**
2777
- * The color of the search.
2778
- */
2789
+ };
2779
2790
  icon: import("vue").ComputedRef<string>;
2780
2791
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
2781
2792
  name: {
@@ -2829,14 +2840,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2829
2840
  type: StringConstructor;
2830
2841
  default: null;
2831
2842
  };
2832
- /**
2833
- * Disable the search
2834
- */
2835
2843
  iconAriaLabel: {
2836
2844
  type: StringConstructor;
2837
- }; /**
2838
- * The size of the dropdown - Small, Medium or Large.
2839
- */
2845
+ };
2840
2846
  iconPosition: {
2841
2847
  type: () => import("../../../neon").NeonHorizontalPosition;
2842
2848
  default: import("../../../neon").NeonHorizontalPosition;
@@ -2929,14 +2935,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
2929
2935
  type: StringConstructor;
2930
2936
  default: null;
2931
2937
  };
2932
- /**
2933
- * Disable the search
2934
- */
2935
2938
  iconAriaLabel: {
2936
2939
  type: StringConstructor;
2937
- }; /**
2938
- * The size of the dropdown - Small, Medium or Large.
2939
- */
2940
+ };
2940
2941
  iconPosition: {
2941
2942
  type: () => import("../../../neon").NeonHorizontalPosition;
2942
2943
  default: import("../../../neon").NeonHorizontalPosition;
@@ -3058,9 +3059,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3058
3059
  }>, {
3059
3060
  attrs: {
3060
3061
  [x: string]: unknown;
3061
- }; /**
3062
- * The color of the search.
3063
- */
3062
+ };
3064
3063
  icon: import("vue").ComputedRef<string>;
3065
3064
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
3066
3065
  name: {
@@ -3155,9 +3154,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3155
3154
  }>, {
3156
3155
  attrs: {
3157
3156
  [x: string]: unknown;
3158
- }; /**
3159
- * The color of the search.
3160
- */
3157
+ };
3161
3158
  icon: import("vue").ComputedRef<string>;
3162
3159
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
3163
3160
  name: {
@@ -3244,9 +3241,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3244
3241
  }>, {
3245
3242
  attrs: {
3246
3243
  [x: string]: unknown;
3247
- }; /**
3248
- * The color of the search.
3249
- */
3244
+ };
3250
3245
  icon: import("vue").ComputedRef<string>;
3251
3246
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
3252
3247
  name: {
@@ -3305,12 +3300,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3305
3300
  };
3306
3301
  state: {
3307
3302
  type: () => import("../../../neon").NeonState;
3308
- default: import("../../../neon").NeonState; /**
3309
- * The color of the search.
3310
- */
3311
- }; /**
3312
- * The color of the search.
3313
- */
3303
+ default: import("../../../neon").NeonState;
3304
+ };
3314
3305
  rows: {
3315
3306
  type: NumberConstructor;
3316
3307
  default: null;
@@ -3320,6 +3311,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3320
3311
  default: null;
3321
3312
  };
3322
3313
  iconReadonly: {
3314
+ /**
3315
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
3316
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
3317
+ */
3323
3318
  type: BooleanConstructor;
3324
3319
  default: boolean;
3325
3320
  };
@@ -3332,7 +3327,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3332
3327
  default: number;
3333
3328
  };
3334
3329
  disabled: {
3335
- type: BooleanConstructor;
3330
+ type: BooleanConstructor; /**
3331
+ * Placement of the dropdown contents.
3332
+ */
3336
3333
  default: boolean;
3337
3334
  };
3338
3335
  stateHighlight: {
@@ -3403,12 +3400,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3403
3400
  };
3404
3401
  state: {
3405
3402
  type: () => import("../../../neon").NeonState;
3406
- default: import("../../../neon").NeonState; /**
3407
- * The color of the search.
3408
- */
3409
- }; /**
3410
- * The color of the search.
3411
- */
3403
+ default: import("../../../neon").NeonState;
3404
+ };
3412
3405
  rows: {
3413
3406
  type: NumberConstructor;
3414
3407
  default: null;
@@ -3418,6 +3411,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3418
3411
  default: null;
3419
3412
  };
3420
3413
  iconReadonly: {
3414
+ /**
3415
+ * The HTML input mode as specified <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode">here</a>.
3416
+ * This can be used to simplify populating the filter field, e.g. providing the user's country from their address.
3417
+ */
3421
3418
  type: BooleanConstructor;
3422
3419
  default: boolean;
3423
3420
  };
@@ -3430,7 +3427,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3430
3427
  default: number;
3431
3428
  };
3432
3429
  disabled: {
3433
- type: BooleanConstructor;
3430
+ type: BooleanConstructor; /**
3431
+ * Placement of the dropdown contents.
3432
+ */
3434
3433
  default: boolean;
3435
3434
  };
3436
3435
  stateHighlight: {
@@ -3495,9 +3494,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
3495
3494
  }>, {
3496
3495
  attrs: {
3497
3496
  [x: string]: unknown;
3498
- }; /**
3499
- * The color of the search.
3500
- */
3497
+ };
3501
3498
  icon: import("vue").ComputedRef<string>;
3502
3499
  }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
3503
3500
  name: {