@leafygreen-ui/combobox 8.0.0 → 8.1.1

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 (17) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +1 -1
  3. package/dist/Combobox/Combobox.types.d.ts +2 -2
  4. package/dist/Combobox/Combobox.types.d.ts.map +1 -1
  5. package/package.json +8 -8
  6. package/src/Combobox/Combobox.types.ts +2 -2
  7. package/tsconfig.json +1 -1
  8. package/tsdoc.json +34 -1
  9. package/dist/ComboboxChip/ComboboxChip.stories.d.ts +0 -7
  10. package/dist/ComboboxChip/ComboboxChip.stories.d.ts.map +0 -1
  11. package/dist/ComboboxGroup/ComboboxGroup.stories.d.ts +0 -7
  12. package/dist/ComboboxGroup/ComboboxGroup.stories.d.ts.map +0 -1
  13. package/dist/ComboboxMenu/ComboboxMenu.stories.d.ts +0 -6
  14. package/dist/ComboboxMenu/ComboboxMenu.stories.d.ts.map +0 -1
  15. package/dist/ComboboxOption/ComboboxOption.stories.d.ts +0 -7
  16. package/dist/ComboboxOption/ComboboxOption.stories.d.ts.map +0 -1
  17. /package/src/{Combobox.story.tsx → Combobox.stories.tsx} +0 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @leafygreen-ui/combobox
2
2
 
3
+ ## 8.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - e487fb24: Renames story files from `.story.tsx` to `.stories.tsx`
8
+ - Updated dependencies [8ad4fdbc]
9
+ - Updated dependencies [58f4a4c5]
10
+ - Updated dependencies [5ee54143]
11
+ - Updated dependencies [e487fb24]
12
+ - @leafygreen-ui/popover@11.3.0
13
+ - @leafygreen-ui/typography@18.2.2
14
+ - @leafygreen-ui/tokens@2.5.1
15
+ - @leafygreen-ui/input-option@1.1.1
16
+ - @leafygreen-ui/checkbox@12.1.1
17
+ - @leafygreen-ui/hooks@8.1.2
18
+ - @leafygreen-ui/icon@11.29.1
19
+
20
+ ## 8.1.0
21
+
22
+ ### Minor Changes
23
+
24
+ - 36a8ded2: `description` prop can now be a `React.ReactNode` rather than a `string`
25
+
26
+ ### Patch Changes
27
+
28
+ - Updated dependencies [c2854e9b]
29
+ - Updated dependencies [11d12cc4]
30
+ - @leafygreen-ui/tokens@2.4.0
31
+ - @leafygreen-ui/typography@18.2.1
32
+
3
33
  ## 8.0.0
4
34
 
5
35
  ### Major Changes
package/README.md CHANGED
@@ -87,7 +87,7 @@ import { Combobox, ComboboxOption } from '@leafygreen-ui/combobox';
87
87
  | `overflow` | `'expand-y'`, `'expand-x'`, `'scroll-x'` | Defines the overflow behavior of a multiselect combobox. **expand-y**: Combobox has fixed width, and additional selections will cause the element to grow in the block direction. **expand-x**: Combobox has fixed height, and additional selections will cause the elemenet to grow in the inline direction. **scroll-x**: Combobox has fixed height and width, and additional selections will cause the element to be scrollable in the x (horizontal) direction. | `'expand-y'` |
88
88
  | `label` | `string` | An accessible label for the input, rendered in a `<label>` to the DOM | |
89
89
  | `aria-label` | `string` | An accessible label for the input, used only for screen-readers | |
90
- | `description` | `string` | A description for the input | |
90
+ | `description` | `React.ReactNode` | A description for the input | |
91
91
  | `placeholder` | `string` | A placeholder for the input element. Uses the native `placeholder` attribute. | 'Select' |
92
92
  | `disabled` | `boolean` | Disables all interaction with the component | false |
93
93
  | `size` | `'default'` | Defines the visual size of the component | 'default' |
package/dist/Combobox/Combobox.types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ReactNode } from 'react';
1
+ import React, { ReactNode } from 'react';
2
2
  import { type ChipProps } from '@leafygreen-ui/chip';
3
3
  import { Either, HTMLElementProps } from '@leafygreen-ui/lib';
4
4
  import { PortalControlProps } from '@leafygreen-ui/popover';
@@ -58,7 +58,7 @@ export declare type BaseComboboxProps = Omit<HTMLElementProps<'div'>, 'onChange'
58
58
  /**
59
59
  * A description for the input
60
60
  */
61
- description?: string;
61
+ description?: ReactNode;
62
62
  /**
63
63
  * A placeholder for the input element. Uses the native `placeholder` attribute.
64
64
  */
package/dist/Combobox/Combobox.types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Combobox.types.d.ts","sourceRoot":"","sources":["../../src/Combobox/Combobox.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,eAAe,EACf,KAAK,EACN,MAAM,UAAU,CAAC;AAElB;;GAEG;AAEH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,OAAO;IACzD;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,CAAC,SAAS,IAAI,GAAG,QAAQ,GAAG,SAAS,CAAC;CAClD;AAED,aAAK,gBAAgB,GAAG,IAAI,CAC1B,SAAS,EACT,wBAAwB,GAAG,oBAAoB,GAAG,eAAe,CAClE,CAAC;AAEF,oBAAY,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GACvE,kBAAkB,GAClB,gBAAgB,GAAG;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,UAAU,CAAC,KAAK,IAAI,CAAC;IAEvE;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAE3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEJ,oBAAY,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,MAAM,CACnD,iBAAiB,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAC/C,OAAO,GAAG,YAAY,CACvB,CAAC"}
1
+ {"version":3,"file":"Combobox.types.d.ts","sourceRoot":"","sources":["../../src/Combobox/Combobox.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEzC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,eAAe,EACf,KAAK,EACN,MAAM,UAAU,CAAC;AAElB;;GAEG;AAEH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,OAAO;IACzD;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,CAAC,SAAS,IAAI,GAAG,QAAQ,GAAG,SAAS,CAAC;CAClD;AAED,aAAK,gBAAgB,GAAG,IAAI,CAC1B,SAAS,EACT,wBAAwB,GAAG,oBAAoB,GAAG,eAAe,CAClE,CAAC;AAEF,oBAAY,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GACvE,kBAAkB,GAClB,gBAAgB,GAAG;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,EAAE,UAAU,CAAC,KAAK,IAAI,CAAC;IAEvE;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAE3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEJ,oBAAY,aAAa,CAAC,CAAC,SAAS,OAAO,IAAI,MAAM,CACnD,iBAAiB,GAAG,wBAAwB,CAAC,CAAC,CAAC,EAC/C,OAAO,GAAG,YAAY,CACvB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@leafygreen-ui/combobox",
3
- "version": "8.0.0",
3
+ "version": "8.1.1",
4
4
  "description": "leafyGreen UI Kit Combobox",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/esm/index.js",
@@ -22,19 +22,19 @@
22
22
  "access": "public"
23
23
  },
24
24
  "dependencies": {
25
- "@leafygreen-ui/checkbox": "^12.1.0",
25
+ "@leafygreen-ui/checkbox": "^12.1.1",
26
26
  "@leafygreen-ui/chip": "^1.0.0",
27
27
  "@leafygreen-ui/emotion": "^4.0.7",
28
- "@leafygreen-ui/hooks": "^8.1.1",
29
- "@leafygreen-ui/icon": "^11.23.0",
28
+ "@leafygreen-ui/hooks": "^8.1.2",
29
+ "@leafygreen-ui/icon": "^11.29.1",
30
30
  "@leafygreen-ui/icon-button": "^15.0.19",
31
31
  "@leafygreen-ui/inline-definition": "^6.0.13",
32
- "@leafygreen-ui/input-option": "^1.0.13",
32
+ "@leafygreen-ui/input-option": "^1.1.1",
33
33
  "@leafygreen-ui/lib": "^13.2.1",
34
34
  "@leafygreen-ui/palette": "^4.0.7",
35
- "@leafygreen-ui/popover": "^11.1.1",
36
- "@leafygreen-ui/tokens": "^2.3.0",
37
- "@leafygreen-ui/typography": "^18.2.0",
35
+ "@leafygreen-ui/popover": "^11.3.0",
36
+ "@leafygreen-ui/tokens": "^2.5.1",
37
+ "@leafygreen-ui/typography": "^18.2.2",
38
38
  "chalk": "^4.1.2",
39
39
  "lodash": "^4.17.21",
40
40
  "polished": "^4.2.2"
package/src/Combobox/Combobox.types.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ReactNode } from 'react';
1
+ import React, { ReactNode } from 'react';
2
2
 
3
3
  import { type ChipProps } from '@leafygreen-ui/chip';
4
4
  import { Either, HTMLElementProps } from '@leafygreen-ui/lib';
@@ -80,7 +80,7 @@ export type BaseComboboxProps = Omit<HTMLElementProps<'div'>, 'onChange'> &
80
80
  /**
81
81
  * A description for the input
82
82
  */
83
- description?: string;
83
+ description?: ReactNode;
84
84
 
85
85
  /**
86
86
  * A placeholder for the input element. Uses the native `placeholder` attribute.
package/tsconfig.json CHANGED
@@ -19,7 +19,7 @@
19
19
  ],
20
20
  "exclude": [
21
21
  "**/*.spec.*",
22
- "**/*.story.*"
22
+ "**/*.stories.*"
23
23
  ],
24
24
  "references": [
25
25
  {
package/tsdoc.json CHANGED
@@ -231,7 +231,40 @@
231
231
  "description": "A description for the input",
232
232
  "required": false,
233
233
  "type": {
234
- "name": "string"
234
+ "name": "enum",
235
+ "raw": "ReactNode",
236
+ "value": [
237
+ {
238
+ "value": "string"
239
+ },
240
+ {
241
+ "value": "number"
242
+ },
243
+ {
244
+ "value": "false"
245
+ },
246
+ {
247
+ "value": "true"
248
+ },
249
+ {
250
+ "value": "ReactElement<any, string | JSXElementConstructor<any>>",
251
+ "description": "",
252
+ "fullComment": "",
253
+ "tags": {}
254
+ },
255
+ {
256
+ "value": "Iterable<ReactNode>",
257
+ "description": "",
258
+ "fullComment": "",
259
+ "tags": {}
260
+ },
261
+ {
262
+ "value": "ReactPortal",
263
+ "description": "",
264
+ "fullComment": "",
265
+ "tags": {}
266
+ }
267
+ ]
235
268
  },
236
269
  "tags": {}
237
270
  },
package/dist/ComboboxChip/ComboboxChip.stories.d.ts DELETED
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- import { StoryMetaType } from '@leafygreen-ui/lib';
3
- import { ComboboxChip } from './ComboboxChip';
4
- declare const meta: StoryMetaType<typeof ComboboxChip>;
5
- export default meta;
6
- export declare const Generated: () => React.JSX.Element;
7
- //# sourceMappingURL=ComboboxChip.stories.d.ts.map
package/dist/ComboboxChip/ComboboxChip.stories.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ComboboxChip.stories.d.ts","sourceRoot":"","sources":["../../src/ComboboxChip/ComboboxChip.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,QAAA,MAAM,IAAI,EAAE,aAAa,CAAC,OAAO,YAAY,CAuB5C,CAAC;AACF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,SAAS,yBAAc,CAAC"}
package/dist/ComboboxGroup/ComboboxGroup.stories.d.ts DELETED
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- import { StoryMetaType } from '@leafygreen-ui/lib';
3
- import { InternalComboboxGroup } from './ComboboxGroup';
4
- declare const meta: StoryMetaType<typeof InternalComboboxGroup>;
5
- export default meta;
6
- export declare const Generated: () => React.JSX.Element;
7
- //# sourceMappingURL=ComboboxGroup.stories.d.ts.map
package/dist/ComboboxGroup/ComboboxGroup.stories.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ComboboxGroup.stories.d.ts","sourceRoot":"","sources":["../../src/ComboboxGroup/ComboboxGroup.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAInD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,QAAA,MAAM,IAAI,EAAE,aAAa,CAAC,OAAO,qBAAqB,CAiCrD,CAAC;AACF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,SAAS,yBAAc,CAAC"}
package/dist/ComboboxMenu/ComboboxMenu.stories.d.ts DELETED
@@ -1,6 +0,0 @@
1
- import { StoryMetaType, StoryType } from '@leafygreen-ui/lib';
2
- import { ComboboxMenu } from './ComboboxMenu';
3
- declare const meta: StoryMetaType<typeof ComboboxMenu>;
4
- export default meta;
5
- export declare const Generated: StoryType<typeof ComboboxMenu>;
6
- //# sourceMappingURL=ComboboxMenu.stories.d.ts.map
package/dist/ComboboxMenu/ComboboxMenu.stories.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ComboboxMenu.stories.d.ts","sourceRoot":"","sources":["../../src/ComboboxMenu/ComboboxMenu.stories.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAK9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,QAAA,MAAM,IAAI,EAAE,aAAa,CAAC,OAAO,YAAY,CAwC5C,CAAC;AAEF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,OAAO,YAAY,CAAe,CAAC"}
package/dist/ComboboxOption/ComboboxOption.stories.d.ts DELETED
@@ -1,7 +0,0 @@
1
- import { StoryMetaType, StoryType } from '@leafygreen-ui/lib';
2
- import { InternalComboboxOption } from './ComboboxOption';
3
- declare const meta: StoryMetaType<typeof InternalComboboxOption>;
4
- export default meta;
5
- export declare const WithoutIcons: StoryType<typeof InternalComboboxOption>;
6
- export declare const WithIcons: StoryType<typeof InternalComboboxOption>;
7
- //# sourceMappingURL=ComboboxOption.stories.d.ts.map
package/dist/ComboboxOption/ComboboxOption.stories.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ComboboxOption.stories.d.ts","sourceRoot":"","sources":["../../src/ComboboxOption/ComboboxOption.stories.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,QAAA,MAAM,IAAI,EAAE,aAAa,CAAC,OAAO,sBAAsB,CA+BtD,CAAC;AAEF,eAAe,IAAI,CAAC;AAEpB,eAAO,MAAM,YAAY,EAAE,SAAS,CAAC,OAAO,sBAAsB,CAEjE,CAAC;AAWF,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,OAAO,sBAAsB,CAAe,CAAC"}