@workday/canvas-kit-docs 9.1.20 → 9.1.23

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.
@@ -993,7 +993,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
993
993
  {
994
994
  "name": "useThemeRTL",
995
995
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
996
- "description": "",
996
+ "description": "A helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
997
997
  "declarations": [
998
998
  {
999
999
  "name": "useThemeRTL",
@@ -1001,9 +1001,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1001
1001
  }
1002
1002
  ],
1003
1003
  "tags": {
1004
- "deprecated": "Now that IE11 is no longer supported, we encourage consumers to use [CSS logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)\n\n\nA helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
1005
1004
  "returns": "* `themeRTL` - a function to transform bidirectional styles\n* `theme` - the Canvas theme object (optional, provided for convenience)\n\n`themeRTL` allows you to support bidirectionality with a single set of styles and pass them along to a component.\nIt accepts CSS object styles and transforms CSS attributes based on the content direction set in the theme (LTR or RTL).",
1006
- "example": "import { type } from '@workday/canvas-kit-react/tokens';\nimport { useThemeRTL } from '@workday/canvas-kit-labs-react/common';\n\nconst ErrorText: React.FC = (props) => {\n const { themeRTL, theme } = useThemeRTL();\n // `borderLeft` will be converted to `borderRight`\n // when the theme direction is `RTL`.\n // All other styles will remain unchanged.\n const errorTextStyles = themeRTL({\n ...type.levels.subtext.medium,\n color: theme.canvas.palette.error.main,\n borderLeft: `solid 2px ${theme.canvas.palette.error.main}`,\n });\n\n return <span css={errorTextStyles} {...props} />;\n}"
1005
+ "example": "import { type } from '@workday/canvas-kit-react/tokens';\nimport { useThemeRTL } from '@workday/canvas-kit-labs-react/common';\n\nconst ErrorText: React.FC = (props) => {\n const { themeRTL, theme } = useThemeRTL();\n // `borderLeft` will be converted to `borderRight`\n // when the theme direction is `RTL`.\n // All other styles will remain unchanged.\n const errorTextStyles = themeRTL({\n ...type.levels.subtext.medium,\n color: theme.canvas.palette.error.main,\n borderLeft: `solid 2px ${theme.canvas.palette.error.main}`,\n });\n\n return <span css={errorTextStyles} {...props} />;\n}",
1006
+ "deprecated": "⚠️ `useThemeRTL` has been deprecated and will be removed in a future major version. Now that IE11 is no longer supported, we encourage consumers to use [CSS logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)."
1007
1007
  },
1008
1008
  "type": {
1009
1009
  "kind": "function",
@@ -1450,7 +1450,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1450
1450
  "name": "Property.ObjectFit",
1451
1451
  "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
1452
1452
  },
1453
- "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
1453
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an `<img>` or `<video>`, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
1454
1454
  "declarations": [
1455
1455
  {
1456
1456
  "name": "objectFit",
@@ -7155,14 +7155,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7155
7155
  {
7156
7156
  "name": "DeprecatedMenuProps",
7157
7157
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7158
- "description": "### Deprecated Menu\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
7158
+ "description": "",
7159
7159
  "declarations": [
7160
7160
  {
7161
7161
  "name": "DeprecatedMenuProps",
7162
7162
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
7163
7163
  }
7164
7164
  ],
7165
- "tags": {},
7165
+ "tags": {
7166
+ "deprecated": "⚠️ `DeprecatedMenuProps` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
7167
+ },
7166
7168
  "type": {
7167
7169
  "kind": "alias",
7168
7170
  "name": "DeprecatedMenu"
@@ -7171,14 +7173,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7171
7173
  {
7172
7174
  "name": "DeprecatedMenuState",
7173
7175
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7174
- "description": "### Deprecated Menu State\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
7176
+ "description": "",
7175
7177
  "declarations": [
7176
7178
  {
7177
7179
  "name": "DeprecatedMenuState",
7178
7180
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
7179
7181
  }
7180
7182
  ],
7181
- "tags": {},
7183
+ "tags": {
7184
+ "deprecated": "⚠️ `DeprecatedMenuState` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
7185
+ },
7182
7186
  "type": {
7183
7187
  "kind": "object",
7184
7188
  "properties": [
@@ -7205,7 +7209,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7205
7209
  {
7206
7210
  "name": "DeprecatedMenu",
7207
7211
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7208
- "description": "As of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the [upgrade\nguide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for\nmore information.\n\n`DeprecatedMenu` renders a styled `<ul role=\"menu\">` element within a {@link Card} and follows\nthe [Active Menu\npattern](https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/examples/menu-button-actions-active-descendant/)\nusing `aria-activedescendant`.\n\nUndocumented props are spread to the underlying `<ul>` element.",
7212
+ "description": "`DeprecatedMenu` renders a styled `<ul role=\"menu\">` element within a {@link Card} and follows\nthe [Active Menu\npattern](https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/examples/menu-button-actions-active-descendant/)\nusing `aria-activedescendant`.\n\nUndocumented props are spread to the underlying `<ul>` element.",
7209
7213
  "declarations": [
7210
7214
  {
7211
7215
  "name": "DeprecatedMenu",
@@ -7213,7 +7217,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7213
7217
  }
7214
7218
  ],
7215
7219
  "tags": {
7216
- "deprecated": ""
7220
+ "deprecated": "⚠️ Deprecated Menu has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
7217
7221
  },
7218
7222
  "type": {
7219
7223
  "kind": "component",
@@ -7430,14 +7434,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7430
7434
  {
7431
7435
  "name": "DeprecatedMenuItemProps",
7432
7436
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
7433
- "description": "### Deprecated Menu Item Props\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the\n[upgrade guide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page)\nfor more information.",
7437
+ "description": "",
7434
7438
  "declarations": [
7435
7439
  {
7436
7440
  "name": "DeprecatedMenuItemProps",
7437
7441
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
7438
7442
  }
7439
7443
  ],
7440
- "tags": {},
7444
+ "tags": {
7445
+ "deprecated": "⚠️ `DeprecatedMenuItemProps` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
7446
+ },
7441
7447
  "type": {
7442
7448
  "kind": "alias",
7443
7449
  "name": "DeprecatedMenuItem"
@@ -7446,7 +7452,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7446
7452
  {
7447
7453
  "name": "DeprecatedMenuItem",
7448
7454
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
7449
- "description": "`DeprecatedMenuItem` renders an `<li>` element with the correct attributes to ensure it is\naccessible. If you choose to implement your own custom menu items, be sure to use semantic `<li>`\nelements with the following attributes:\n\n- `role=\"menuitem\"`\n- `tabindex={-1}`\n- `id`s following this pattern: `${MenuId}-${index}`\n\nAs of Canvas Kit v8, Menu is being deprecated.\nIt will be removed in v10. Please see the [upgrade\nguide](https://workday.github.io/canvas-kit/?path=/story/welcome-upgrade-guides-v8-0--page) for\nmore information.\n\nUndocumented props are spread to the underlying `<li>` element.",
7455
+ "description": "`DeprecatedMenuItem` renders an `<li>` element with the correct attributes to ensure it is\naccessible. If you choose to implement your own custom menu items, be sure to use semantic `<li>`\nelements with the following attributes:\n\n- `role=\"menuitem\"`\n- `tabindex={-1}`\n- `id`s following this pattern: `${MenuId}-${index}`\n\nUndocumented props are spread to the underlying `<li>` element.",
7450
7456
  "declarations": [
7451
7457
  {
7452
7458
  "name": "DeprecatedMenuItem",
@@ -7454,7 +7460,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7454
7460
  }
7455
7461
  ],
7456
7462
  "tags": {
7457
- "deprecated": ""
7463
+ "deprecated": "⚠️ `DeprecatedMenuItem` has been deprecated and will be removed in a future major version. Please use [Menu in Main](https://workday.github.io/canvas-kit/?path=/docs/components-popups-menu--basic) instead."
7458
7464
  },
7459
7465
  "type": {
7460
7466
  "kind": "component",
@@ -8130,7 +8136,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
8130
8136
  "name": "Property.ObjectFit",
8131
8137
  "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
8132
8138
  },
8133
- "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
8139
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an `<img>` or `<video>`, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
8134
8140
  "declarations": [
8135
8141
  {
8136
8142
  "name": "objectFit",
@@ -31771,7 +31777,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31771
31777
  }
31772
31778
  ],
31773
31779
  "tags": {
31774
- "deprecated": "Please use `useFormFieldModel` instead"
31780
+ "deprecated": "⚠️ `useTextInputModel` is deprecated and will be removed in a future major version. Please use `useFormFieldModel` instead."
31775
31781
  },
31776
31782
  "type": {
31777
31783
  "kind": "symbol",
@@ -40381,7 +40387,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
40381
40387
  "name": "Property.ObjectFit",
40382
40388
  "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
40383
40389
  },
40384
- "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
40390
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an `<img>` or `<video>`, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
40385
40391
  "declarations": [
40386
40392
  {
40387
40393
  "name": "objectFit",
@@ -42182,48 +42188,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42182
42188
  "kind": "parameter",
42183
42189
  "name": "type",
42184
42190
  "type": {
42185
- "kind": "type",
42186
- "typeParameters": [],
42187
- "value": {
42188
- "kind": "symbol",
42189
- "name": "Exclude",
42190
- "typeParameters": [
42191
- {
42192
- "kind": "union",
42193
- "value": [
42194
- {
42195
- "kind": "string",
42196
- "value": "alert"
42197
- },
42198
- {
42199
- "kind": "string",
42200
- "value": "error"
42201
- },
42202
- {
42203
- "kind": "string",
42204
- "value": "common"
42205
- },
42206
- {
42207
- "kind": "string",
42208
- "value": "primary"
42209
- },
42210
- {
42211
- "kind": "string",
42212
- "value": "success"
42213
- },
42214
- {
42215
- "kind": "string",
42216
- "value": "neutral"
42217
- }
42218
- ]
42219
- },
42220
- {
42221
- "kind": "string",
42222
- "value": "common"
42223
- }
42224
- ],
42225
- "value": "Exclude<T, U>"
42226
- }
42191
+ "kind": "symbol",
42192
+ "name": "paletteSelection",
42193
+ "value": "paletteSelection"
42227
42194
  },
42228
42195
  "required": true,
42229
42196
  "rest": false,
@@ -42333,48 +42300,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42333
42300
  "kind": "parameter",
42334
42301
  "name": "type",
42335
42302
  "type": {
42336
- "kind": "type",
42337
- "typeParameters": [],
42338
- "value": {
42339
- "kind": "symbol",
42340
- "name": "Exclude",
42341
- "typeParameters": [
42342
- {
42343
- "kind": "union",
42344
- "value": [
42345
- {
42346
- "kind": "string",
42347
- "value": "alert"
42348
- },
42349
- {
42350
- "kind": "string",
42351
- "value": "error"
42352
- },
42353
- {
42354
- "kind": "string",
42355
- "value": "common"
42356
- },
42357
- {
42358
- "kind": "string",
42359
- "value": "primary"
42360
- },
42361
- {
42362
- "kind": "string",
42363
- "value": "success"
42364
- },
42365
- {
42366
- "kind": "string",
42367
- "value": "neutral"
42368
- }
42369
- ]
42370
- },
42371
- {
42372
- "kind": "string",
42373
- "value": "common"
42374
- }
42375
- ],
42376
- "value": "Exclude<T, U>"
42377
- }
42303
+ "kind": "symbol",
42304
+ "name": "paletteSelection",
42305
+ "value": "paletteSelection"
42378
42306
  },
42379
42307
  "required": true,
42380
42308
  "rest": false,
@@ -63500,29 +63428,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63500
63428
  "name": "align",
63501
63429
  "required": true,
63502
63430
  "type": {
63503
- "kind": "type",
63504
- "typeParameters": [],
63505
- "value": {
63506
- "kind": "union",
63507
- "value": [
63508
- {
63509
- "kind": "string",
63510
- "value": "start"
63511
- },
63512
- {
63513
- "kind": "string",
63514
- "value": "center"
63515
- },
63516
- {
63517
- "kind": "string",
63518
- "value": "end"
63519
- },
63520
- {
63521
- "kind": "string",
63522
- "value": "auto"
63523
- }
63524
- ]
63525
- }
63431
+ "kind": "symbol",
63432
+ "name": "ScrollAlignment",
63433
+ "value": "ScrollAlignment"
63526
63434
  },
63527
63435
  "description": "",
63528
63436
  "declarations": [
@@ -63555,29 +63463,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63555
63463
  "name": "align",
63556
63464
  "required": true,
63557
63465
  "type": {
63558
- "kind": "type",
63559
- "typeParameters": [],
63560
- "value": {
63561
- "kind": "union",
63562
- "value": [
63563
- {
63564
- "kind": "string",
63565
- "value": "start"
63566
- },
63567
- {
63568
- "kind": "string",
63569
- "value": "center"
63570
- },
63571
- {
63572
- "kind": "string",
63573
- "value": "end"
63574
- },
63575
- {
63576
- "kind": "string",
63577
- "value": "auto"
63578
- }
63579
- ]
63580
- }
63466
+ "kind": "symbol",
63467
+ "name": "ScrollAlignment",
63468
+ "value": "ScrollAlignment"
63581
63469
  },
63582
63470
  "description": "",
63583
63471
  "declarations": [
@@ -63610,29 +63498,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63610
63498
  "name": "align",
63611
63499
  "required": true,
63612
63500
  "type": {
63613
- "kind": "type",
63614
- "typeParameters": [],
63615
- "value": {
63616
- "kind": "union",
63617
- "value": [
63618
- {
63619
- "kind": "string",
63620
- "value": "start"
63621
- },
63622
- {
63623
- "kind": "string",
63624
- "value": "center"
63625
- },
63626
- {
63627
- "kind": "string",
63628
- "value": "end"
63629
- },
63630
- {
63631
- "kind": "string",
63632
- "value": "auto"
63633
- }
63634
- ]
63635
- }
63501
+ "kind": "symbol",
63502
+ "name": "ScrollAlignment",
63503
+ "value": "ScrollAlignment"
63636
63504
  },
63637
63505
  "description": "",
63638
63506
  "declarations": [
@@ -63665,21 +63533,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63665
63533
  "name": "key",
63666
63534
  "required": true,
63667
63535
  "type": {
63668
- "kind": "type",
63669
- "typeParameters": [],
63670
- "value": {
63671
- "kind": "union",
63672
- "value": [
63673
- {
63674
- "kind": "primitive",
63675
- "value": "number"
63676
- },
63677
- {
63678
- "kind": "primitive",
63679
- "value": "string"
63680
- }
63681
- ]
63682
- }
63536
+ "kind": "symbol",
63537
+ "name": "Key",
63538
+ "value": "Key"
63683
63539
  },
63684
63540
  "description": "",
63685
63541
  "declarations": [
@@ -64232,43 +64088,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64232
64088
  ],
64233
64089
  "members": [],
64234
64090
  "returnType": {
64235
- "kind": "object",
64236
- "properties": [
64237
- {
64238
- "kind": "property",
64239
- "name": "width",
64240
- "required": true,
64241
- "type": {
64242
- "kind": "primitive",
64243
- "value": "number"
64244
- },
64245
- "description": "",
64246
- "declarations": [
64247
- {
64248
- "name": "width",
64249
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64250
- }
64251
- ],
64252
- "tags": {}
64253
- },
64254
- {
64255
- "kind": "property",
64256
- "name": "height",
64257
- "required": true,
64258
- "type": {
64259
- "kind": "primitive",
64260
- "value": "number"
64261
- },
64262
- "description": "",
64263
- "declarations": [
64264
- {
64265
- "name": "height",
64266
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64267
- }
64268
- ],
64269
- "tags": {}
64270
- }
64271
- ]
64091
+ "kind": "symbol",
64092
+ "name": "Rect",
64093
+ "value": "Rect"
64272
64094
  }
64273
64095
  },
64274
64096
  "description": "",
@@ -64285,43 +64107,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64285
64107
  "name": "initialRect",
64286
64108
  "required": false,
64287
64109
  "type": {
64288
- "kind": "object",
64289
- "properties": [
64290
- {
64291
- "kind": "property",
64292
- "name": "width",
64293
- "required": true,
64294
- "type": {
64295
- "kind": "primitive",
64296
- "value": "number"
64297
- },
64298
- "description": "",
64299
- "declarations": [
64300
- {
64301
- "name": "width",
64302
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64303
- }
64304
- ],
64305
- "tags": {}
64306
- },
64307
- {
64308
- "kind": "property",
64309
- "name": "height",
64310
- "required": true,
64311
- "type": {
64312
- "kind": "primitive",
64313
- "value": "number"
64314
- },
64315
- "description": "",
64316
- "declarations": [
64317
- {
64318
- "name": "height",
64319
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64320
- }
64321
- ],
64322
- "tags": {}
64323
- }
64324
- ]
64110
+ "kind": "symbol",
64111
+ "name": "Rect",
64112
+ "value": "Rect"
64325
64113
  },
64326
64114
  "description": "",
64327
64115
  "declarations": [
@@ -64360,21 +64148,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64360
64148
  ],
64361
64149
  "members": [],
64362
64150
  "returnType": {
64363
- "kind": "type",
64364
- "typeParameters": [],
64365
- "value": {
64366
- "kind": "union",
64367
- "value": [
64368
- {
64369
- "kind": "primitive",
64370
- "value": "number"
64371
- },
64372
- {
64373
- "kind": "primitive",
64374
- "value": "string"
64375
- }
64376
- ]
64377
- }
64151
+ "kind": "symbol",
64152
+ "name": "Key",
64153
+ "value": "Key"
64378
64154
  }
64379
64155
  },
64380
64156
  "description": "",
@@ -67025,23 +66801,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67025
66801
  "kind": "parameter",
67026
66802
  "name": "model",
67027
66803
  "type": {
67028
- "kind": "type",
67029
- "typeParameters": [],
67030
- "value": {
67031
- "kind": "symbol",
67032
- "name": "Pick",
67033
- "typeParameters": [
67034
- {
67035
- "kind": "symbol",
67036
- "name": "useCursorListModel"
67037
- },
67038
- {
67039
- "kind": "string",
67040
- "value": "state"
67041
- }
67042
- ],
67043
- "value": "Pick<T, K>"
67044
- }
66804
+ "kind": "symbol",
66805
+ "name": "NavigationInput",
66806
+ "value": "NavigationInput"
67045
66807
  },
67046
66808
  "required": true,
67047
66809
  "rest": false,
@@ -67306,23 +67068,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67306
67068
  "kind": "parameter",
67307
67069
  "name": "model",
67308
67070
  "type": {
67309
- "kind": "type",
67310
- "typeParameters": [],
67311
- "value": {
67312
- "kind": "symbol",
67313
- "name": "Pick",
67314
- "typeParameters": [
67315
- {
67316
- "kind": "symbol",
67317
- "name": "useCursorListModel"
67318
- },
67319
- {
67320
- "kind": "string",
67321
- "value": "state"
67322
- }
67323
- ],
67324
- "value": "Pick<T, K>"
67325
- }
67071
+ "kind": "symbol",
67072
+ "name": "NavigationInput",
67073
+ "value": "NavigationInput"
67326
67074
  },
67327
67075
  "required": true,
67328
67076
  "rest": false,
@@ -67505,23 +67253,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67505
67253
  "kind": "parameter",
67506
67254
  "name": "__1",
67507
67255
  "type": {
67508
- "kind": "type",
67509
- "typeParameters": [],
67510
- "value": {
67511
- "kind": "symbol",
67512
- "name": "Pick",
67513
- "typeParameters": [
67514
- {
67515
- "kind": "symbol",
67516
- "name": "useCursorListModel"
67517
- },
67518
- {
67519
- "kind": "string",
67520
- "value": "state"
67521
- }
67522
- ],
67523
- "value": "Pick<T, K>"
67524
- }
67256
+ "kind": "symbol",
67257
+ "name": "NavigationInput",
67258
+ "value": "NavigationInput"
67525
67259
  },
67526
67260
  "required": true,
67527
67261
  "rest": false,
@@ -67628,23 +67362,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67628
67362
  "kind": "parameter",
67629
67363
  "name": "__1",
67630
67364
  "type": {
67631
- "kind": "type",
67632
- "typeParameters": [],
67633
- "value": {
67634
- "kind": "symbol",
67635
- "name": "Pick",
67636
- "typeParameters": [
67637
- {
67638
- "kind": "symbol",
67639
- "name": "useCursorListModel"
67640
- },
67641
- {
67642
- "kind": "string",
67643
- "value": "state"
67644
- }
67645
- ],
67646
- "value": "Pick<T, K>"
67647
- }
67365
+ "kind": "symbol",
67366
+ "name": "NavigationInput",
67367
+ "value": "NavigationInput"
67648
67368
  },
67649
67369
  "required": true,
67650
67370
  "rest": false,
@@ -67771,302 +67491,274 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67771
67491
  "kind": "parameter",
67772
67492
  "name": "model",
67773
67493
  "type": {
67774
- "kind": "type",
67775
- "typeParameters": [],
67776
- "value": {
67777
- "kind": "symbol",
67778
- "name": "Pick",
67779
- "typeParameters": [
67780
- {
67781
- "kind": "symbol",
67782
- "name": "useCursorListModel"
67783
- },
67784
- {
67785
- "kind": "string",
67786
- "value": "state"
67787
- }
67788
- ],
67789
- "value": "Pick<T, K>"
67790
- }
67791
- },
67792
- "required": true,
67793
- "rest": false,
67794
- "description": "",
67795
- "declarations": [
67796
- {
67797
- "name": "model",
67798
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67799
- }
67800
- ],
67801
- "tags": {}
67802
- }
67803
- ],
67804
- "members": [],
67805
- "returnType": {
67806
- "kind": "symbol",
67807
- "name": "Item",
67808
- "typeParameters": [
67809
- {
67810
- "kind": "symbol",
67811
- "name": "Generic",
67812
- "value": "any"
67813
- }
67814
- ],
67815
- "value": "Item<T>"
67816
- }
67817
- },
67818
- "description": "Get an item with the provided `id`.",
67819
- "declarations": [
67820
- {
67821
- "name": "getItem",
67822
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67823
- }
67824
- ],
67825
- "tags": {}
67826
- },
67827
- {
67828
- "kind": "property",
67829
- "name": "getNext",
67830
- "required": true,
67831
- "type": {
67832
- "kind": "symbol",
67833
- "name": "NavigationRequestor",
67834
- "value": "NavigationRequestor"
67835
- },
67836
- "description": "Get the next item after the provided `id`. This will be called when the `Right` arrow key is\npressed for RTL languages and when the `Left` arrow is pressed for LTR languages.",
67837
- "declarations": [
67838
- {
67839
- "name": "getNext",
67840
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67841
- }
67842
- ],
67843
- "tags": {}
67844
- },
67845
- {
67846
- "kind": "property",
67847
- "name": "getNextRow",
67848
- "required": true,
67849
- "type": {
67850
- "kind": "symbol",
67851
- "name": "NavigationRequestor",
67852
- "value": "NavigationRequestor"
67853
- },
67854
- "description": "**For Grids:** Get the cell in the next row from the provided `id`. This will be called when\nthe `Down` arrow is pressed.",
67855
- "declarations": [
67856
- {
67857
- "name": "getNextRow",
67858
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67859
- }
67860
- ],
67861
- "tags": {}
67862
- },
67863
- {
67864
- "kind": "property",
67865
- "name": "getPrevious",
67866
- "required": true,
67867
- "type": {
67868
- "kind": "symbol",
67869
- "name": "NavigationRequestor",
67870
- "value": "NavigationRequestor"
67871
- },
67872
- "description": "Get the previous item before the provided `id`. This will be called when the `Left` arrow key\nis pressed for RTL languages and when the `Right` arrow is pressed for LTR languages.",
67873
- "declarations": [
67874
- {
67875
- "name": "getPrevious",
67876
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67877
- }
67878
- ],
67879
- "tags": {}
67880
- },
67881
- {
67882
- "kind": "property",
67883
- "name": "getPreviousRow",
67884
- "required": true,
67885
- "type": {
67886
- "kind": "symbol",
67887
- "name": "NavigationRequestor",
67888
- "value": "NavigationRequestor"
67889
- },
67890
- "description": "**For Grids:** Get the cell in the previous row from the provided `id`. This will be called\nwhen the `Up` arrow is pressed.",
67891
- "declarations": [
67892
- {
67893
- "name": "getPreviousRow",
67894
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67895
- }
67896
- ],
67897
- "tags": {}
67898
- },
67899
- {
67900
- "kind": "property",
67901
- "name": "getFirstOfRow",
67902
- "required": true,
67903
- "type": {
67904
- "kind": "symbol",
67905
- "name": "NavigationRequestor",
67906
- "value": "NavigationRequestor"
67907
- },
67908
- "description": "**For Grids:** Get the first item in a row. This will be called when the `Home` key is\npressed.",
67909
- "declarations": [
67910
- {
67911
- "name": "getFirstOfRow",
67912
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67913
- }
67914
- ],
67915
- "tags": {}
67916
- },
67917
- {
67918
- "kind": "property",
67919
- "name": "getLastOfRow",
67920
- "required": true,
67921
- "type": {
67922
- "kind": "symbol",
67923
- "name": "NavigationRequestor",
67924
- "value": "NavigationRequestor"
67925
- },
67926
- "description": "**For Grids:** Get the last item in a row. This will be called when the `End` key is\npressed.",
67927
- "declarations": [
67928
- {
67929
- "name": "getLastOfRow",
67930
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67931
- }
67932
- ],
67933
- "tags": {}
67934
- },
67935
- {
67936
- "kind": "property",
67937
- "name": "getNextPage",
67938
- "required": true,
67939
- "type": {
67940
- "kind": "symbol",
67941
- "name": "NavigationRequestor",
67942
- "value": "NavigationRequestor"
67943
- },
67944
- "description": "Get the next \"page\". A \"page\" is application specific and usually means next visible screen.\nIf the viewport is scrollable, it would scroll so that the last item visible is now the first\nitem visible. This is called when the `PageDown` key is pressed",
67945
- "declarations": [
67946
- {
67947
- "name": "getNextPage",
67948
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67949
- }
67950
- ],
67951
- "tags": {}
67952
- },
67953
- {
67954
- "kind": "property",
67955
- "name": "getPreviousPage",
67956
- "required": true,
67957
- "type": {
67958
- "kind": "symbol",
67959
- "name": "NavigationRequestor",
67960
- "value": "NavigationRequestor"
67961
- },
67962
- "description": "Get the next \"page\". A \"page\" is application specific and usually means previous visible\nscreen. If the viewport is scrollable, it would scroll so that the first item visible is now\nthe last item visible. This is called when the `PageUp` key is pressed",
67963
- "declarations": [
67964
- {
67965
- "name": "getPreviousPage",
67966
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67967
- }
67968
- ],
67969
- "tags": {}
67970
- }
67971
- ]
67972
- }
67973
- },
67974
- {
67975
- "name": "navigationManager",
67976
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx",
67977
- "description": "The default navigation of grids. This navigation manager will not wrap, but will stop when an\nedge is detected. This could be the last item in a list or the last item of a row in a grid.",
67978
- "declarations": [
67979
- {
67980
- "name": "navigationManager",
67981
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67982
- }
67983
- ],
67984
- "tags": {},
67985
- "type": {
67986
- "kind": "object",
67987
- "properties": [
67988
- {
67989
- "kind": "property",
67990
- "name": "getFirst",
67991
- "required": true,
67992
- "type": {
67993
- "kind": "symbol",
67994
- "name": "NavigationRequestor",
67995
- "value": "NavigationRequestor"
67996
- },
67997
- "description": "Get the first item in a collection. This will be called when the `Home` key is pressed for\nLists and `Ctrl+Home` for Grids.",
67998
- "declarations": [
67999
- {
68000
- "name": "getFirst",
68001
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68002
- }
68003
- ],
68004
- "tags": {}
68005
- },
68006
- {
68007
- "kind": "property",
68008
- "name": "getLast",
68009
- "required": true,
68010
- "type": {
68011
- "kind": "symbol",
68012
- "name": "NavigationRequestor",
68013
- "value": "NavigationRequestor"
68014
- },
68015
- "description": "Get the last item in a collection. This will be called when the `End` key is pressed for Lists\nand `Ctrl+End` for Grids.",
68016
- "declarations": [
68017
- {
68018
- "name": "getLast",
68019
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68020
- }
68021
- ],
68022
- "tags": {}
68023
- },
68024
- {
68025
- "kind": "property",
68026
- "name": "getItem",
68027
- "required": true,
68028
- "type": {
68029
- "kind": "function",
68030
- "parameters": [
68031
- {
68032
- "kind": "parameter",
68033
- "name": "id",
68034
- "type": {
68035
- "kind": "primitive",
68036
- "value": "string"
68037
- },
68038
- "required": true,
68039
- "rest": false,
68040
- "description": "",
68041
- "declarations": [
68042
- {
68043
- "name": "id",
68044
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68045
- }
68046
- ],
68047
- "tags": {}
68048
- },
68049
- {
68050
- "kind": "parameter",
68051
- "name": "model",
68052
- "type": {
68053
- "kind": "type",
68054
- "typeParameters": [],
68055
- "value": {
68056
- "kind": "symbol",
68057
- "name": "Pick",
68058
- "typeParameters": [
68059
- {
68060
- "kind": "symbol",
68061
- "name": "useCursorListModel"
68062
- },
68063
- {
68064
- "kind": "string",
68065
- "value": "state"
68066
- }
68067
- ],
68068
- "value": "Pick<T, K>"
67494
+ "kind": "symbol",
67495
+ "name": "NavigationInput",
67496
+ "value": "NavigationInput"
67497
+ },
67498
+ "required": true,
67499
+ "rest": false,
67500
+ "description": "",
67501
+ "declarations": [
67502
+ {
67503
+ "name": "model",
67504
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68069
67505
  }
67506
+ ],
67507
+ "tags": {}
67508
+ }
67509
+ ],
67510
+ "members": [],
67511
+ "returnType": {
67512
+ "kind": "symbol",
67513
+ "name": "Item",
67514
+ "typeParameters": [
67515
+ {
67516
+ "kind": "symbol",
67517
+ "name": "Generic",
67518
+ "value": "any"
67519
+ }
67520
+ ],
67521
+ "value": "Item<T>"
67522
+ }
67523
+ },
67524
+ "description": "Get an item with the provided `id`.",
67525
+ "declarations": [
67526
+ {
67527
+ "name": "getItem",
67528
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67529
+ }
67530
+ ],
67531
+ "tags": {}
67532
+ },
67533
+ {
67534
+ "kind": "property",
67535
+ "name": "getNext",
67536
+ "required": true,
67537
+ "type": {
67538
+ "kind": "symbol",
67539
+ "name": "NavigationRequestor",
67540
+ "value": "NavigationRequestor"
67541
+ },
67542
+ "description": "Get the next item after the provided `id`. This will be called when the `Right` arrow key is\npressed for RTL languages and when the `Left` arrow is pressed for LTR languages.",
67543
+ "declarations": [
67544
+ {
67545
+ "name": "getNext",
67546
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67547
+ }
67548
+ ],
67549
+ "tags": {}
67550
+ },
67551
+ {
67552
+ "kind": "property",
67553
+ "name": "getNextRow",
67554
+ "required": true,
67555
+ "type": {
67556
+ "kind": "symbol",
67557
+ "name": "NavigationRequestor",
67558
+ "value": "NavigationRequestor"
67559
+ },
67560
+ "description": "**For Grids:** Get the cell in the next row from the provided `id`. This will be called when\nthe `Down` arrow is pressed.",
67561
+ "declarations": [
67562
+ {
67563
+ "name": "getNextRow",
67564
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67565
+ }
67566
+ ],
67567
+ "tags": {}
67568
+ },
67569
+ {
67570
+ "kind": "property",
67571
+ "name": "getPrevious",
67572
+ "required": true,
67573
+ "type": {
67574
+ "kind": "symbol",
67575
+ "name": "NavigationRequestor",
67576
+ "value": "NavigationRequestor"
67577
+ },
67578
+ "description": "Get the previous item before the provided `id`. This will be called when the `Left` arrow key\nis pressed for RTL languages and when the `Right` arrow is pressed for LTR languages.",
67579
+ "declarations": [
67580
+ {
67581
+ "name": "getPrevious",
67582
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67583
+ }
67584
+ ],
67585
+ "tags": {}
67586
+ },
67587
+ {
67588
+ "kind": "property",
67589
+ "name": "getPreviousRow",
67590
+ "required": true,
67591
+ "type": {
67592
+ "kind": "symbol",
67593
+ "name": "NavigationRequestor",
67594
+ "value": "NavigationRequestor"
67595
+ },
67596
+ "description": "**For Grids:** Get the cell in the previous row from the provided `id`. This will be called\nwhen the `Up` arrow is pressed.",
67597
+ "declarations": [
67598
+ {
67599
+ "name": "getPreviousRow",
67600
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67601
+ }
67602
+ ],
67603
+ "tags": {}
67604
+ },
67605
+ {
67606
+ "kind": "property",
67607
+ "name": "getFirstOfRow",
67608
+ "required": true,
67609
+ "type": {
67610
+ "kind": "symbol",
67611
+ "name": "NavigationRequestor",
67612
+ "value": "NavigationRequestor"
67613
+ },
67614
+ "description": "**For Grids:** Get the first item in a row. This will be called when the `Home` key is\npressed.",
67615
+ "declarations": [
67616
+ {
67617
+ "name": "getFirstOfRow",
67618
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67619
+ }
67620
+ ],
67621
+ "tags": {}
67622
+ },
67623
+ {
67624
+ "kind": "property",
67625
+ "name": "getLastOfRow",
67626
+ "required": true,
67627
+ "type": {
67628
+ "kind": "symbol",
67629
+ "name": "NavigationRequestor",
67630
+ "value": "NavigationRequestor"
67631
+ },
67632
+ "description": "**For Grids:** Get the last item in a row. This will be called when the `End` key is\npressed.",
67633
+ "declarations": [
67634
+ {
67635
+ "name": "getLastOfRow",
67636
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67637
+ }
67638
+ ],
67639
+ "tags": {}
67640
+ },
67641
+ {
67642
+ "kind": "property",
67643
+ "name": "getNextPage",
67644
+ "required": true,
67645
+ "type": {
67646
+ "kind": "symbol",
67647
+ "name": "NavigationRequestor",
67648
+ "value": "NavigationRequestor"
67649
+ },
67650
+ "description": "Get the next \"page\". A \"page\" is application specific and usually means next visible screen.\nIf the viewport is scrollable, it would scroll so that the last item visible is now the first\nitem visible. This is called when the `PageDown` key is pressed",
67651
+ "declarations": [
67652
+ {
67653
+ "name": "getNextPage",
67654
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67655
+ }
67656
+ ],
67657
+ "tags": {}
67658
+ },
67659
+ {
67660
+ "kind": "property",
67661
+ "name": "getPreviousPage",
67662
+ "required": true,
67663
+ "type": {
67664
+ "kind": "symbol",
67665
+ "name": "NavigationRequestor",
67666
+ "value": "NavigationRequestor"
67667
+ },
67668
+ "description": "Get the next \"page\". A \"page\" is application specific and usually means previous visible\nscreen. If the viewport is scrollable, it would scroll so that the first item visible is now\nthe last item visible. This is called when the `PageUp` key is pressed",
67669
+ "declarations": [
67670
+ {
67671
+ "name": "getPreviousPage",
67672
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67673
+ }
67674
+ ],
67675
+ "tags": {}
67676
+ }
67677
+ ]
67678
+ }
67679
+ },
67680
+ {
67681
+ "name": "navigationManager",
67682
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx",
67683
+ "description": "The default navigation of grids. This navigation manager will not wrap, but will stop when an\nedge is detected. This could be the last item in a list or the last item of a row in a grid.",
67684
+ "declarations": [
67685
+ {
67686
+ "name": "navigationManager",
67687
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67688
+ }
67689
+ ],
67690
+ "tags": {},
67691
+ "type": {
67692
+ "kind": "object",
67693
+ "properties": [
67694
+ {
67695
+ "kind": "property",
67696
+ "name": "getFirst",
67697
+ "required": true,
67698
+ "type": {
67699
+ "kind": "symbol",
67700
+ "name": "NavigationRequestor",
67701
+ "value": "NavigationRequestor"
67702
+ },
67703
+ "description": "Get the first item in a collection. This will be called when the `Home` key is pressed for\nLists and `Ctrl+Home` for Grids.",
67704
+ "declarations": [
67705
+ {
67706
+ "name": "getFirst",
67707
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67708
+ }
67709
+ ],
67710
+ "tags": {}
67711
+ },
67712
+ {
67713
+ "kind": "property",
67714
+ "name": "getLast",
67715
+ "required": true,
67716
+ "type": {
67717
+ "kind": "symbol",
67718
+ "name": "NavigationRequestor",
67719
+ "value": "NavigationRequestor"
67720
+ },
67721
+ "description": "Get the last item in a collection. This will be called when the `End` key is pressed for Lists\nand `Ctrl+End` for Grids.",
67722
+ "declarations": [
67723
+ {
67724
+ "name": "getLast",
67725
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67726
+ }
67727
+ ],
67728
+ "tags": {}
67729
+ },
67730
+ {
67731
+ "kind": "property",
67732
+ "name": "getItem",
67733
+ "required": true,
67734
+ "type": {
67735
+ "kind": "function",
67736
+ "parameters": [
67737
+ {
67738
+ "kind": "parameter",
67739
+ "name": "id",
67740
+ "type": {
67741
+ "kind": "primitive",
67742
+ "value": "string"
67743
+ },
67744
+ "required": true,
67745
+ "rest": false,
67746
+ "description": "",
67747
+ "declarations": [
67748
+ {
67749
+ "name": "id",
67750
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67751
+ }
67752
+ ],
67753
+ "tags": {}
67754
+ },
67755
+ {
67756
+ "kind": "parameter",
67757
+ "name": "model",
67758
+ "type": {
67759
+ "kind": "symbol",
67760
+ "name": "NavigationInput",
67761
+ "value": "NavigationInput"
68070
67762
  },
68071
67763
  "required": true,
68072
67764
  "rest": false,
@@ -107499,19 +107191,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107499
107191
  "kind": "typeParameter",
107500
107192
  "name": "T",
107501
107193
  "constraint": {
107502
- "kind": "type",
107503
- "typeParameters": [
107504
- {
107505
- "kind": "typeParameter",
107506
- "name": "T",
107507
- "required": true
107508
- }
107509
- ],
107510
- "value": {
107511
- "kind": "unknown",
107512
- "value": "unknown",
107513
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107514
- }
107194
+ "kind": "symbol",
107195
+ "name": "ResponsiveCSSObject",
107196
+ "value": "ResponsiveCSSObject<T>"
107515
107197
  },
107516
107198
  "required": true
107517
107199
  }
@@ -107521,19 +107203,15 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107521
107203
  "kind": "parameter",
107522
107204
  "name": "styles",
107523
107205
  "type": {
107524
- "kind": "type",
107206
+ "kind": "symbol",
107207
+ "name": "ResponsiveCSSObject",
107525
107208
  "typeParameters": [
107526
107209
  {
107527
- "kind": "typeParameter",
107528
- "name": "T",
107529
- "required": true
107210
+ "kind": "generic",
107211
+ "name": "T"
107530
107212
  }
107531
107213
  ],
107532
- "value": {
107533
- "kind": "unknown",
107534
- "value": "unknown",
107535
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107536
- }
107214
+ "value": "ResponsiveCSSObject<T>"
107537
107215
  },
107538
107216
  "required": true,
107539
107217
  "rest": false,
@@ -109447,19 +109125,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109447
109125
  "kind": "type",
109448
109126
  "typeParameters": [],
109449
109127
  "value": {
109450
- "kind": "type",
109451
- "typeParameters": [
109452
- {
109453
- "kind": "typeParameter",
109454
- "name": "T",
109455
- "required": true
109456
- }
109457
- ],
109458
- "value": {
109459
- "kind": "unknown",
109460
- "value": "unknown",
109461
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109462
- }
109128
+ "kind": "symbol",
109129
+ "name": "RecursivePartial",
109130
+ "value": "RecursivePartial<CanvasTheme>"
109463
109131
  }
109464
109132
  }
109465
109133
  },
@@ -109478,19 +109146,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109478
109146
  "kind": "type",
109479
109147
  "typeParameters": [],
109480
109148
  "value": {
109481
- "kind": "type",
109482
- "typeParameters": [
109483
- {
109484
- "kind": "typeParameter",
109485
- "name": "T",
109486
- "required": true
109487
- }
109488
- ],
109489
- "value": {
109490
- "kind": "unknown",
109491
- "value": "unknown",
109492
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109493
- }
109149
+ "kind": "symbol",
109150
+ "name": "RecursivePartial",
109151
+ "value": "RecursivePartial<CanvasThemePalette>"
109494
109152
  }
109495
109153
  }
109496
109154
  },
@@ -109756,48 +109414,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109756
109414
  "kind": "parameter",
109757
109415
  "name": "type",
109758
109416
  "type": {
109759
- "kind": "type",
109760
- "typeParameters": [],
109761
- "value": {
109762
- "kind": "symbol",
109763
- "name": "Exclude",
109764
- "typeParameters": [
109765
- {
109766
- "kind": "union",
109767
- "value": [
109768
- {
109769
- "kind": "string",
109770
- "value": "alert"
109771
- },
109772
- {
109773
- "kind": "string",
109774
- "value": "error"
109775
- },
109776
- {
109777
- "kind": "string",
109778
- "value": "common"
109779
- },
109780
- {
109781
- "kind": "string",
109782
- "value": "primary"
109783
- },
109784
- {
109785
- "kind": "string",
109786
- "value": "success"
109787
- },
109788
- {
109789
- "kind": "string",
109790
- "value": "neutral"
109791
- }
109792
- ]
109793
- },
109794
- {
109795
- "kind": "string",
109796
- "value": "common"
109797
- }
109798
- ],
109799
- "value": "Exclude<T, U>"
109800
- }
109417
+ "kind": "symbol",
109418
+ "name": "paletteSelection",
109419
+ "value": "paletteSelection"
109801
109420
  },
109802
109421
  "required": true,
109803
109422
  "rest": false,
@@ -109890,48 +109509,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109890
109509
  "kind": "parameter",
109891
109510
  "name": "type",
109892
109511
  "type": {
109893
- "kind": "type",
109894
- "typeParameters": [],
109895
- "value": {
109896
- "kind": "symbol",
109897
- "name": "Exclude",
109898
- "typeParameters": [
109899
- {
109900
- "kind": "union",
109901
- "value": [
109902
- {
109903
- "kind": "string",
109904
- "value": "alert"
109905
- },
109906
- {
109907
- "kind": "string",
109908
- "value": "error"
109909
- },
109910
- {
109911
- "kind": "string",
109912
- "value": "common"
109913
- },
109914
- {
109915
- "kind": "string",
109916
- "value": "primary"
109917
- },
109918
- {
109919
- "kind": "string",
109920
- "value": "success"
109921
- },
109922
- {
109923
- "kind": "string",
109924
- "value": "neutral"
109925
- }
109926
- ]
109927
- },
109928
- {
109929
- "kind": "string",
109930
- "value": "common"
109931
- }
109932
- ],
109933
- "value": "Exclude<T, U>"
109934
- }
109512
+ "kind": "symbol",
109513
+ "name": "paletteSelection",
109514
+ "value": "paletteSelection"
109935
109515
  },
109936
109516
  "required": true,
109937
109517
  "rest": false,
@@ -110719,8 +110299,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
110719
110299
  "name": "React.ComponentProps",
110720
110300
  "typeParameters": [
110721
110301
  {
110722
- "kind": "generic",
110723
- "name": "ElementType"
110302
+ "kind": "symbol",
110303
+ "name": "ElementType",
110304
+ "value": "ElementType"
110724
110305
  }
110725
110306
  ],
110726
110307
  "value": "ComponentProps<T>"
@@ -111865,306 +111446,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
111865
111446
  "kind": "parameter",
111866
111447
  "name": "Component",
111867
111448
  "type": {
111868
- "kind": "function",
111869
- "parameters": [
111870
- {
111871
- "kind": "parameter",
111872
- "name": "props",
111873
- "type": {
111874
- "kind": "type",
111875
- "typeParameters": [
111876
- {
111877
- "kind": "typeParameter",
111878
- "name": "Props",
111879
- "required": true
111880
- },
111881
- {
111882
- "kind": "typeParameter",
111883
- "name": "TElemPropsHook",
111884
- "required": true
111885
- },
111886
- {
111887
- "kind": "typeParameter",
111888
- "name": "E",
111889
- "required": true
111890
- }
111891
- ],
111892
- "value": {
111893
- "kind": "intersection",
111894
- "value": [
111895
- {
111896
- "kind": "generic",
111897
- "name": "Props"
111898
- },
111899
- {
111900
- "kind": "parenthesis",
111901
- "value": {
111902
- "kind": "conditional",
111903
- "check": {
111904
- "kind": "generic",
111905
- "name": "TElemPropsHook"
111906
- },
111907
- "extends": {
111908
- "kind": "function",
111909
- "parameters": [
111910
- {
111911
- "kind": "parameter",
111912
- "name": "args",
111913
- "type": {
111914
- "kind": "array",
111915
- "value": {
111916
- "kind": "primitive",
111917
- "value": "any"
111918
- }
111919
- },
111920
- "required": true,
111921
- "rest": true,
111922
- "description": "",
111923
- "declarations": [
111924
- {
111925
- "name": "args",
111926
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111927
- }
111928
- ],
111929
- "tags": {}
111930
- }
111931
- ],
111932
- "members": [],
111933
- "returnType": {
111934
- "kind": "infer",
111935
- "value": {
111936
- "kind": "typeParameter",
111937
- "name": "TProps",
111938
- "required": true
111939
- }
111940
- }
111941
- },
111942
- "trueType": {
111943
- "kind": "type",
111944
- "typeParameters": [
111945
- {
111946
- "kind": "typeParameter",
111947
- "name": "T",
111948
- "required": true
111949
- }
111950
- ],
111951
- "value": {
111952
- "kind": "unknown",
111953
- "value": "unknown",
111954
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
111955
- }
111956
- },
111957
- "falseType": {
111958
- "kind": "object",
111959
- "properties": [
111960
- {
111961
- "kind": "property",
111962
- "name": "ref",
111963
- "required": true,
111964
- "type": {
111965
- "kind": "generic",
111966
- "name": "ExtractRef"
111967
- },
111968
- "description": "",
111969
- "declarations": [
111970
- {
111971
- "name": "ref",
111972
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111973
- }
111974
- ],
111975
- "tags": {}
111976
- }
111977
- ]
111978
- }
111979
- }
111980
- },
111981
- {
111982
- "kind": "parenthesis",
111983
- "value": {
111984
- "kind": "conditional",
111985
- "check": {
111986
- "kind": "generic",
111987
- "name": "Props"
111988
- },
111989
- "extends": {
111990
- "kind": "object",
111991
- "properties": [
111992
- {
111993
- "kind": "property",
111994
- "name": "children",
111995
- "required": true,
111996
- "type": {
111997
- "kind": "primitive",
111998
- "value": "any"
111999
- },
112000
- "description": "",
112001
- "declarations": [
112002
- {
112003
- "name": "children",
112004
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112005
- }
112006
- ],
112007
- "tags": {}
112008
- }
112009
- ]
112010
- },
112011
- "trueType": {
112012
- "kind": "object",
112013
- "properties": []
112014
- },
112015
- "falseType": {
112016
- "kind": "object",
112017
- "properties": [
112018
- {
112019
- "kind": "property",
112020
- "name": "children",
112021
- "required": false,
112022
- "type": {
112023
- "kind": "external",
112024
- "name": "ReactNode",
112025
- "url": "https://reactjs.org/docs/rendering-elements.html"
112026
- },
112027
- "description": "",
112028
- "declarations": [
112029
- {
112030
- "name": "children",
112031
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112032
- }
112033
- ],
112034
- "tags": {}
112035
- }
112036
- ]
112037
- }
112038
- }
112039
- }
112040
- ]
112041
- }
112042
- },
112043
- "required": true,
112044
- "rest": false,
112045
- "description": "",
112046
- "declarations": [
112047
- {
112048
- "name": "props",
112049
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112050
- }
112051
- ],
112052
- "tags": {}
112053
- },
111449
+ "kind": "component",
111450
+ "props": [
112054
111451
  {
112055
- "kind": "parameter",
112056
- "name": "Element",
112057
- "type": {
112058
- "kind": "conditional",
112059
- "check": {
112060
- "kind": "generic",
112061
- "name": "E"
112062
- },
112063
- "extends": {
112064
- "kind": "primitive",
112065
- "value": "undefined"
112066
- },
112067
- "trueType": {
112068
- "kind": "primitive",
112069
- "value": "never"
112070
- },
112071
- "falseType": {
112072
- "kind": "generic",
112073
- "name": "E"
112074
- }
112075
- },
111452
+ "kind": "property",
111453
+ "name": "ref",
112076
111454
  "required": true,
112077
- "rest": false,
112078
- "description": "",
112079
- "declarations": [
112080
- {
112081
- "name": "Element",
112082
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112083
- }
112084
- ],
112085
- "tags": {}
112086
- },
112087
- {
112088
- "kind": "parameter",
112089
- "name": "model",
112090
111455
  "type": {
112091
- "kind": "conditional",
112092
- "check": {
112093
- "kind": "generic",
112094
- "name": "TModelHook"
112095
- },
112096
- "extends": {
112097
- "kind": "function",
112098
- "parameters": [
112099
- {
112100
- "kind": "parameter",
112101
- "name": "config",
112102
- "type": {
112103
- "kind": "infer",
112104
- "value": {
112105
- "kind": "typeParameter",
112106
- "name": "TConfig",
112107
- "required": true
112108
- }
112109
- },
112110
- "required": true,
112111
- "rest": false,
112112
- "description": "",
112113
- "declarations": [
112114
- {
112115
- "name": "config",
112116
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112117
- }
112118
- ],
112119
- "tags": {}
112120
- }
112121
- ],
112122
- "members": [],
112123
- "returnType": {
112124
- "kind": "infer",
112125
- "value": {
112126
- "kind": "typeParameter",
112127
- "name": "TModel",
112128
- "required": true
112129
- }
112130
- }
112131
- },
112132
- "trueType": {
112133
- "kind": "generic",
112134
- "name": "TModel"
112135
- },
112136
- "falseType": {
112137
- "kind": "primitive",
112138
- "value": "never"
112139
- }
111456
+ "kind": "generic",
111457
+ "name": "ExtractRef"
112140
111458
  },
112141
- "required": true,
112142
- "rest": false,
112143
111459
  "description": "",
112144
111460
  "declarations": [
112145
111461
  {
112146
- "name": "model",
111462
+ "name": "ref",
112147
111463
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112148
111464
  }
112149
111465
  ],
112150
111466
  "tags": {}
112151
111467
  }
112152
- ],
112153
- "members": [],
112154
- "returnType": {
112155
- "kind": "union",
112156
- "value": [
112157
- {
112158
- "kind": "external",
112159
- "name": "Element",
112160
- "url": "https://reactjs.org/docs/rendering-elements.html"
112161
- },
112162
- {
112163
- "kind": "primitive",
112164
- "value": "null"
112165
- }
112166
- ]
112167
- }
111468
+ ]
112168
111469
  },
112169
111470
  "required": true,
112170
111471
  "rest": false,
@@ -112530,7 +111831,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
112530
111831
  }
112531
111832
  ],
112532
111833
  "tags": {
112533
- "deprecated": "You no longer need to use displayName. A `displayName` will be automatically added if it belongs to a container"
111834
+ "deprecated": "⚠️ `displayName` has been deprecated and will be removed in a future major version. You no longer need to use `displayName`. A `displayName` will be automatically added if it belongs to a container."
112534
111835
  }
112535
111836
  },
112536
111837
  {
@@ -112617,305 +111918,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
112617
111918
  "kind": "parameter",
112618
111919
  "name": "Component",
112619
111920
  "type": {
112620
- "kind": "function",
112621
- "parameters": [
112622
- {
112623
- "kind": "parameter",
112624
- "name": "props",
112625
- "type": {
112626
- "kind": "type",
112627
- "typeParameters": [
112628
- {
112629
- "kind": "typeParameter",
112630
- "name": "Props",
112631
- "required": true
112632
- },
112633
- {
112634
- "kind": "typeParameter",
112635
- "name": "TElemPropsHook",
112636
- "required": true
112637
- },
112638
- {
112639
- "kind": "typeParameter",
112640
- "name": "E",
112641
- "required": true
112642
- }
112643
- ],
112644
- "value": {
112645
- "kind": "intersection",
112646
- "value": [
112647
- {
112648
- "kind": "generic",
112649
- "name": "Props"
112650
- },
112651
- {
112652
- "kind": "parenthesis",
112653
- "value": {
112654
- "kind": "conditional",
112655
- "check": {
112656
- "kind": "generic",
112657
- "name": "TElemPropsHook"
112658
- },
112659
- "extends": {
112660
- "kind": "function",
112661
- "parameters": [
112662
- {
112663
- "kind": "parameter",
112664
- "name": "args",
112665
- "type": {
112666
- "kind": "array",
112667
- "value": {
112668
- "kind": "primitive",
112669
- "value": "any"
112670
- }
112671
- },
112672
- "required": true,
112673
- "rest": true,
112674
- "description": "",
112675
- "declarations": [
112676
- {
112677
- "name": "args",
112678
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112679
- }
112680
- ],
112681
- "tags": {}
112682
- }
112683
- ],
112684
- "members": [],
112685
- "returnType": {
112686
- "kind": "infer",
112687
- "value": {
112688
- "kind": "typeParameter",
112689
- "name": "TProps",
112690
- "required": true
112691
- }
112692
- }
112693
- },
112694
- "trueType": {
112695
- "kind": "type",
112696
- "typeParameters": [
112697
- {
112698
- "kind": "typeParameter",
112699
- "name": "T",
112700
- "required": true
112701
- }
112702
- ],
112703
- "value": {
112704
- "kind": "unknown",
112705
- "value": "unknown",
112706
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
112707
- }
112708
- },
112709
- "falseType": {
112710
- "kind": "object",
112711
- "properties": [
112712
- {
112713
- "kind": "property",
112714
- "name": "ref",
112715
- "required": true,
112716
- "type": {
112717
- "kind": "generic",
112718
- "name": "ExtractRef"
112719
- },
112720
- "description": "",
112721
- "declarations": [
112722
- {
112723
- "name": "ref",
112724
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112725
- }
112726
- ],
112727
- "tags": {}
112728
- }
112729
- ]
112730
- }
112731
- }
112732
- },
112733
- {
112734
- "kind": "parenthesis",
112735
- "value": {
112736
- "kind": "conditional",
112737
- "check": {
112738
- "kind": "generic",
112739
- "name": "Props"
112740
- },
112741
- "extends": {
112742
- "kind": "object",
112743
- "properties": [
112744
- {
112745
- "kind": "property",
112746
- "name": "children",
112747
- "required": true,
112748
- "type": {
112749
- "kind": "primitive",
112750
- "value": "any"
112751
- },
112752
- "description": "",
112753
- "declarations": [
112754
- {
112755
- "name": "children",
112756
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112757
- }
112758
- ],
112759
- "tags": {}
112760
- }
112761
- ]
112762
- },
112763
- "trueType": {
112764
- "kind": "object",
112765
- "properties": []
112766
- },
112767
- "falseType": {
112768
- "kind": "object",
112769
- "properties": [
112770
- {
112771
- "kind": "property",
112772
- "name": "children",
112773
- "required": false,
112774
- "type": {
112775
- "kind": "external",
112776
- "name": "ReactNode",
112777
- "url": "https://reactjs.org/docs/rendering-elements.html"
112778
- },
112779
- "description": "",
112780
- "declarations": [
112781
- {
112782
- "name": "children",
112783
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112784
- }
112785
- ],
112786
- "tags": {}
112787
- }
112788
- ]
112789
- }
112790
- }
112791
- }
112792
- ]
112793
- }
112794
- },
112795
- "required": true,
112796
- "rest": false,
112797
- "description": "",
112798
- "declarations": [
112799
- {
112800
- "name": "props",
112801
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112802
- }
112803
- ],
112804
- "tags": {}
112805
- },
111921
+ "kind": "component",
111922
+ "props": [
112806
111923
  {
112807
- "kind": "parameter",
112808
- "name": "Element",
112809
- "type": {
112810
- "kind": "conditional",
112811
- "check": {
112812
- "kind": "generic",
112813
- "name": "E"
112814
- },
112815
- "extends": {
112816
- "kind": "primitive",
112817
- "value": "undefined"
112818
- },
112819
- "trueType": {
112820
- "kind": "primitive",
112821
- "value": "never"
112822
- },
112823
- "falseType": {
112824
- "kind": "generic",
112825
- "name": "E"
112826
- }
112827
- },
111924
+ "kind": "property",
111925
+ "name": "ref",
112828
111926
  "required": true,
112829
- "rest": false,
112830
- "description": "",
112831
- "declarations": [
112832
- {
112833
- "name": "Element",
112834
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112835
- }
112836
- ],
112837
- "tags": {}
112838
- },
112839
- {
112840
- "kind": "parameter",
112841
- "name": "model",
112842
111927
  "type": {
112843
- "kind": "conditional",
112844
- "check": {
112845
- "kind": "generic",
112846
- "name": "TModelHook"
112847
- },
112848
- "extends": {
112849
- "kind": "function",
112850
- "parameters": [
112851
- {
112852
- "kind": "parameter",
112853
- "name": "args",
112854
- "type": {
112855
- "kind": "array",
112856
- "value": {
112857
- "kind": "primitive",
112858
- "value": "any"
112859
- }
112860
- },
112861
- "required": true,
112862
- "rest": true,
112863
- "description": "",
112864
- "declarations": [
112865
- {
112866
- "name": "args",
112867
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112868
- }
112869
- ],
112870
- "tags": {}
112871
- }
112872
- ],
112873
- "members": [],
112874
- "returnType": {
112875
- "kind": "infer",
112876
- "value": {
112877
- "kind": "typeParameter",
112878
- "name": "TModel",
112879
- "required": true
112880
- }
112881
- }
112882
- },
112883
- "trueType": {
112884
- "kind": "generic",
112885
- "name": "TModel"
112886
- },
112887
- "falseType": {
112888
- "kind": "primitive",
112889
- "value": "never"
112890
- }
111928
+ "kind": "generic",
111929
+ "name": "ExtractRef"
112891
111930
  },
112892
- "required": true,
112893
- "rest": false,
112894
111931
  "description": "",
112895
111932
  "declarations": [
112896
111933
  {
112897
- "name": "model",
111934
+ "name": "ref",
112898
111935
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112899
111936
  }
112900
111937
  ],
112901
111938
  "tags": {}
112902
111939
  }
112903
- ],
112904
- "members": [],
112905
- "returnType": {
112906
- "kind": "union",
112907
- "value": [
112908
- {
112909
- "kind": "external",
112910
- "name": "Element",
112911
- "url": "https://reactjs.org/docs/rendering-elements.html"
112912
- },
112913
- {
112914
- "kind": "primitive",
112915
- "value": "null"
112916
- }
112917
- ]
112918
- }
111940
+ ]
112919
111941
  },
112920
111942
  "required": true,
112921
111943
  "rest": false,
@@ -113157,9 +112179,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
113157
112179
  "name": "Component",
113158
112180
  "required": true,
113159
112181
  "type": {
113160
- "kind": "unknown",
113161
- "value": "unknown",
113162
- "text": "interface RefForwardingComponent<T, P = {}> {\n (\n props: React.PropsWithChildren<P>,\n /**\n * A ref to be forwarded. Pass it along to the root element. If no element was passed, this\n * will result in a `never`\n */\n ref: ExtractRef<T>,\n /**\n * An element - either a JSX element or a `ElementComponent`. This should be passed as an `as`\n * to a root element or be the root element. If no element was passed, this will result in a\n * `never`\n */\n Element: T extends undefined ? never : T\n ): JSX.Element | null;\n}"
112182
+ "kind": "symbol",
112183
+ "name": "RefForwardingComponent",
112184
+ "value": "RefForwardingComponent<E, P>"
113163
112185
  },
113164
112186
  "description": "The component function. The function looks like:",
113165
112187
  "declarations": [
@@ -113762,7 +112784,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
113762
112784
  }
113763
112785
  ],
113764
112786
  "tags": {
113765
- "deprecated": "use `createSubModelElemPropsHook` instead"
112787
+ "deprecated": "⚠️ `subModelHook` has been deprecated and will be removed in a future major version. Please use `createSubModelElemPropsHook` instead."
113766
112788
  },
113767
112789
  "type": {
113768
112790
  "kind": "function",
@@ -115026,78 +114048,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115026
114048
  "name": "H2"
115027
114049
  },
115028
114050
  "extends": {
115029
- "kind": "object",
115030
- "properties": [
114051
+ "kind": "symbol",
114052
+ "name": "BaseHook",
114053
+ "typeParameters": [
115031
114054
  {
115032
- "kind": "property",
115033
- "name": "__model",
115034
- "required": true,
115035
- "type": {
115036
- "kind": "generic",
115037
- "name": "M"
115038
- },
115039
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115040
- "declarations": [
115041
- {
115042
- "name": "__model",
115043
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115044
- }
115045
- ],
115046
- "tags": {
115047
- "private": ""
115048
- }
114055
+ "kind": "primitive",
114056
+ "value": "any"
115049
114057
  },
115050
114058
  {
115051
- "kind": "property",
115052
- "name": "__output",
115053
- "required": true,
115054
- "type": {
115055
- "kind": "generic",
115056
- "name": "O"
115057
- },
115058
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115059
- "declarations": [
115060
- {
115061
- "name": "__output",
115062
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115063
- }
115064
- ],
115065
- "tags": {
115066
- "private": ""
114059
+ "kind": "infer",
114060
+ "value": {
114061
+ "kind": "typeParameter",
114062
+ "name": "O2",
114063
+ "required": true
115067
114064
  }
115068
114065
  }
115069
114066
  ],
115070
- "typeParameters": [
115071
- {
115072
- "kind": "typeParameter",
115073
- "name": "M",
115074
- "constraint": {
115075
- "kind": "symbol",
115076
- "name": "Model",
115077
- "typeParameters": [
115078
- {
115079
- "kind": "primitive",
115080
- "value": "any"
115081
- },
115082
- {
115083
- "kind": "primitive",
115084
- "value": "any"
115085
- }
115086
- ],
115087
- "value": "Model<State, Events>"
115088
- },
115089
- "required": true
115090
- },
115091
- {
115092
- "kind": "typeParameter",
115093
- "name": "O",
115094
- "constraint": {
115095
- "kind": "object",
115096
- "properties": []
115097
- },
115098
- "required": true
115099
- }
115100
- ]
114067
+ "value": "BaseHook<M, O>"
115101
114068
  },
115102
114069
  "trueType": {
115103
114070
  "kind": "conditional",
@@ -115106,78 +114073,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115106
114073
  "name": "H3"
115107
114074
  },
115108
114075
  "extends": {
115109
- "kind": "object",
115110
- "properties": [
114076
+ "kind": "symbol",
114077
+ "name": "BaseHook",
114078
+ "typeParameters": [
115111
114079
  {
115112
- "kind": "property",
115113
- "name": "__model",
115114
- "required": true,
115115
- "type": {
115116
- "kind": "generic",
115117
- "name": "M"
115118
- },
115119
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115120
- "declarations": [
115121
- {
115122
- "name": "__model",
115123
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115124
- }
115125
- ],
115126
- "tags": {
115127
- "private": ""
115128
- }
114080
+ "kind": "primitive",
114081
+ "value": "any"
115129
114082
  },
115130
114083
  {
115131
- "kind": "property",
115132
- "name": "__output",
115133
- "required": true,
115134
- "type": {
115135
- "kind": "generic",
115136
- "name": "O"
115137
- },
115138
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115139
- "declarations": [
115140
- {
115141
- "name": "__output",
115142
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115143
- }
115144
- ],
115145
- "tags": {
115146
- "private": ""
114084
+ "kind": "infer",
114085
+ "value": {
114086
+ "kind": "typeParameter",
114087
+ "name": "O3",
114088
+ "required": true
115147
114089
  }
115148
114090
  }
115149
114091
  ],
115150
- "typeParameters": [
115151
- {
115152
- "kind": "typeParameter",
115153
- "name": "M",
115154
- "constraint": {
115155
- "kind": "symbol",
115156
- "name": "Model",
115157
- "typeParameters": [
115158
- {
115159
- "kind": "primitive",
115160
- "value": "any"
115161
- },
115162
- {
115163
- "kind": "primitive",
115164
- "value": "any"
115165
- }
115166
- ],
115167
- "value": "Model<State, Events>"
115168
- },
115169
- "required": true
115170
- },
115171
- {
115172
- "kind": "typeParameter",
115173
- "name": "O",
115174
- "constraint": {
115175
- "kind": "object",
115176
- "properties": []
115177
- },
115178
- "required": true
115179
- }
115180
- ]
114092
+ "value": "BaseHook<M, O>"
115181
114093
  },
115182
114094
  "trueType": {
115183
114095
  "kind": "conditional",
@@ -115186,78 +114098,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115186
114098
  "name": "H4"
115187
114099
  },
115188
114100
  "extends": {
115189
- "kind": "object",
115190
- "properties": [
114101
+ "kind": "symbol",
114102
+ "name": "BaseHook",
114103
+ "typeParameters": [
115191
114104
  {
115192
- "kind": "property",
115193
- "name": "__model",
115194
- "required": true,
115195
- "type": {
115196
- "kind": "generic",
115197
- "name": "M"
115198
- },
115199
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115200
- "declarations": [
115201
- {
115202
- "name": "__model",
115203
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115204
- }
115205
- ],
115206
- "tags": {
115207
- "private": ""
115208
- }
114105
+ "kind": "primitive",
114106
+ "value": "any"
115209
114107
  },
115210
114108
  {
115211
- "kind": "property",
115212
- "name": "__output",
115213
- "required": true,
115214
- "type": {
115215
- "kind": "generic",
115216
- "name": "O"
115217
- },
115218
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115219
- "declarations": [
115220
- {
115221
- "name": "__output",
115222
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115223
- }
115224
- ],
115225
- "tags": {
115226
- "private": ""
114109
+ "kind": "infer",
114110
+ "value": {
114111
+ "kind": "typeParameter",
114112
+ "name": "O4",
114113
+ "required": true
115227
114114
  }
115228
114115
  }
115229
114116
  ],
115230
- "typeParameters": [
115231
- {
115232
- "kind": "typeParameter",
115233
- "name": "M",
115234
- "constraint": {
115235
- "kind": "symbol",
115236
- "name": "Model",
115237
- "typeParameters": [
115238
- {
115239
- "kind": "primitive",
115240
- "value": "any"
115241
- },
115242
- {
115243
- "kind": "primitive",
115244
- "value": "any"
115245
- }
115246
- ],
115247
- "value": "Model<State, Events>"
115248
- },
115249
- "required": true
115250
- },
115251
- {
115252
- "kind": "typeParameter",
115253
- "name": "O",
115254
- "constraint": {
115255
- "kind": "object",
115256
- "properties": []
115257
- },
115258
- "required": true
115259
- }
115260
- ]
114117
+ "value": "BaseHook<M, O>"
115261
114118
  },
115262
114119
  "trueType": {
115263
114120
  "kind": "conditional",
@@ -115266,78 +114123,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115266
114123
  "name": "H5"
115267
114124
  },
115268
114125
  "extends": {
115269
- "kind": "object",
115270
- "properties": [
114126
+ "kind": "symbol",
114127
+ "name": "BaseHook",
114128
+ "typeParameters": [
115271
114129
  {
115272
- "kind": "property",
115273
- "name": "__model",
115274
- "required": true,
115275
- "type": {
115276
- "kind": "generic",
115277
- "name": "M"
115278
- },
115279
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115280
- "declarations": [
115281
- {
115282
- "name": "__model",
115283
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115284
- }
115285
- ],
115286
- "tags": {
115287
- "private": ""
115288
- }
114130
+ "kind": "primitive",
114131
+ "value": "any"
115289
114132
  },
115290
114133
  {
115291
- "kind": "property",
115292
- "name": "__output",
115293
- "required": true,
115294
- "type": {
115295
- "kind": "generic",
115296
- "name": "O"
115297
- },
115298
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115299
- "declarations": [
115300
- {
115301
- "name": "__output",
115302
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115303
- }
115304
- ],
115305
- "tags": {
115306
- "private": ""
114134
+ "kind": "infer",
114135
+ "value": {
114136
+ "kind": "typeParameter",
114137
+ "name": "O5",
114138
+ "required": true
115307
114139
  }
115308
114140
  }
115309
114141
  ],
115310
- "typeParameters": [
115311
- {
115312
- "kind": "typeParameter",
115313
- "name": "M",
115314
- "constraint": {
115315
- "kind": "symbol",
115316
- "name": "Model",
115317
- "typeParameters": [
115318
- {
115319
- "kind": "primitive",
115320
- "value": "any"
115321
- },
115322
- {
115323
- "kind": "primitive",
115324
- "value": "any"
115325
- }
115326
- ],
115327
- "value": "Model<State, Events>"
115328
- },
115329
- "required": true
115330
- },
115331
- {
115332
- "kind": "typeParameter",
115333
- "name": "O",
115334
- "constraint": {
115335
- "kind": "object",
115336
- "properties": []
115337
- },
115338
- "required": true
115339
- }
115340
- ]
114142
+ "value": "BaseHook<M, O>"
115341
114143
  },
115342
114144
  "trueType": {
115343
114145
  "kind": "conditional",
@@ -115346,78 +114148,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115346
114148
  "name": "H6"
115347
114149
  },
115348
114150
  "extends": {
115349
- "kind": "object",
115350
- "properties": [
114151
+ "kind": "symbol",
114152
+ "name": "BaseHook",
114153
+ "typeParameters": [
115351
114154
  {
115352
- "kind": "property",
115353
- "name": "__model",
115354
- "required": true,
115355
- "type": {
115356
- "kind": "generic",
115357
- "name": "M"
115358
- },
115359
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115360
- "declarations": [
115361
- {
115362
- "name": "__model",
115363
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115364
- }
115365
- ],
115366
- "tags": {
115367
- "private": ""
115368
- }
114155
+ "kind": "primitive",
114156
+ "value": "any"
115369
114157
  },
115370
114158
  {
115371
- "kind": "property",
115372
- "name": "__output",
115373
- "required": true,
115374
- "type": {
115375
- "kind": "generic",
115376
- "name": "O"
115377
- },
115378
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115379
- "declarations": [
115380
- {
115381
- "name": "__output",
115382
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115383
- }
115384
- ],
115385
- "tags": {
115386
- "private": ""
114159
+ "kind": "infer",
114160
+ "value": {
114161
+ "kind": "typeParameter",
114162
+ "name": "O6",
114163
+ "required": true
115387
114164
  }
115388
114165
  }
115389
114166
  ],
115390
- "typeParameters": [
115391
- {
115392
- "kind": "typeParameter",
115393
- "name": "M",
115394
- "constraint": {
115395
- "kind": "symbol",
115396
- "name": "Model",
115397
- "typeParameters": [
115398
- {
115399
- "kind": "primitive",
115400
- "value": "any"
115401
- },
115402
- {
115403
- "kind": "primitive",
115404
- "value": "any"
115405
- }
115406
- ],
115407
- "value": "Model<State, Events>"
115408
- },
115409
- "required": true
115410
- },
115411
- {
115412
- "kind": "typeParameter",
115413
- "name": "O",
115414
- "constraint": {
115415
- "kind": "object",
115416
- "properties": []
115417
- },
115418
- "required": true
115419
- }
115420
- ]
114167
+ "value": "BaseHook<M, O>"
115421
114168
  },
115422
114169
  "trueType": {
115423
114170
  "kind": "symbol",
@@ -116615,7 +115362,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116615
115362
  }
116616
115363
  ],
116617
115364
  "tags": {
116618
- "deprecated": "The returned model is now inferred from `createModelHook`"
115365
+ "deprecated": "⚠️ `Model` has been deprecated and will be removed in a future major version. The returned model is now inferred from `createModelHook`."
116619
115366
  },
116620
115367
  "type": {
116621
115368
  "kind": "object",
@@ -116722,7 +115469,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116722
115469
  ],
116723
115470
  "tags": {
116724
115471
  "example": "type ModelConfig = {\n // additional config your model requires goes here\n id?: string\n} & Partial<ToModelConfig<State, Events, typeof eventMap>>",
116725
- "deprecated": "`createModelHook` now infers the config type"
115472
+ "deprecated": "⚠️ `ToModelConfig` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead since it infers the config type."
116726
115473
  },
116727
115474
  "type": {
116728
115475
  "kind": "type",
@@ -116839,45 +115586,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116839
115586
  "kind": "typeParameter",
116840
115587
  "name": "TEvents",
116841
115588
  "constraint": {
116842
- "kind": "object",
116843
- "properties": [],
116844
- "indexSignature": {
116845
- "kind": "indexSignature",
116846
- "name": "key",
116847
- "type": {
116848
- "kind": "primitive",
116849
- "value": "string"
116850
- },
116851
- "value": {
116852
- "kind": "function",
116853
- "parameters": [
116854
- {
116855
- "kind": "parameter",
116856
- "name": "data",
116857
- "type": {
116858
- "kind": "unknown",
116859
- "value": "unknown",
116860
- "text": "object"
116861
- },
116862
- "required": false,
116863
- "rest": false,
116864
- "description": "",
116865
- "declarations": [
116866
- {
116867
- "name": "data",
116868
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116869
- }
116870
- ],
116871
- "tags": {}
116872
- }
116873
- ],
116874
- "members": [],
116875
- "returnType": {
116876
- "kind": "primitive",
116877
- "value": "void"
116878
- }
116879
- }
116880
- }
115589
+ "kind": "symbol",
115590
+ "name": "IEvent",
115591
+ "value": "IEvent"
116881
115592
  },
116882
115593
  "required": true
116883
115594
  },
@@ -116932,198 +115643,14 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116932
115643
  "kind": "intersection",
116933
115644
  "value": [
116934
115645
  {
116935
- "kind": "type",
116936
- "typeParameters": [
116937
- {
116938
- "kind": "typeParameter",
116939
- "name": "TState",
116940
- "constraint": {
116941
- "kind": "external",
116942
- "name": "Record",
116943
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116944
- "typeParameters": [
116945
- {
116946
- "kind": "primitive",
116947
- "value": "string"
116948
- },
116949
- {
116950
- "kind": "primitive",
116951
- "value": "any"
116952
- }
116953
- ]
116954
- },
116955
- "required": true
116956
- },
116957
- {
116958
- "kind": "typeParameter",
116959
- "name": "TEvents",
116960
- "constraint": {
116961
- "kind": "object",
116962
- "properties": [],
116963
- "indexSignature": {
116964
- "kind": "indexSignature",
116965
- "name": "key",
116966
- "type": {
116967
- "kind": "primitive",
116968
- "value": "string"
116969
- },
116970
- "value": {
116971
- "kind": "function",
116972
- "parameters": [
116973
- {
116974
- "kind": "parameter",
116975
- "name": "data",
116976
- "type": {
116977
- "kind": "unknown",
116978
- "value": "unknown",
116979
- "text": "object"
116980
- },
116981
- "required": false,
116982
- "rest": false,
116983
- "description": "",
116984
- "declarations": [
116985
- {
116986
- "name": "data",
116987
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116988
- }
116989
- ],
116990
- "tags": {}
116991
- }
116992
- ],
116993
- "members": [],
116994
- "returnType": {
116995
- "kind": "primitive",
116996
- "value": "void"
116997
- }
116998
- }
116999
- }
117000
- },
117001
- "required": true
117002
- },
117003
- {
117004
- "kind": "typeParameter",
117005
- "name": "TGuardMap",
117006
- "constraint": {
117007
- "kind": "external",
117008
- "name": "Record",
117009
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117010
- "typeParameters": [
117011
- {
117012
- "kind": "primitive",
117013
- "value": "string"
117014
- },
117015
- {
117016
- "kind": "unknown",
117017
- "value": "unknown",
117018
- "text": "keyof TEvents"
117019
- }
117020
- ]
117021
- },
117022
- "required": true
117023
- }
117024
- ],
117025
- "value": {
117026
- "kind": "unknown",
117027
- "value": "unknown",
117028
- "text": "{\n [K in keyof TGuardMap]: (event: {\n data: Parameters<TEvents[TGuardMap[K]]>[0];\n state: TState;\n }) => boolean;\n}"
117029
- }
115646
+ "kind": "symbol",
115647
+ "name": "ToGuardConfig",
115648
+ "value": "ToGuardConfig<TState, TEvents, TEventMap[\"guards\"]>"
117030
115649
  },
117031
115650
  {
117032
- "kind": "type",
117033
- "typeParameters": [
117034
- {
117035
- "kind": "typeParameter",
117036
- "name": "TState",
117037
- "constraint": {
117038
- "kind": "external",
117039
- "name": "Record",
117040
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117041
- "typeParameters": [
117042
- {
117043
- "kind": "primitive",
117044
- "value": "string"
117045
- },
117046
- {
117047
- "kind": "primitive",
117048
- "value": "any"
117049
- }
117050
- ]
117051
- },
117052
- "required": true
117053
- },
117054
- {
117055
- "kind": "typeParameter",
117056
- "name": "TEvents",
117057
- "constraint": {
117058
- "kind": "object",
117059
- "properties": [],
117060
- "indexSignature": {
117061
- "kind": "indexSignature",
117062
- "name": "key",
117063
- "type": {
117064
- "kind": "primitive",
117065
- "value": "string"
117066
- },
117067
- "value": {
117068
- "kind": "function",
117069
- "parameters": [
117070
- {
117071
- "kind": "parameter",
117072
- "name": "data",
117073
- "type": {
117074
- "kind": "unknown",
117075
- "value": "unknown",
117076
- "text": "object"
117077
- },
117078
- "required": false,
117079
- "rest": false,
117080
- "description": "",
117081
- "declarations": [
117082
- {
117083
- "name": "data",
117084
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117085
- }
117086
- ],
117087
- "tags": {}
117088
- }
117089
- ],
117090
- "members": [],
117091
- "returnType": {
117092
- "kind": "primitive",
117093
- "value": "void"
117094
- }
117095
- }
117096
- }
117097
- },
117098
- "required": true
117099
- },
117100
- {
117101
- "kind": "typeParameter",
117102
- "name": "TCallbackMap",
117103
- "constraint": {
117104
- "kind": "external",
117105
- "name": "Record",
117106
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117107
- "typeParameters": [
117108
- {
117109
- "kind": "primitive",
117110
- "value": "string"
117111
- },
117112
- {
117113
- "kind": "unknown",
117114
- "value": "unknown",
117115
- "text": "keyof TEvents"
117116
- }
117117
- ]
117118
- },
117119
- "required": true
117120
- }
117121
- ],
117122
- "value": {
117123
- "kind": "unknown",
117124
- "value": "unknown",
117125
- "text": "{\n [K in keyof TCallbackMap]: (event: {\n data: Parameters<TEvents[TCallbackMap[K]]>[0];\n /**\n * Callbacks are called during the `setState` phase in React. This means the state has not\n * resolved yet. This is a good time to add more `setState` calls which will be added to React's\n * state batch updates, but it also means the state provided here hasn't been updated yet.\n */\n prevState: TState;\n }) => void;\n}"
117126
- }
115651
+ "kind": "symbol",
115652
+ "name": "ToCallbackConfig",
115653
+ "value": "ToCallbackConfig<TState, TEvents, TEventMap[\"callbacks\"]>"
117127
115654
  }
117128
115655
  ]
117129
115656
  }
@@ -117141,7 +115668,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117141
115668
  ],
117142
115669
  "tags": {
117143
115670
  "example": "type Events = {\n open(data: { eventData: string }): void\n}\n\nconst eventMap = createEventMap<Events>()({\n guards: {\n shouldOpen: 'open'\n },\n callbacks: {\n onOpen: 'open'\n }\n})",
117144
- "deprecated": "`createModelHook` uses Template Literal Types to create event map types"
115671
+ "deprecated": "⚠️ `createEventMap` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead. It uses Template Literal Types to create event map types."
117145
115672
  },
117146
115673
  "type": {
117147
115674
  "kind": "function",
@@ -117292,45 +115819,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117292
115819
  "kind": "typeParameter",
117293
115820
  "name": "TEvents",
117294
115821
  "constraint": {
117295
- "kind": "object",
117296
- "properties": [],
117297
- "indexSignature": {
117298
- "kind": "indexSignature",
117299
- "name": "key",
117300
- "type": {
117301
- "kind": "primitive",
117302
- "value": "string"
117303
- },
117304
- "value": {
117305
- "kind": "function",
117306
- "parameters": [
117307
- {
117308
- "kind": "parameter",
117309
- "name": "data",
117310
- "type": {
117311
- "kind": "unknown",
117312
- "value": "unknown",
117313
- "text": "object"
117314
- },
117315
- "required": false,
117316
- "rest": false,
117317
- "description": "",
117318
- "declarations": [
117319
- {
117320
- "name": "data",
117321
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117322
- }
117323
- ],
117324
- "tags": {}
117325
- }
117326
- ],
117327
- "members": [],
117328
- "returnType": {
117329
- "kind": "primitive",
117330
- "value": "void"
117331
- }
117332
- }
117333
- }
115822
+ "kind": "symbol",
115823
+ "name": "IEvent",
115824
+ "value": "IEvent"
117334
115825
  },
117335
115826
  "required": true
117336
115827
  },
@@ -117395,133 +115886,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117395
115886
  ],
117396
115887
  "members": [],
117397
115888
  "returnType": {
117398
- "kind": "object",
117399
- "properties": [
117400
- {
117401
- "kind": "property",
117402
- "name": "guards",
117403
- "required": true,
117404
- "type": {
117405
- "kind": "generic",
117406
- "name": "TGuardMap"
117407
- },
117408
- "description": "",
117409
- "declarations": [
117410
- {
117411
- "name": "guards",
117412
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117413
- }
117414
- ],
117415
- "tags": {}
117416
- },
117417
- {
117418
- "kind": "property",
117419
- "name": "callbacks",
117420
- "required": true,
117421
- "type": {
117422
- "kind": "generic",
117423
- "name": "TCallbackMap"
117424
- },
117425
- "description": "",
117426
- "declarations": [
117427
- {
117428
- "name": "callbacks",
117429
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117430
- }
117431
- ],
117432
- "tags": {}
117433
- }
117434
- ],
115889
+ "kind": "symbol",
115890
+ "name": "EventMap",
117435
115891
  "typeParameters": [
117436
115892
  {
117437
- "kind": "typeParameter",
117438
- "name": "TEvents",
117439
- "constraint": {
117440
- "kind": "object",
117441
- "properties": [],
117442
- "indexSignature": {
117443
- "kind": "indexSignature",
117444
- "name": "key",
117445
- "type": {
117446
- "kind": "primitive",
117447
- "value": "string"
117448
- },
117449
- "value": {
117450
- "kind": "function",
117451
- "parameters": [
117452
- {
117453
- "kind": "parameter",
117454
- "name": "data",
117455
- "type": {
117456
- "kind": "unknown",
117457
- "value": "unknown",
117458
- "text": "object"
117459
- },
117460
- "required": false,
117461
- "rest": false,
117462
- "description": "",
117463
- "declarations": [
117464
- {
117465
- "name": "data",
117466
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117467
- }
117468
- ],
117469
- "tags": {}
117470
- }
117471
- ],
117472
- "members": [],
117473
- "returnType": {
117474
- "kind": "primitive",
117475
- "value": "void"
117476
- }
117477
- }
117478
- }
117479
- },
117480
- "required": true
115893
+ "kind": "generic",
115894
+ "name": "TEvents"
117481
115895
  },
117482
115896
  {
117483
- "kind": "typeParameter",
117484
- "name": "TGuardMap",
117485
- "constraint": {
117486
- "kind": "external",
117487
- "name": "Record",
117488
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117489
- "typeParameters": [
117490
- {
117491
- "kind": "primitive",
117492
- "value": "string"
117493
- },
117494
- {
117495
- "kind": "unknown",
117496
- "value": "unknown",
117497
- "text": "keyof TEvents"
117498
- }
117499
- ]
117500
- },
117501
- "required": true
115897
+ "kind": "generic",
115898
+ "name": "TGuardMap"
117502
115899
  },
117503
115900
  {
117504
- "kind": "typeParameter",
117505
- "name": "TCallbackMap",
117506
- "constraint": {
117507
- "kind": "external",
117508
- "name": "Record",
117509
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117510
- "typeParameters": [
117511
- {
117512
- "kind": "primitive",
117513
- "value": "string"
117514
- },
117515
- {
117516
- "kind": "unknown",
117517
- "value": "unknown",
117518
- "text": "keyof TEvents"
117519
- }
117520
- ]
117521
- },
117522
- "required": true
115901
+ "kind": "generic",
115902
+ "name": "TCallbackMap"
117523
115903
  }
117524
- ]
115904
+ ],
115905
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117525
115906
  }
117526
115907
  }
117527
115908
  }
@@ -117539,7 +115920,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117539
115920
  "tags": {
117540
115921
  "param": "eventMap\nstate\nconfig\nevents",
117541
115922
  "example": "const useDiscloseModel = (config: ModelConfig = {}): DiscloseModel => {\n const events = useEventMap(eventMap, state, config, {\n open() {\n // do something\n }\n }\n})",
117542
- "deprecated": "Use `createModelHook` instead"
115923
+ "deprecated": "⚠️ `useEventMap` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead."
117543
115924
  },
117544
115925
  "type": {
117545
115926
  "kind": "function",
@@ -117714,45 +116095,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117714
116095
  "kind": "typeParameter",
117715
116096
  "name": "TEvents",
117716
116097
  "constraint": {
117717
- "kind": "object",
117718
- "properties": [],
117719
- "indexSignature": {
117720
- "kind": "indexSignature",
117721
- "name": "key",
117722
- "type": {
117723
- "kind": "primitive",
117724
- "value": "string"
117725
- },
117726
- "value": {
117727
- "kind": "function",
117728
- "parameters": [
117729
- {
117730
- "kind": "parameter",
117731
- "name": "data",
117732
- "type": {
117733
- "kind": "unknown",
117734
- "value": "unknown",
117735
- "text": "object"
117736
- },
117737
- "required": false,
117738
- "rest": false,
117739
- "description": "",
117740
- "declarations": [
117741
- {
117742
- "name": "data",
117743
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117744
- }
117745
- ],
117746
- "tags": {}
117747
- }
117748
- ],
117749
- "members": [],
117750
- "returnType": {
117751
- "kind": "primitive",
117752
- "value": "void"
117753
- }
117754
- }
117755
- }
116098
+ "kind": "symbol",
116099
+ "name": "IEvent",
116100
+ "value": "IEvent"
117756
116101
  },
117757
116102
  "required": true
117758
116103
  },
@@ -117814,133 +116159,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117814
116159
  "kind": "parameter",
117815
116160
  "name": "eventMap",
117816
116161
  "type": {
117817
- "kind": "object",
117818
- "properties": [
117819
- {
117820
- "kind": "property",
117821
- "name": "guards",
117822
- "required": true,
117823
- "type": {
117824
- "kind": "generic",
117825
- "name": "TGuardMap"
117826
- },
117827
- "description": "",
117828
- "declarations": [
117829
- {
117830
- "name": "guards",
117831
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117832
- }
117833
- ],
117834
- "tags": {}
117835
- },
117836
- {
117837
- "kind": "property",
117838
- "name": "callbacks",
117839
- "required": true,
117840
- "type": {
117841
- "kind": "generic",
117842
- "name": "TCallbackMap"
117843
- },
117844
- "description": "",
117845
- "declarations": [
117846
- {
117847
- "name": "callbacks",
117848
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117849
- }
117850
- ],
117851
- "tags": {}
117852
- }
117853
- ],
116162
+ "kind": "symbol",
116163
+ "name": "EventMap",
117854
116164
  "typeParameters": [
117855
116165
  {
117856
- "kind": "typeParameter",
117857
- "name": "TEvents",
117858
- "constraint": {
117859
- "kind": "object",
117860
- "properties": [],
117861
- "indexSignature": {
117862
- "kind": "indexSignature",
117863
- "name": "key",
117864
- "type": {
117865
- "kind": "primitive",
117866
- "value": "string"
117867
- },
117868
- "value": {
117869
- "kind": "function",
117870
- "parameters": [
117871
- {
117872
- "kind": "parameter",
117873
- "name": "data",
117874
- "type": {
117875
- "kind": "unknown",
117876
- "value": "unknown",
117877
- "text": "object"
117878
- },
117879
- "required": false,
117880
- "rest": false,
117881
- "description": "",
117882
- "declarations": [
117883
- {
117884
- "name": "data",
117885
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117886
- }
117887
- ],
117888
- "tags": {}
117889
- }
117890
- ],
117891
- "members": [],
117892
- "returnType": {
117893
- "kind": "primitive",
117894
- "value": "void"
117895
- }
117896
- }
117897
- }
117898
- },
117899
- "required": true
116166
+ "kind": "generic",
116167
+ "name": "TEvents"
117900
116168
  },
117901
116169
  {
117902
- "kind": "typeParameter",
117903
- "name": "TGuardMap",
117904
- "constraint": {
117905
- "kind": "external",
117906
- "name": "Record",
117907
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117908
- "typeParameters": [
117909
- {
117910
- "kind": "primitive",
117911
- "value": "string"
117912
- },
117913
- {
117914
- "kind": "unknown",
117915
- "value": "unknown",
117916
- "text": "keyof TEvents"
117917
- }
117918
- ]
117919
- },
117920
- "required": true
116170
+ "kind": "generic",
116171
+ "name": "TGuardMap"
117921
116172
  },
117922
116173
  {
117923
- "kind": "typeParameter",
117924
- "name": "TCallbackMap",
117925
- "constraint": {
117926
- "kind": "external",
117927
- "name": "Record",
117928
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117929
- "typeParameters": [
117930
- {
117931
- "kind": "primitive",
117932
- "value": "string"
117933
- },
117934
- {
117935
- "kind": "unknown",
117936
- "value": "unknown",
117937
- "text": "keyof TEvents"
117938
- }
117939
- ]
117940
- },
117941
- "required": true
116174
+ "kind": "generic",
116175
+ "name": "TCallbackMap"
117942
116176
  }
117943
- ]
116177
+ ],
116178
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117944
116179
  },
117945
116180
  "required": true,
117946
116181
  "rest": false,
@@ -118317,48 +116552,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118317
116552
  "kind": "typeParameter",
118318
116553
  "name": "TEvents",
118319
116554
  "constraint": {
118320
- "kind": "object",
118321
- "properties": [],
118322
- "indexSignature": {
118323
- "kind": "indexSignature",
118324
- "name": "key",
118325
- "type": {
118326
- "kind": "primitive",
118327
- "value": "string"
118328
- },
118329
- "value": {
118330
- "kind": "function",
118331
- "parameters": [
118332
- {
118333
- "kind": "parameter",
118334
- "name": "args",
118335
- "type": {
118336
- "kind": "array",
118337
- "value": {
118338
- "kind": "primitive",
118339
- "value": "any"
118340
- }
118341
- },
118342
- "required": true,
118343
- "rest": true,
118344
- "description": "",
118345
- "declarations": [
118346
- {
118347
- "name": "args",
118348
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118349
- }
118350
- ],
118351
- "tags": {}
118352
- }
118353
- ],
118354
- "members": [],
118355
- "returnType": {
118356
- "kind": "unknown",
118357
- "value": "unknown",
118358
- "text": "object"
118359
- }
118360
- }
118361
- }
116555
+ "kind": "symbol",
116556
+ "name": "EventCreator",
116557
+ "value": "EventCreator"
118362
116558
  },
118363
116559
  "required": true
118364
116560
  },
@@ -118380,133 +116576,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118380
116576
  "text": "config"
118381
116577
  },
118382
116578
  "type": {
118383
- "kind": "object",
118384
- "properties": [
118385
- {
118386
- "kind": "property",
118387
- "name": "guards",
118388
- "required": true,
118389
- "type": {
118390
- "kind": "generic",
118391
- "name": "TGuardMap"
118392
- },
118393
- "description": "",
118394
- "declarations": [
118395
- {
118396
- "name": "guards",
118397
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118398
- }
118399
- ],
118400
- "tags": {}
118401
- },
118402
- {
118403
- "kind": "property",
118404
- "name": "callbacks",
118405
- "required": true,
118406
- "type": {
118407
- "kind": "generic",
118408
- "name": "TCallbackMap"
118409
- },
118410
- "description": "",
118411
- "declarations": [
118412
- {
118413
- "name": "callbacks",
118414
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118415
- }
118416
- ],
118417
- "tags": {}
118418
- }
118419
- ],
118420
- "typeParameters": [
118421
- {
118422
- "kind": "typeParameter",
118423
- "name": "TEvents",
118424
- "constraint": {
118425
- "kind": "object",
118426
- "properties": [],
118427
- "indexSignature": {
118428
- "kind": "indexSignature",
118429
- "name": "key",
118430
- "type": {
118431
- "kind": "primitive",
118432
- "value": "string"
118433
- },
118434
- "value": {
118435
- "kind": "function",
118436
- "parameters": [
118437
- {
118438
- "kind": "parameter",
118439
- "name": "data",
118440
- "type": {
118441
- "kind": "unknown",
118442
- "value": "unknown",
118443
- "text": "object"
118444
- },
118445
- "required": false,
118446
- "rest": false,
118447
- "description": "",
118448
- "declarations": [
118449
- {
118450
- "name": "data",
118451
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118452
- }
118453
- ],
118454
- "tags": {}
118455
- }
118456
- ],
118457
- "members": [],
118458
- "returnType": {
118459
- "kind": "primitive",
118460
- "value": "void"
118461
- }
118462
- }
118463
- }
118464
- },
118465
- "required": true
118466
- },
118467
- {
118468
- "kind": "typeParameter",
118469
- "name": "TGuardMap",
118470
- "constraint": {
118471
- "kind": "external",
118472
- "name": "Record",
118473
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118474
- "typeParameters": [
118475
- {
118476
- "kind": "primitive",
118477
- "value": "string"
118478
- },
118479
- {
118480
- "kind": "unknown",
118481
- "value": "unknown",
118482
- "text": "keyof TEvents"
118483
- }
118484
- ]
118485
- },
118486
- "required": true
118487
- },
118488
- {
118489
- "kind": "typeParameter",
118490
- "name": "TCallbackMap",
118491
- "constraint": {
118492
- "kind": "external",
118493
- "name": "Record",
118494
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118495
- "typeParameters": [
118496
- {
118497
- "kind": "primitive",
118498
- "value": "string"
118499
- },
118500
- {
118501
- "kind": "unknown",
118502
- "value": "unknown",
118503
- "text": "keyof TEvents"
118504
- }
118505
- ]
118506
- },
118507
- "required": true
118508
- }
118509
- ]
116579
+ "kind": "symbol",
116580
+ "name": "EventMap",
116581
+ "value": "EventMap<ToEvent<TEvents>, TGuardMap, TCallbackMap>"
118510
116582
  },
118511
116583
  "required": true,
118512
116584
  "description": "",
@@ -119747,25 +117819,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
119747
117819
  "parameters": [],
119748
117820
  "members": [],
119749
117821
  "returnType": {
119750
- "kind": "type",
119751
- "typeParameters": [],
119752
- "value": {
119753
- "kind": "union",
119754
- "value": [
119755
- {
119756
- "kind": "string",
119757
- "value": "mouse"
119758
- },
119759
- {
119760
- "kind": "string",
119761
- "value": "touch"
119762
- },
119763
- {
119764
- "kind": "string",
119765
- "value": "pen"
119766
- }
119767
- ]
119768
- }
117822
+ "kind": "symbol",
117823
+ "name": "Modality",
117824
+ "value": "Modality"
119769
117825
  }
119770
117826
  }
119771
117827
  },
@@ -119986,7 +118042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
119986
118042
  }
119987
118043
  ],
119988
118044
  "tags": {
119989
- "deprecated": "TODO: Remove in major release"
118045
+ "deprecated": "⚠️ `uniqueId` has been deprecated and will be removed in a future major version. Please use `useUniqueId` instead."
119990
118046
  },
119991
118047
  "type": {
119992
118048
  "kind": "symbol",
@@ -162619,37 +160675,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162619
160675
  "kind": "parameter",
162620
160676
  "name": "__0",
162621
160677
  "type": {
162622
- "kind": "type",
162623
- "typeParameters": [],
162624
- "value": {
162625
- "kind": "symbol",
162626
- "name": "Pick",
162627
- "typeParameters": [
162628
- {
162629
- "kind": "symbol",
162630
- "name": "PaginationState",
162631
- "value": "PaginationState"
162632
- },
162633
- {
162634
- "kind": "union",
162635
- "value": [
162636
- {
162637
- "kind": "string",
162638
- "value": "currentPage"
162639
- },
162640
- {
162641
- "kind": "string",
162642
- "value": "lastPage"
162643
- },
162644
- {
162645
- "kind": "string",
162646
- "value": "rangeSize"
162647
- }
162648
- ]
162649
- }
162650
- ],
162651
- "value": "Pick<T, K>"
162652
- }
160678
+ "kind": "symbol",
160679
+ "name": "BuildPageRangeConfig",
160680
+ "value": "BuildPageRangeConfig"
162653
160681
  },
162654
160682
  "required": true,
162655
160683
  "rest": false,
@@ -162897,124 +160925,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162897
160925
  "kind": "parameter",
162898
160926
  "name": "config",
162899
160927
  "defaultValue": {
162900
- "kind": "object",
162901
- "properties": [
162902
- {
162903
- "kind": "property",
162904
- "name": "aria-atomic",
162905
- "required": false,
162906
- "type": {
162907
- "kind": "union",
162908
- "value": [
162909
- {
162910
- "kind": "parenthesis",
162911
- "value": {
162912
- "kind": "union",
162913
- "value": [
162914
- {
162915
- "kind": "primitive",
162916
- "value": "boolean"
162917
- },
162918
- {
162919
- "kind": "string",
162920
- "value": "false"
162921
- },
162922
- {
162923
- "kind": "string",
162924
- "value": "true"
162925
- }
162926
- ]
162927
- }
162928
- },
162929
- {
162930
- "kind": "primitive",
162931
- "value": "undefined"
162932
- }
162933
- ]
162934
- },
162935
- "description": "",
162936
- "declarations": [
162937
- {
162938
- "name": "aria-atomic",
162939
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162940
- }
162941
- ],
162942
- "tags": {}
162943
- },
162944
- {
162945
- "kind": "property",
162946
- "name": "aria-live",
162947
- "required": false,
162948
- "type": {
162949
- "kind": "union",
162950
- "value": [
162951
- {
162952
- "kind": "string",
162953
- "value": "polite"
162954
- },
162955
- {
162956
- "kind": "string",
162957
- "value": "assertive"
162958
- }
162959
- ]
162960
- },
162961
- "description": "",
162962
- "declarations": [
162963
- {
162964
- "name": "aria-live",
162965
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162966
- }
162967
- ],
162968
- "tags": {}
162969
- },
162970
- {
162971
- "kind": "property",
162972
- "name": "role",
162973
- "required": false,
162974
- "type": {
162975
- "kind": "union",
162976
- "value": [
162977
- {
162978
- "kind": "string",
162979
- "value": "status"
162980
- },
162981
- {
162982
- "kind": "string",
162983
- "value": "alert"
162984
- },
162985
- {
162986
- "kind": "string",
162987
- "value": "log"
162988
- }
162989
- ]
162990
- },
162991
- "description": "",
162992
- "declarations": [
162993
- {
162994
- "name": "role",
162995
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162996
- }
162997
- ],
162998
- "tags": {}
162999
- },
163000
- {
163001
- "kind": "property",
163002
- "name": "shouldAnnounceToScreenReader",
163003
- "required": false,
163004
- "type": {
163005
- "kind": "primitive",
163006
- "value": "boolean"
163007
- },
163008
- "description": "",
163009
- "declarations": [
163010
- {
163011
- "name": "shouldAnnounceToScreenReader",
163012
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163013
- }
163014
- ],
163015
- "tags": {}
163016
- }
163017
- ]
160928
+ "kind": "symbol",
160929
+ "name": "UseLiveRegionConfig",
160930
+ "value": "UseLiveRegionConfig"
163018
160931
  },
163019
160932
  "type": {
163020
160933
  "kind": "object",
@@ -163150,124 +161063,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
163150
161063
  ],
163151
161064
  "members": [],
163152
161065
  "returnType": {
163153
- "kind": "object",
163154
- "properties": [
163155
- {
163156
- "kind": "property",
163157
- "name": "aria-atomic",
163158
- "required": false,
163159
- "type": {
163160
- "kind": "union",
163161
- "value": [
163162
- {
163163
- "kind": "parenthesis",
163164
- "value": {
163165
- "kind": "union",
163166
- "value": [
163167
- {
163168
- "kind": "primitive",
163169
- "value": "boolean"
163170
- },
163171
- {
163172
- "kind": "string",
163173
- "value": "false"
163174
- },
163175
- {
163176
- "kind": "string",
163177
- "value": "true"
163178
- }
163179
- ]
163180
- }
163181
- },
163182
- {
163183
- "kind": "primitive",
163184
- "value": "undefined"
163185
- }
163186
- ]
163187
- },
163188
- "description": "",
163189
- "declarations": [
163190
- {
163191
- "name": "aria-atomic",
163192
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163193
- }
163194
- ],
163195
- "tags": {}
163196
- },
163197
- {
163198
- "kind": "property",
163199
- "name": "aria-live",
163200
- "required": false,
163201
- "type": {
163202
- "kind": "union",
163203
- "value": [
163204
- {
163205
- "kind": "string",
163206
- "value": "polite"
163207
- },
163208
- {
163209
- "kind": "string",
163210
- "value": "assertive"
163211
- }
163212
- ]
163213
- },
163214
- "description": "",
163215
- "declarations": [
163216
- {
163217
- "name": "aria-live",
163218
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163219
- }
163220
- ],
163221
- "tags": {}
163222
- },
163223
- {
163224
- "kind": "property",
163225
- "name": "role",
163226
- "required": false,
163227
- "type": {
163228
- "kind": "union",
163229
- "value": [
163230
- {
163231
- "kind": "string",
163232
- "value": "status"
163233
- },
163234
- {
163235
- "kind": "string",
163236
- "value": "alert"
163237
- },
163238
- {
163239
- "kind": "string",
163240
- "value": "log"
163241
- }
163242
- ]
163243
- },
163244
- "description": "",
163245
- "declarations": [
163246
- {
163247
- "name": "role",
163248
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163249
- }
163250
- ],
163251
- "tags": {}
163252
- },
163253
- {
163254
- "kind": "property",
163255
- "name": "shouldAnnounceToScreenReader",
163256
- "required": false,
163257
- "type": {
163258
- "kind": "primitive",
163259
- "value": "boolean"
163260
- },
163261
- "description": "",
163262
- "declarations": [
163263
- {
163264
- "name": "shouldAnnounceToScreenReader",
163265
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163266
- }
163267
- ],
163268
- "tags": {}
163269
- }
163270
- ]
161066
+ "kind": "symbol",
161067
+ "name": "UseLiveRegionConfig",
161068
+ "value": "UseLiveRegionConfig"
163271
161069
  }
163272
161070
  }
163273
161071
  },
@@ -191023,7 +188821,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191023
188821
  {
191024
188822
  "name": "StatusIndicatorType",
191025
188823
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191026
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
188824
+ "description": "",
191027
188825
  "declarations": [
191028
188826
  {
191029
188827
  "name": "StatusIndicatorType",
@@ -191031,7 +188829,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191031
188829
  }
191032
188830
  ],
191033
188831
  "tags": {
191034
- "deprecated": ""
188832
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191035
188833
  },
191036
188834
  "type": {
191037
188835
  "kind": "object",
@@ -191092,7 +188890,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191092
188890
  {
191093
188891
  "name": "StatusIndicatorEmphasis",
191094
188892
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191095
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
188893
+ "description": "",
191096
188894
  "declarations": [
191097
188895
  {
191098
188896
  "name": "StatusIndicatorEmphasis",
@@ -191100,7 +188898,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191100
188898
  }
191101
188899
  ],
191102
188900
  "tags": {
191103
- "deprecated": ""
188901
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191104
188902
  },
191105
188903
  "type": {
191106
188904
  "kind": "object",
@@ -191129,7 +188927,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191129
188927
  {
191130
188928
  "name": "StatusIndicatorGenericStyle",
191131
188929
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191132
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
188930
+ "description": "",
191133
188931
  "declarations": [
191134
188932
  {
191135
188933
  "name": "StatusIndicatorGenericStyle",
@@ -191137,7 +188935,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191137
188935
  }
191138
188936
  ],
191139
188937
  "tags": {
191140
- "deprecated": ""
188938
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191141
188939
  },
191142
188940
  "type": {
191143
188941
  "kind": "object",
@@ -191225,7 +189023,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191225
189023
  {
191226
189024
  "name": "statusIndicatorStyles",
191227
189025
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191228
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
189026
+ "description": "",
191229
189027
  "declarations": [
191230
189028
  {
191231
189029
  "name": "statusIndicatorStyles",
@@ -191233,7 +189031,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191233
189031
  }
191234
189032
  ],
191235
189033
  "tags": {
191236
- "deprecated": ""
189034
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191237
189035
  },
191238
189036
  "type": {
191239
189037
  "kind": "symbol",
@@ -191244,7 +189042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191244
189042
  {
191245
189043
  "name": "StatusIndicatorProps",
191246
189044
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191247
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
189045
+ "description": "",
191248
189046
  "declarations": [
191249
189047
  {
191250
189048
  "name": "StatusIndicatorProps",
@@ -191252,7 +189050,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191252
189050
  }
191253
189051
  ],
191254
189052
  "tags": {
191255
- "deprecated": ""
189053
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191256
189054
  },
191257
189055
  "type": {
191258
189056
  "kind": "alias",
@@ -191262,7 +189060,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191262
189060
  {
191263
189061
  "name": "StatusIndicator",
191264
189062
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191265
- "description": "### ⚠️ Status Indicator has been deprecated and will be removed in v11 ⚠️\n- Please consider using [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in preview",
189063
+ "description": "",
191266
189064
  "declarations": [
191267
189065
  {
191268
189066
  "name": "StatusIndicator",
@@ -191270,7 +189068,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191270
189068
  }
191271
189069
  ],
191272
189070
  "tags": {
191273
- "deprecated": ""
189071
+ "deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--basic) in Preview instead."
191274
189072
  },
191275
189073
  "type": {
191276
189074
  "kind": "component",
@@ -192154,7 +189952,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
192154
189952
  }
192155
189953
  ],
192156
189954
  "tags": {
192157
- "deprecated": "Use `Tabs.Menu.Popper` instead"
189955
+ "deprecated": "⚠️ `MenuPopper` has been deprecated and will be removed in a future major version. Please use `Tabs.Menu.Popper` instead."
192158
189956
  }
192159
189957
  },
192160
189958
  {
@@ -238612,9 +236410,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238612
236410
  "kind": "property",
238613
236411
  "name": "onBlur",
238614
236412
  "defaultValue": {
238615
- "kind": "unknown",
238616
- "value": "unknown",
238617
- "text": "onHide"
236413
+ "kind": "symbol",
236414
+ "name": "onHide",
236415
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236416
+ "value": "onHide"
238618
236417
  },
238619
236418
  "type": {
238620
236419
  "kind": "function",
@@ -238735,9 +236534,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238735
236534
  "kind": "property",
238736
236535
  "name": "open",
238737
236536
  "defaultValue": {
238738
- "kind": "unknown",
238739
- "value": "unknown",
238740
- "text": "visible"
236537
+ "kind": "symbol",
236538
+ "name": "visible",
236539
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236540
+ "value": "visible"
238741
236541
  },
238742
236542
  "type": {
238743
236543
  "kind": "primitive",
@@ -238906,9 +236706,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238906
236706
  "kind": "property",
238907
236707
  "name": "onMouseLeave",
238908
236708
  "defaultValue": {
238909
- "kind": "unknown",
238910
- "value": "unknown",
238911
- "text": "onHide"
236709
+ "kind": "symbol",
236710
+ "name": "onHide",
236711
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236712
+ "value": "onHide"
238912
236713
  },
238913
236714
  "type": {
238914
236715
  "kind": "function",
@@ -238990,9 +236791,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238990
236791
  "kind": "property",
238991
236792
  "name": "onMouseEnter",
238992
236793
  "defaultValue": {
238993
- "kind": "unknown",
238994
- "value": "unknown",
238995
- "text": "onOpen"
236794
+ "kind": "symbol",
236795
+ "name": "onOpen",
236796
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236797
+ "value": "onOpen"
238996
236798
  },
238997
236799
  "type": {
238998
236800
  "kind": "function",
@@ -239017,9 +236819,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
239017
236819
  "kind": "property",
239018
236820
  "name": "onMouseLeave",
239019
236821
  "defaultValue": {
239020
- "kind": "unknown",
239021
- "value": "unknown",
239022
- "text": "onHide"
236822
+ "kind": "symbol",
236823
+ "name": "onHide",
236824
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236825
+ "value": "onHide"
239023
236826
  },
239024
236827
  "type": {
239025
236828
  "kind": "function",