@workday/canvas-kit-docs 9.1.19 → 9.1.22

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",
@@ -1441,6 +1441,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1441
1441
  "value": "SystemIconCircleSize.m"
1442
1442
  }
1443
1443
  },
1444
+ {
1445
+ "kind": "property",
1446
+ "name": "objectFit",
1447
+ "required": false,
1448
+ "type": {
1449
+ "kind": "external",
1450
+ "name": "Property.ObjectFit",
1451
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
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.",
1454
+ "declarations": [
1455
+ {
1456
+ "name": "objectFit",
1457
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
1458
+ }
1459
+ ],
1460
+ "tags": {}
1461
+ },
1444
1462
  {
1445
1463
  "kind": "property",
1446
1464
  "name": "altText",
@@ -7137,14 +7155,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7137
7155
  {
7138
7156
  "name": "DeprecatedMenuProps",
7139
7157
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7140
- "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": "",
7141
7159
  "declarations": [
7142
7160
  {
7143
7161
  "name": "DeprecatedMenuProps",
7144
7162
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
7145
7163
  }
7146
7164
  ],
7147
- "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
+ },
7148
7168
  "type": {
7149
7169
  "kind": "alias",
7150
7170
  "name": "DeprecatedMenu"
@@ -7153,14 +7173,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7153
7173
  {
7154
7174
  "name": "DeprecatedMenuState",
7155
7175
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7156
- "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": "",
7157
7177
  "declarations": [
7158
7178
  {
7159
7179
  "name": "DeprecatedMenuState",
7160
7180
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx"
7161
7181
  }
7162
7182
  ],
7163
- "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
+ },
7164
7186
  "type": {
7165
7187
  "kind": "object",
7166
7188
  "properties": [
@@ -7187,7 +7209,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7187
7209
  {
7188
7210
  "name": "DeprecatedMenu",
7189
7211
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
7190
- "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.",
7191
7213
  "declarations": [
7192
7214
  {
7193
7215
  "name": "DeprecatedMenu",
@@ -7195,7 +7217,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7195
7217
  }
7196
7218
  ],
7197
7219
  "tags": {
7198
- "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."
7199
7221
  },
7200
7222
  "type": {
7201
7223
  "kind": "component",
@@ -7412,14 +7434,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7412
7434
  {
7413
7435
  "name": "DeprecatedMenuItemProps",
7414
7436
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
7415
- "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": "",
7416
7438
  "declarations": [
7417
7439
  {
7418
7440
  "name": "DeprecatedMenuItemProps",
7419
7441
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx"
7420
7442
  }
7421
7443
  ],
7422
- "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
+ },
7423
7447
  "type": {
7424
7448
  "kind": "alias",
7425
7449
  "name": "DeprecatedMenuItem"
@@ -7428,7 +7452,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7428
7452
  {
7429
7453
  "name": "DeprecatedMenuItem",
7430
7454
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/MenuItem.tsx",
7431
- "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.",
7432
7456
  "declarations": [
7433
7457
  {
7434
7458
  "name": "DeprecatedMenuItem",
@@ -7436,7 +7460,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
7436
7460
  }
7437
7461
  ],
7438
7462
  "tags": {
7439
- "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."
7440
7464
  },
7441
7465
  "type": {
7442
7466
  "kind": "component",
@@ -8103,6 +8127,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
8103
8127
  "value": "div"
8104
8128
  }
8105
8129
  },
8130
+ {
8131
+ "kind": "property",
8132
+ "name": "objectFit",
8133
+ "required": false,
8134
+ "type": {
8135
+ "kind": "external",
8136
+ "name": "Property.ObjectFit",
8137
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
8138
+ },
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.",
8140
+ "declarations": [
8141
+ {
8142
+ "name": "objectFit",
8143
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
8144
+ }
8145
+ ],
8146
+ "tags": {}
8147
+ },
8106
8148
  {
8107
8149
  "kind": "property",
8108
8150
  "name": "children",
@@ -31735,7 +31777,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31735
31777
  }
31736
31778
  ],
31737
31779
  "tags": {
31738
- "deprecated": "Please use `useFormFieldModel` instead"
31780
+ "deprecated": "⚠️ `useTextInputModel` is deprecated and will be removed in a future major version. Please use `useFormFieldModel` instead."
31739
31781
  },
31740
31782
  "type": {
31741
31783
  "kind": "symbol",
@@ -40335,6 +40377,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
40335
40377
  }
40336
40378
  ],
40337
40379
  "tags": {}
40380
+ },
40381
+ {
40382
+ "kind": "property",
40383
+ "name": "objectFit",
40384
+ "required": false,
40385
+ "type": {
40386
+ "kind": "external",
40387
+ "name": "Property.ObjectFit",
40388
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
40389
+ },
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.",
40391
+ "declarations": [
40392
+ {
40393
+ "name": "objectFit",
40394
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
40395
+ }
40396
+ ],
40397
+ "tags": {}
40338
40398
  }
40339
40399
  ]
40340
40400
  }
@@ -42128,48 +42188,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42128
42188
  "kind": "parameter",
42129
42189
  "name": "type",
42130
42190
  "type": {
42131
- "kind": "type",
42132
- "typeParameters": [],
42133
- "value": {
42134
- "kind": "symbol",
42135
- "name": "Exclude",
42136
- "typeParameters": [
42137
- {
42138
- "kind": "union",
42139
- "value": [
42140
- {
42141
- "kind": "string",
42142
- "value": "alert"
42143
- },
42144
- {
42145
- "kind": "string",
42146
- "value": "error"
42147
- },
42148
- {
42149
- "kind": "string",
42150
- "value": "common"
42151
- },
42152
- {
42153
- "kind": "string",
42154
- "value": "primary"
42155
- },
42156
- {
42157
- "kind": "string",
42158
- "value": "success"
42159
- },
42160
- {
42161
- "kind": "string",
42162
- "value": "neutral"
42163
- }
42164
- ]
42165
- },
42166
- {
42167
- "kind": "string",
42168
- "value": "common"
42169
- }
42170
- ],
42171
- "value": "Exclude<T, U>"
42172
- }
42191
+ "kind": "symbol",
42192
+ "name": "paletteSelection",
42193
+ "value": "paletteSelection"
42173
42194
  },
42174
42195
  "required": true,
42175
42196
  "rest": false,
@@ -42279,48 +42300,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42279
42300
  "kind": "parameter",
42280
42301
  "name": "type",
42281
42302
  "type": {
42282
- "kind": "type",
42283
- "typeParameters": [],
42284
- "value": {
42285
- "kind": "symbol",
42286
- "name": "Exclude",
42287
- "typeParameters": [
42288
- {
42289
- "kind": "union",
42290
- "value": [
42291
- {
42292
- "kind": "string",
42293
- "value": "alert"
42294
- },
42295
- {
42296
- "kind": "string",
42297
- "value": "error"
42298
- },
42299
- {
42300
- "kind": "string",
42301
- "value": "common"
42302
- },
42303
- {
42304
- "kind": "string",
42305
- "value": "primary"
42306
- },
42307
- {
42308
- "kind": "string",
42309
- "value": "success"
42310
- },
42311
- {
42312
- "kind": "string",
42313
- "value": "neutral"
42314
- }
42315
- ]
42316
- },
42317
- {
42318
- "kind": "string",
42319
- "value": "common"
42320
- }
42321
- ],
42322
- "value": "Exclude<T, U>"
42323
- }
42303
+ "kind": "symbol",
42304
+ "name": "paletteSelection",
42305
+ "value": "paletteSelection"
42324
42306
  },
42325
42307
  "required": true,
42326
42308
  "rest": false,
@@ -63446,29 +63428,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63446
63428
  "name": "align",
63447
63429
  "required": true,
63448
63430
  "type": {
63449
- "kind": "type",
63450
- "typeParameters": [],
63451
- "value": {
63452
- "kind": "union",
63453
- "value": [
63454
- {
63455
- "kind": "string",
63456
- "value": "start"
63457
- },
63458
- {
63459
- "kind": "string",
63460
- "value": "center"
63461
- },
63462
- {
63463
- "kind": "string",
63464
- "value": "end"
63465
- },
63466
- {
63467
- "kind": "string",
63468
- "value": "auto"
63469
- }
63470
- ]
63471
- }
63431
+ "kind": "symbol",
63432
+ "name": "ScrollAlignment",
63433
+ "value": "ScrollAlignment"
63472
63434
  },
63473
63435
  "description": "",
63474
63436
  "declarations": [
@@ -63501,29 +63463,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63501
63463
  "name": "align",
63502
63464
  "required": true,
63503
63465
  "type": {
63504
- "kind": "type",
63505
- "typeParameters": [],
63506
- "value": {
63507
- "kind": "union",
63508
- "value": [
63509
- {
63510
- "kind": "string",
63511
- "value": "start"
63512
- },
63513
- {
63514
- "kind": "string",
63515
- "value": "center"
63516
- },
63517
- {
63518
- "kind": "string",
63519
- "value": "end"
63520
- },
63521
- {
63522
- "kind": "string",
63523
- "value": "auto"
63524
- }
63525
- ]
63526
- }
63466
+ "kind": "symbol",
63467
+ "name": "ScrollAlignment",
63468
+ "value": "ScrollAlignment"
63527
63469
  },
63528
63470
  "description": "",
63529
63471
  "declarations": [
@@ -63556,29 +63498,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63556
63498
  "name": "align",
63557
63499
  "required": true,
63558
63500
  "type": {
63559
- "kind": "type",
63560
- "typeParameters": [],
63561
- "value": {
63562
- "kind": "union",
63563
- "value": [
63564
- {
63565
- "kind": "string",
63566
- "value": "start"
63567
- },
63568
- {
63569
- "kind": "string",
63570
- "value": "center"
63571
- },
63572
- {
63573
- "kind": "string",
63574
- "value": "end"
63575
- },
63576
- {
63577
- "kind": "string",
63578
- "value": "auto"
63579
- }
63580
- ]
63581
- }
63501
+ "kind": "symbol",
63502
+ "name": "ScrollAlignment",
63503
+ "value": "ScrollAlignment"
63582
63504
  },
63583
63505
  "description": "",
63584
63506
  "declarations": [
@@ -63611,21 +63533,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63611
63533
  "name": "key",
63612
63534
  "required": true,
63613
63535
  "type": {
63614
- "kind": "type",
63615
- "typeParameters": [],
63616
- "value": {
63617
- "kind": "union",
63618
- "value": [
63619
- {
63620
- "kind": "primitive",
63621
- "value": "number"
63622
- },
63623
- {
63624
- "kind": "primitive",
63625
- "value": "string"
63626
- }
63627
- ]
63628
- }
63536
+ "kind": "symbol",
63537
+ "name": "Key",
63538
+ "value": "Key"
63629
63539
  },
63630
63540
  "description": "",
63631
63541
  "declarations": [
@@ -64178,43 +64088,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64178
64088
  ],
64179
64089
  "members": [],
64180
64090
  "returnType": {
64181
- "kind": "object",
64182
- "properties": [
64183
- {
64184
- "kind": "property",
64185
- "name": "width",
64186
- "required": true,
64187
- "type": {
64188
- "kind": "primitive",
64189
- "value": "number"
64190
- },
64191
- "description": "",
64192
- "declarations": [
64193
- {
64194
- "name": "width",
64195
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64196
- }
64197
- ],
64198
- "tags": {}
64199
- },
64200
- {
64201
- "kind": "property",
64202
- "name": "height",
64203
- "required": true,
64204
- "type": {
64205
- "kind": "primitive",
64206
- "value": "number"
64207
- },
64208
- "description": "",
64209
- "declarations": [
64210
- {
64211
- "name": "height",
64212
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64213
- }
64214
- ],
64215
- "tags": {}
64216
- }
64217
- ]
64091
+ "kind": "symbol",
64092
+ "name": "Rect",
64093
+ "value": "Rect"
64218
64094
  }
64219
64095
  },
64220
64096
  "description": "",
@@ -64231,43 +64107,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64231
64107
  "name": "initialRect",
64232
64108
  "required": false,
64233
64109
  "type": {
64234
- "kind": "object",
64235
- "properties": [
64236
- {
64237
- "kind": "property",
64238
- "name": "width",
64239
- "required": true,
64240
- "type": {
64241
- "kind": "primitive",
64242
- "value": "number"
64243
- },
64244
- "description": "",
64245
- "declarations": [
64246
- {
64247
- "name": "width",
64248
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64249
- }
64250
- ],
64251
- "tags": {}
64252
- },
64253
- {
64254
- "kind": "property",
64255
- "name": "height",
64256
- "required": true,
64257
- "type": {
64258
- "kind": "primitive",
64259
- "value": "number"
64260
- },
64261
- "description": "",
64262
- "declarations": [
64263
- {
64264
- "name": "height",
64265
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64266
- }
64267
- ],
64268
- "tags": {}
64269
- }
64270
- ]
64110
+ "kind": "symbol",
64111
+ "name": "Rect",
64112
+ "value": "Rect"
64271
64113
  },
64272
64114
  "description": "",
64273
64115
  "declarations": [
@@ -64306,21 +64148,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64306
64148
  ],
64307
64149
  "members": [],
64308
64150
  "returnType": {
64309
- "kind": "type",
64310
- "typeParameters": [],
64311
- "value": {
64312
- "kind": "union",
64313
- "value": [
64314
- {
64315
- "kind": "primitive",
64316
- "value": "number"
64317
- },
64318
- {
64319
- "kind": "primitive",
64320
- "value": "string"
64321
- }
64322
- ]
64323
- }
64151
+ "kind": "symbol",
64152
+ "name": "Key",
64153
+ "value": "Key"
64324
64154
  }
64325
64155
  },
64326
64156
  "description": "",
@@ -66971,23 +66801,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
66971
66801
  "kind": "parameter",
66972
66802
  "name": "model",
66973
66803
  "type": {
66974
- "kind": "type",
66975
- "typeParameters": [],
66976
- "value": {
66977
- "kind": "symbol",
66978
- "name": "Pick",
66979
- "typeParameters": [
66980
- {
66981
- "kind": "symbol",
66982
- "name": "useCursorListModel"
66983
- },
66984
- {
66985
- "kind": "string",
66986
- "value": "state"
66987
- }
66988
- ],
66989
- "value": "Pick<T, K>"
66990
- }
66804
+ "kind": "symbol",
66805
+ "name": "NavigationInput",
66806
+ "value": "NavigationInput"
66991
66807
  },
66992
66808
  "required": true,
66993
66809
  "rest": false,
@@ -67252,23 +67068,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67252
67068
  "kind": "parameter",
67253
67069
  "name": "model",
67254
67070
  "type": {
67255
- "kind": "type",
67256
- "typeParameters": [],
67257
- "value": {
67258
- "kind": "symbol",
67259
- "name": "Pick",
67260
- "typeParameters": [
67261
- {
67262
- "kind": "symbol",
67263
- "name": "useCursorListModel"
67264
- },
67265
- {
67266
- "kind": "string",
67267
- "value": "state"
67268
- }
67269
- ],
67270
- "value": "Pick<T, K>"
67271
- }
67071
+ "kind": "symbol",
67072
+ "name": "NavigationInput",
67073
+ "value": "NavigationInput"
67272
67074
  },
67273
67075
  "required": true,
67274
67076
  "rest": false,
@@ -67451,23 +67253,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67451
67253
  "kind": "parameter",
67452
67254
  "name": "__1",
67453
67255
  "type": {
67454
- "kind": "type",
67455
- "typeParameters": [],
67456
- "value": {
67457
- "kind": "symbol",
67458
- "name": "Pick",
67459
- "typeParameters": [
67460
- {
67461
- "kind": "symbol",
67462
- "name": "useCursorListModel"
67463
- },
67464
- {
67465
- "kind": "string",
67466
- "value": "state"
67467
- }
67468
- ],
67469
- "value": "Pick<T, K>"
67470
- }
67256
+ "kind": "symbol",
67257
+ "name": "NavigationInput",
67258
+ "value": "NavigationInput"
67471
67259
  },
67472
67260
  "required": true,
67473
67261
  "rest": false,
@@ -67574,23 +67362,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67574
67362
  "kind": "parameter",
67575
67363
  "name": "__1",
67576
67364
  "type": {
67577
- "kind": "type",
67578
- "typeParameters": [],
67579
- "value": {
67580
- "kind": "symbol",
67581
- "name": "Pick",
67582
- "typeParameters": [
67583
- {
67584
- "kind": "symbol",
67585
- "name": "useCursorListModel"
67586
- },
67587
- {
67588
- "kind": "string",
67589
- "value": "state"
67590
- }
67591
- ],
67592
- "value": "Pick<T, K>"
67593
- }
67365
+ "kind": "symbol",
67366
+ "name": "NavigationInput",
67367
+ "value": "NavigationInput"
67594
67368
  },
67595
67369
  "required": true,
67596
67370
  "rest": false,
@@ -67717,302 +67491,274 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67717
67491
  "kind": "parameter",
67718
67492
  "name": "model",
67719
67493
  "type": {
67720
- "kind": "type",
67721
- "typeParameters": [],
67722
- "value": {
67723
- "kind": "symbol",
67724
- "name": "Pick",
67725
- "typeParameters": [
67726
- {
67727
- "kind": "symbol",
67728
- "name": "useCursorListModel"
67729
- },
67730
- {
67731
- "kind": "string",
67732
- "value": "state"
67733
- }
67734
- ],
67735
- "value": "Pick<T, K>"
67736
- }
67737
- },
67738
- "required": true,
67739
- "rest": false,
67740
- "description": "",
67741
- "declarations": [
67742
- {
67743
- "name": "model",
67744
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67745
- }
67746
- ],
67747
- "tags": {}
67748
- }
67749
- ],
67750
- "members": [],
67751
- "returnType": {
67752
- "kind": "symbol",
67753
- "name": "Item",
67754
- "typeParameters": [
67755
- {
67756
- "kind": "symbol",
67757
- "name": "Generic",
67758
- "value": "any"
67759
- }
67760
- ],
67761
- "value": "Item<T>"
67762
- }
67763
- },
67764
- "description": "Get an item with the provided `id`.",
67765
- "declarations": [
67766
- {
67767
- "name": "getItem",
67768
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67769
- }
67770
- ],
67771
- "tags": {}
67772
- },
67773
- {
67774
- "kind": "property",
67775
- "name": "getNext",
67776
- "required": true,
67777
- "type": {
67778
- "kind": "symbol",
67779
- "name": "NavigationRequestor",
67780
- "value": "NavigationRequestor"
67781
- },
67782
- "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.",
67783
- "declarations": [
67784
- {
67785
- "name": "getNext",
67786
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67787
- }
67788
- ],
67789
- "tags": {}
67790
- },
67791
- {
67792
- "kind": "property",
67793
- "name": "getNextRow",
67794
- "required": true,
67795
- "type": {
67796
- "kind": "symbol",
67797
- "name": "NavigationRequestor",
67798
- "value": "NavigationRequestor"
67799
- },
67800
- "description": "**For Grids:** Get the cell in the next row from the provided `id`. This will be called when\nthe `Down` arrow is pressed.",
67801
- "declarations": [
67802
- {
67803
- "name": "getNextRow",
67804
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67805
- }
67806
- ],
67807
- "tags": {}
67808
- },
67809
- {
67810
- "kind": "property",
67811
- "name": "getPrevious",
67812
- "required": true,
67813
- "type": {
67814
- "kind": "symbol",
67815
- "name": "NavigationRequestor",
67816
- "value": "NavigationRequestor"
67817
- },
67818
- "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.",
67819
- "declarations": [
67820
- {
67821
- "name": "getPrevious",
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": "getPreviousRow",
67830
- "required": true,
67831
- "type": {
67832
- "kind": "symbol",
67833
- "name": "NavigationRequestor",
67834
- "value": "NavigationRequestor"
67835
- },
67836
- "description": "**For Grids:** Get the cell in the previous row from the provided `id`. This will be called\nwhen the `Up` arrow is pressed.",
67837
- "declarations": [
67838
- {
67839
- "name": "getPreviousRow",
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": "getFirstOfRow",
67848
- "required": true,
67849
- "type": {
67850
- "kind": "symbol",
67851
- "name": "NavigationRequestor",
67852
- "value": "NavigationRequestor"
67853
- },
67854
- "description": "**For Grids:** Get the first item in a row. This will be called when the `Home` key is\npressed.",
67855
- "declarations": [
67856
- {
67857
- "name": "getFirstOfRow",
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": "getLastOfRow",
67866
- "required": true,
67867
- "type": {
67868
- "kind": "symbol",
67869
- "name": "NavigationRequestor",
67870
- "value": "NavigationRequestor"
67871
- },
67872
- "description": "**For Grids:** Get the last item in a row. This will be called when the `End` key is\npressed.",
67873
- "declarations": [
67874
- {
67875
- "name": "getLastOfRow",
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": "getNextPage",
67884
- "required": true,
67885
- "type": {
67886
- "kind": "symbol",
67887
- "name": "NavigationRequestor",
67888
- "value": "NavigationRequestor"
67889
- },
67890
- "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",
67891
- "declarations": [
67892
- {
67893
- "name": "getNextPage",
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": "getPreviousPage",
67902
- "required": true,
67903
- "type": {
67904
- "kind": "symbol",
67905
- "name": "NavigationRequestor",
67906
- "value": "NavigationRequestor"
67907
- },
67908
- "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",
67909
- "declarations": [
67910
- {
67911
- "name": "getPreviousPage",
67912
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67913
- }
67914
- ],
67915
- "tags": {}
67916
- }
67917
- ]
67918
- }
67919
- },
67920
- {
67921
- "name": "navigationManager",
67922
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx",
67923
- "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.",
67924
- "declarations": [
67925
- {
67926
- "name": "navigationManager",
67927
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67928
- }
67929
- ],
67930
- "tags": {},
67931
- "type": {
67932
- "kind": "object",
67933
- "properties": [
67934
- {
67935
- "kind": "property",
67936
- "name": "getFirst",
67937
- "required": true,
67938
- "type": {
67939
- "kind": "symbol",
67940
- "name": "NavigationRequestor",
67941
- "value": "NavigationRequestor"
67942
- },
67943
- "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.",
67944
- "declarations": [
67945
- {
67946
- "name": "getFirst",
67947
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67948
- }
67949
- ],
67950
- "tags": {}
67951
- },
67952
- {
67953
- "kind": "property",
67954
- "name": "getLast",
67955
- "required": true,
67956
- "type": {
67957
- "kind": "symbol",
67958
- "name": "NavigationRequestor",
67959
- "value": "NavigationRequestor"
67960
- },
67961
- "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.",
67962
- "declarations": [
67963
- {
67964
- "name": "getLast",
67965
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67966
- }
67967
- ],
67968
- "tags": {}
67969
- },
67970
- {
67971
- "kind": "property",
67972
- "name": "getItem",
67973
- "required": true,
67974
- "type": {
67975
- "kind": "function",
67976
- "parameters": [
67977
- {
67978
- "kind": "parameter",
67979
- "name": "id",
67980
- "type": {
67981
- "kind": "primitive",
67982
- "value": "string"
67983
- },
67984
- "required": true,
67985
- "rest": false,
67986
- "description": "",
67987
- "declarations": [
67988
- {
67989
- "name": "id",
67990
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67991
- }
67992
- ],
67993
- "tags": {}
67994
- },
67995
- {
67996
- "kind": "parameter",
67997
- "name": "model",
67998
- "type": {
67999
- "kind": "type",
68000
- "typeParameters": [],
68001
- "value": {
68002
- "kind": "symbol",
68003
- "name": "Pick",
68004
- "typeParameters": [
68005
- {
68006
- "kind": "symbol",
68007
- "name": "useCursorListModel"
68008
- },
68009
- {
68010
- "kind": "string",
68011
- "value": "state"
68012
- }
68013
- ],
68014
- "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"
68015
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"
68016
67762
  },
68017
67763
  "required": true,
68018
67764
  "rest": false,
@@ -107445,19 +107191,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107445
107191
  "kind": "typeParameter",
107446
107192
  "name": "T",
107447
107193
  "constraint": {
107448
- "kind": "type",
107449
- "typeParameters": [
107450
- {
107451
- "kind": "typeParameter",
107452
- "name": "T",
107453
- "required": true
107454
- }
107455
- ],
107456
- "value": {
107457
- "kind": "unknown",
107458
- "value": "unknown",
107459
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107460
- }
107194
+ "kind": "symbol",
107195
+ "name": "ResponsiveCSSObject",
107196
+ "value": "ResponsiveCSSObject<T>"
107461
107197
  },
107462
107198
  "required": true
107463
107199
  }
@@ -107467,19 +107203,15 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107467
107203
  "kind": "parameter",
107468
107204
  "name": "styles",
107469
107205
  "type": {
107470
- "kind": "type",
107206
+ "kind": "symbol",
107207
+ "name": "ResponsiveCSSObject",
107471
107208
  "typeParameters": [
107472
107209
  {
107473
- "kind": "typeParameter",
107474
- "name": "T",
107475
- "required": true
107210
+ "kind": "generic",
107211
+ "name": "T"
107476
107212
  }
107477
107213
  ],
107478
- "value": {
107479
- "kind": "unknown",
107480
- "value": "unknown",
107481
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107482
- }
107214
+ "value": "ResponsiveCSSObject<T>"
107483
107215
  },
107484
107216
  "required": true,
107485
107217
  "rest": false,
@@ -109393,19 +109125,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109393
109125
  "kind": "type",
109394
109126
  "typeParameters": [],
109395
109127
  "value": {
109396
- "kind": "type",
109397
- "typeParameters": [
109398
- {
109399
- "kind": "typeParameter",
109400
- "name": "T",
109401
- "required": true
109402
- }
109403
- ],
109404
- "value": {
109405
- "kind": "unknown",
109406
- "value": "unknown",
109407
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109408
- }
109128
+ "kind": "symbol",
109129
+ "name": "RecursivePartial",
109130
+ "value": "RecursivePartial<CanvasTheme>"
109409
109131
  }
109410
109132
  }
109411
109133
  },
@@ -109424,19 +109146,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109424
109146
  "kind": "type",
109425
109147
  "typeParameters": [],
109426
109148
  "value": {
109427
- "kind": "type",
109428
- "typeParameters": [
109429
- {
109430
- "kind": "typeParameter",
109431
- "name": "T",
109432
- "required": true
109433
- }
109434
- ],
109435
- "value": {
109436
- "kind": "unknown",
109437
- "value": "unknown",
109438
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109439
- }
109149
+ "kind": "symbol",
109150
+ "name": "RecursivePartial",
109151
+ "value": "RecursivePartial<CanvasThemePalette>"
109440
109152
  }
109441
109153
  }
109442
109154
  },
@@ -109702,48 +109414,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109702
109414
  "kind": "parameter",
109703
109415
  "name": "type",
109704
109416
  "type": {
109705
- "kind": "type",
109706
- "typeParameters": [],
109707
- "value": {
109708
- "kind": "symbol",
109709
- "name": "Exclude",
109710
- "typeParameters": [
109711
- {
109712
- "kind": "union",
109713
- "value": [
109714
- {
109715
- "kind": "string",
109716
- "value": "alert"
109717
- },
109718
- {
109719
- "kind": "string",
109720
- "value": "error"
109721
- },
109722
- {
109723
- "kind": "string",
109724
- "value": "common"
109725
- },
109726
- {
109727
- "kind": "string",
109728
- "value": "primary"
109729
- },
109730
- {
109731
- "kind": "string",
109732
- "value": "success"
109733
- },
109734
- {
109735
- "kind": "string",
109736
- "value": "neutral"
109737
- }
109738
- ]
109739
- },
109740
- {
109741
- "kind": "string",
109742
- "value": "common"
109743
- }
109744
- ],
109745
- "value": "Exclude<T, U>"
109746
- }
109417
+ "kind": "symbol",
109418
+ "name": "paletteSelection",
109419
+ "value": "paletteSelection"
109747
109420
  },
109748
109421
  "required": true,
109749
109422
  "rest": false,
@@ -109836,48 +109509,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109836
109509
  "kind": "parameter",
109837
109510
  "name": "type",
109838
109511
  "type": {
109839
- "kind": "type",
109840
- "typeParameters": [],
109841
- "value": {
109842
- "kind": "symbol",
109843
- "name": "Exclude",
109844
- "typeParameters": [
109845
- {
109846
- "kind": "union",
109847
- "value": [
109848
- {
109849
- "kind": "string",
109850
- "value": "alert"
109851
- },
109852
- {
109853
- "kind": "string",
109854
- "value": "error"
109855
- },
109856
- {
109857
- "kind": "string",
109858
- "value": "common"
109859
- },
109860
- {
109861
- "kind": "string",
109862
- "value": "primary"
109863
- },
109864
- {
109865
- "kind": "string",
109866
- "value": "success"
109867
- },
109868
- {
109869
- "kind": "string",
109870
- "value": "neutral"
109871
- }
109872
- ]
109873
- },
109874
- {
109875
- "kind": "string",
109876
- "value": "common"
109877
- }
109878
- ],
109879
- "value": "Exclude<T, U>"
109880
- }
109512
+ "kind": "symbol",
109513
+ "name": "paletteSelection",
109514
+ "value": "paletteSelection"
109881
109515
  },
109882
109516
  "required": true,
109883
109517
  "rest": false,
@@ -110665,8 +110299,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
110665
110299
  "name": "React.ComponentProps",
110666
110300
  "typeParameters": [
110667
110301
  {
110668
- "kind": "generic",
110669
- "name": "ElementType"
110302
+ "kind": "symbol",
110303
+ "name": "ElementType",
110304
+ "value": "ElementType"
110670
110305
  }
110671
110306
  ],
110672
110307
  "value": "ComponentProps<T>"
@@ -111811,306 +111446,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
111811
111446
  "kind": "parameter",
111812
111447
  "name": "Component",
111813
111448
  "type": {
111814
- "kind": "function",
111815
- "parameters": [
111816
- {
111817
- "kind": "parameter",
111818
- "name": "props",
111819
- "type": {
111820
- "kind": "type",
111821
- "typeParameters": [
111822
- {
111823
- "kind": "typeParameter",
111824
- "name": "Props",
111825
- "required": true
111826
- },
111827
- {
111828
- "kind": "typeParameter",
111829
- "name": "TElemPropsHook",
111830
- "required": true
111831
- },
111832
- {
111833
- "kind": "typeParameter",
111834
- "name": "E",
111835
- "required": true
111836
- }
111837
- ],
111838
- "value": {
111839
- "kind": "intersection",
111840
- "value": [
111841
- {
111842
- "kind": "generic",
111843
- "name": "Props"
111844
- },
111845
- {
111846
- "kind": "parenthesis",
111847
- "value": {
111848
- "kind": "conditional",
111849
- "check": {
111850
- "kind": "generic",
111851
- "name": "TElemPropsHook"
111852
- },
111853
- "extends": {
111854
- "kind": "function",
111855
- "parameters": [
111856
- {
111857
- "kind": "parameter",
111858
- "name": "args",
111859
- "type": {
111860
- "kind": "array",
111861
- "value": {
111862
- "kind": "primitive",
111863
- "value": "any"
111864
- }
111865
- },
111866
- "required": true,
111867
- "rest": true,
111868
- "description": "",
111869
- "declarations": [
111870
- {
111871
- "name": "args",
111872
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111873
- }
111874
- ],
111875
- "tags": {}
111876
- }
111877
- ],
111878
- "members": [],
111879
- "returnType": {
111880
- "kind": "infer",
111881
- "value": {
111882
- "kind": "typeParameter",
111883
- "name": "TProps",
111884
- "required": true
111885
- }
111886
- }
111887
- },
111888
- "trueType": {
111889
- "kind": "type",
111890
- "typeParameters": [
111891
- {
111892
- "kind": "typeParameter",
111893
- "name": "T",
111894
- "required": true
111895
- }
111896
- ],
111897
- "value": {
111898
- "kind": "unknown",
111899
- "value": "unknown",
111900
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
111901
- }
111902
- },
111903
- "falseType": {
111904
- "kind": "object",
111905
- "properties": [
111906
- {
111907
- "kind": "property",
111908
- "name": "ref",
111909
- "required": true,
111910
- "type": {
111911
- "kind": "generic",
111912
- "name": "ExtractRef"
111913
- },
111914
- "description": "",
111915
- "declarations": [
111916
- {
111917
- "name": "ref",
111918
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111919
- }
111920
- ],
111921
- "tags": {}
111922
- }
111923
- ]
111924
- }
111925
- }
111926
- },
111927
- {
111928
- "kind": "parenthesis",
111929
- "value": {
111930
- "kind": "conditional",
111931
- "check": {
111932
- "kind": "generic",
111933
- "name": "Props"
111934
- },
111935
- "extends": {
111936
- "kind": "object",
111937
- "properties": [
111938
- {
111939
- "kind": "property",
111940
- "name": "children",
111941
- "required": true,
111942
- "type": {
111943
- "kind": "primitive",
111944
- "value": "any"
111945
- },
111946
- "description": "",
111947
- "declarations": [
111948
- {
111949
- "name": "children",
111950
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111951
- }
111952
- ],
111953
- "tags": {}
111954
- }
111955
- ]
111956
- },
111957
- "trueType": {
111958
- "kind": "object",
111959
- "properties": []
111960
- },
111961
- "falseType": {
111962
- "kind": "object",
111963
- "properties": [
111964
- {
111965
- "kind": "property",
111966
- "name": "children",
111967
- "required": false,
111968
- "type": {
111969
- "kind": "external",
111970
- "name": "ReactNode",
111971
- "url": "https://reactjs.org/docs/rendering-elements.html"
111972
- },
111973
- "description": "",
111974
- "declarations": [
111975
- {
111976
- "name": "children",
111977
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111978
- }
111979
- ],
111980
- "tags": {}
111981
- }
111982
- ]
111983
- }
111984
- }
111985
- }
111986
- ]
111987
- }
111988
- },
111989
- "required": true,
111990
- "rest": false,
111991
- "description": "",
111992
- "declarations": [
111993
- {
111994
- "name": "props",
111995
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111996
- }
111997
- ],
111998
- "tags": {}
111999
- },
111449
+ "kind": "component",
111450
+ "props": [
112000
111451
  {
112001
- "kind": "parameter",
112002
- "name": "Element",
112003
- "type": {
112004
- "kind": "conditional",
112005
- "check": {
112006
- "kind": "generic",
112007
- "name": "E"
112008
- },
112009
- "extends": {
112010
- "kind": "primitive",
112011
- "value": "undefined"
112012
- },
112013
- "trueType": {
112014
- "kind": "primitive",
112015
- "value": "never"
112016
- },
112017
- "falseType": {
112018
- "kind": "generic",
112019
- "name": "E"
112020
- }
112021
- },
111452
+ "kind": "property",
111453
+ "name": "ref",
112022
111454
  "required": true,
112023
- "rest": false,
112024
- "description": "",
112025
- "declarations": [
112026
- {
112027
- "name": "Element",
112028
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112029
- }
112030
- ],
112031
- "tags": {}
112032
- },
112033
- {
112034
- "kind": "parameter",
112035
- "name": "model",
112036
111455
  "type": {
112037
- "kind": "conditional",
112038
- "check": {
112039
- "kind": "generic",
112040
- "name": "TModelHook"
112041
- },
112042
- "extends": {
112043
- "kind": "function",
112044
- "parameters": [
112045
- {
112046
- "kind": "parameter",
112047
- "name": "config",
112048
- "type": {
112049
- "kind": "infer",
112050
- "value": {
112051
- "kind": "typeParameter",
112052
- "name": "TConfig",
112053
- "required": true
112054
- }
112055
- },
112056
- "required": true,
112057
- "rest": false,
112058
- "description": "",
112059
- "declarations": [
112060
- {
112061
- "name": "config",
112062
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112063
- }
112064
- ],
112065
- "tags": {}
112066
- }
112067
- ],
112068
- "members": [],
112069
- "returnType": {
112070
- "kind": "infer",
112071
- "value": {
112072
- "kind": "typeParameter",
112073
- "name": "TModel",
112074
- "required": true
112075
- }
112076
- }
112077
- },
112078
- "trueType": {
112079
- "kind": "generic",
112080
- "name": "TModel"
112081
- },
112082
- "falseType": {
112083
- "kind": "primitive",
112084
- "value": "never"
112085
- }
111456
+ "kind": "generic",
111457
+ "name": "ExtractRef"
112086
111458
  },
112087
- "required": true,
112088
- "rest": false,
112089
111459
  "description": "",
112090
111460
  "declarations": [
112091
111461
  {
112092
- "name": "model",
111462
+ "name": "ref",
112093
111463
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112094
111464
  }
112095
111465
  ],
112096
111466
  "tags": {}
112097
111467
  }
112098
- ],
112099
- "members": [],
112100
- "returnType": {
112101
- "kind": "union",
112102
- "value": [
112103
- {
112104
- "kind": "external",
112105
- "name": "Element",
112106
- "url": "https://reactjs.org/docs/rendering-elements.html"
112107
- },
112108
- {
112109
- "kind": "primitive",
112110
- "value": "null"
112111
- }
112112
- ]
112113
- }
111468
+ ]
112114
111469
  },
112115
111470
  "required": true,
112116
111471
  "rest": false,
@@ -112476,7 +111831,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
112476
111831
  }
112477
111832
  ],
112478
111833
  "tags": {
112479
- "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."
112480
111835
  }
112481
111836
  },
112482
111837
  {
@@ -112563,305 +111918,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
112563
111918
  "kind": "parameter",
112564
111919
  "name": "Component",
112565
111920
  "type": {
112566
- "kind": "function",
112567
- "parameters": [
112568
- {
112569
- "kind": "parameter",
112570
- "name": "props",
112571
- "type": {
112572
- "kind": "type",
112573
- "typeParameters": [
112574
- {
112575
- "kind": "typeParameter",
112576
- "name": "Props",
112577
- "required": true
112578
- },
112579
- {
112580
- "kind": "typeParameter",
112581
- "name": "TElemPropsHook",
112582
- "required": true
112583
- },
112584
- {
112585
- "kind": "typeParameter",
112586
- "name": "E",
112587
- "required": true
112588
- }
112589
- ],
112590
- "value": {
112591
- "kind": "intersection",
112592
- "value": [
112593
- {
112594
- "kind": "generic",
112595
- "name": "Props"
112596
- },
112597
- {
112598
- "kind": "parenthesis",
112599
- "value": {
112600
- "kind": "conditional",
112601
- "check": {
112602
- "kind": "generic",
112603
- "name": "TElemPropsHook"
112604
- },
112605
- "extends": {
112606
- "kind": "function",
112607
- "parameters": [
112608
- {
112609
- "kind": "parameter",
112610
- "name": "args",
112611
- "type": {
112612
- "kind": "array",
112613
- "value": {
112614
- "kind": "primitive",
112615
- "value": "any"
112616
- }
112617
- },
112618
- "required": true,
112619
- "rest": true,
112620
- "description": "",
112621
- "declarations": [
112622
- {
112623
- "name": "args",
112624
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112625
- }
112626
- ],
112627
- "tags": {}
112628
- }
112629
- ],
112630
- "members": [],
112631
- "returnType": {
112632
- "kind": "infer",
112633
- "value": {
112634
- "kind": "typeParameter",
112635
- "name": "TProps",
112636
- "required": true
112637
- }
112638
- }
112639
- },
112640
- "trueType": {
112641
- "kind": "type",
112642
- "typeParameters": [
112643
- {
112644
- "kind": "typeParameter",
112645
- "name": "T",
112646
- "required": true
112647
- }
112648
- ],
112649
- "value": {
112650
- "kind": "unknown",
112651
- "value": "unknown",
112652
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
112653
- }
112654
- },
112655
- "falseType": {
112656
- "kind": "object",
112657
- "properties": [
112658
- {
112659
- "kind": "property",
112660
- "name": "ref",
112661
- "required": true,
112662
- "type": {
112663
- "kind": "generic",
112664
- "name": "ExtractRef"
112665
- },
112666
- "description": "",
112667
- "declarations": [
112668
- {
112669
- "name": "ref",
112670
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112671
- }
112672
- ],
112673
- "tags": {}
112674
- }
112675
- ]
112676
- }
112677
- }
112678
- },
112679
- {
112680
- "kind": "parenthesis",
112681
- "value": {
112682
- "kind": "conditional",
112683
- "check": {
112684
- "kind": "generic",
112685
- "name": "Props"
112686
- },
112687
- "extends": {
112688
- "kind": "object",
112689
- "properties": [
112690
- {
112691
- "kind": "property",
112692
- "name": "children",
112693
- "required": true,
112694
- "type": {
112695
- "kind": "primitive",
112696
- "value": "any"
112697
- },
112698
- "description": "",
112699
- "declarations": [
112700
- {
112701
- "name": "children",
112702
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112703
- }
112704
- ],
112705
- "tags": {}
112706
- }
112707
- ]
112708
- },
112709
- "trueType": {
112710
- "kind": "object",
112711
- "properties": []
112712
- },
112713
- "falseType": {
112714
- "kind": "object",
112715
- "properties": [
112716
- {
112717
- "kind": "property",
112718
- "name": "children",
112719
- "required": false,
112720
- "type": {
112721
- "kind": "external",
112722
- "name": "ReactNode",
112723
- "url": "https://reactjs.org/docs/rendering-elements.html"
112724
- },
112725
- "description": "",
112726
- "declarations": [
112727
- {
112728
- "name": "children",
112729
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112730
- }
112731
- ],
112732
- "tags": {}
112733
- }
112734
- ]
112735
- }
112736
- }
112737
- }
112738
- ]
112739
- }
112740
- },
112741
- "required": true,
112742
- "rest": false,
112743
- "description": "",
112744
- "declarations": [
112745
- {
112746
- "name": "props",
112747
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112748
- }
112749
- ],
112750
- "tags": {}
112751
- },
111921
+ "kind": "component",
111922
+ "props": [
112752
111923
  {
112753
- "kind": "parameter",
112754
- "name": "Element",
112755
- "type": {
112756
- "kind": "conditional",
112757
- "check": {
112758
- "kind": "generic",
112759
- "name": "E"
112760
- },
112761
- "extends": {
112762
- "kind": "primitive",
112763
- "value": "undefined"
112764
- },
112765
- "trueType": {
112766
- "kind": "primitive",
112767
- "value": "never"
112768
- },
112769
- "falseType": {
112770
- "kind": "generic",
112771
- "name": "E"
112772
- }
112773
- },
111924
+ "kind": "property",
111925
+ "name": "ref",
112774
111926
  "required": true,
112775
- "rest": false,
112776
- "description": "",
112777
- "declarations": [
112778
- {
112779
- "name": "Element",
112780
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112781
- }
112782
- ],
112783
- "tags": {}
112784
- },
112785
- {
112786
- "kind": "parameter",
112787
- "name": "model",
112788
111927
  "type": {
112789
- "kind": "conditional",
112790
- "check": {
112791
- "kind": "generic",
112792
- "name": "TModelHook"
112793
- },
112794
- "extends": {
112795
- "kind": "function",
112796
- "parameters": [
112797
- {
112798
- "kind": "parameter",
112799
- "name": "args",
112800
- "type": {
112801
- "kind": "array",
112802
- "value": {
112803
- "kind": "primitive",
112804
- "value": "any"
112805
- }
112806
- },
112807
- "required": true,
112808
- "rest": true,
112809
- "description": "",
112810
- "declarations": [
112811
- {
112812
- "name": "args",
112813
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112814
- }
112815
- ],
112816
- "tags": {}
112817
- }
112818
- ],
112819
- "members": [],
112820
- "returnType": {
112821
- "kind": "infer",
112822
- "value": {
112823
- "kind": "typeParameter",
112824
- "name": "TModel",
112825
- "required": true
112826
- }
112827
- }
112828
- },
112829
- "trueType": {
112830
- "kind": "generic",
112831
- "name": "TModel"
112832
- },
112833
- "falseType": {
112834
- "kind": "primitive",
112835
- "value": "never"
112836
- }
111928
+ "kind": "generic",
111929
+ "name": "ExtractRef"
112837
111930
  },
112838
- "required": true,
112839
- "rest": false,
112840
111931
  "description": "",
112841
111932
  "declarations": [
112842
111933
  {
112843
- "name": "model",
111934
+ "name": "ref",
112844
111935
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112845
111936
  }
112846
111937
  ],
112847
111938
  "tags": {}
112848
111939
  }
112849
- ],
112850
- "members": [],
112851
- "returnType": {
112852
- "kind": "union",
112853
- "value": [
112854
- {
112855
- "kind": "external",
112856
- "name": "Element",
112857
- "url": "https://reactjs.org/docs/rendering-elements.html"
112858
- },
112859
- {
112860
- "kind": "primitive",
112861
- "value": "null"
112862
- }
112863
- ]
112864
- }
111940
+ ]
112865
111941
  },
112866
111942
  "required": true,
112867
111943
  "rest": false,
@@ -113103,9 +112179,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
113103
112179
  "name": "Component",
113104
112180
  "required": true,
113105
112181
  "type": {
113106
- "kind": "unknown",
113107
- "value": "unknown",
113108
- "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>"
113109
112185
  },
113110
112186
  "description": "The component function. The function looks like:",
113111
112187
  "declarations": [
@@ -113708,7 +112784,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
113708
112784
  }
113709
112785
  ],
113710
112786
  "tags": {
113711
- "deprecated": "use `createSubModelElemPropsHook` instead"
112787
+ "deprecated": "⚠️ `subModelHook` has been deprecated and will be removed in a future major version. Please use `createSubModelElemPropsHook` instead."
113712
112788
  },
113713
112789
  "type": {
113714
112790
  "kind": "function",
@@ -114972,78 +114048,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
114972
114048
  "name": "H2"
114973
114049
  },
114974
114050
  "extends": {
114975
- "kind": "object",
114976
- "properties": [
114051
+ "kind": "symbol",
114052
+ "name": "BaseHook",
114053
+ "typeParameters": [
114977
114054
  {
114978
- "kind": "property",
114979
- "name": "__model",
114980
- "required": true,
114981
- "type": {
114982
- "kind": "generic",
114983
- "name": "M"
114984
- },
114985
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
114986
- "declarations": [
114987
- {
114988
- "name": "__model",
114989
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
114990
- }
114991
- ],
114992
- "tags": {
114993
- "private": ""
114994
- }
114055
+ "kind": "primitive",
114056
+ "value": "any"
114995
114057
  },
114996
114058
  {
114997
- "kind": "property",
114998
- "name": "__output",
114999
- "required": true,
115000
- "type": {
115001
- "kind": "generic",
115002
- "name": "O"
115003
- },
115004
- "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",
115005
- "declarations": [
115006
- {
115007
- "name": "__output",
115008
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115009
- }
115010
- ],
115011
- "tags": {
115012
- "private": ""
114059
+ "kind": "infer",
114060
+ "value": {
114061
+ "kind": "typeParameter",
114062
+ "name": "O2",
114063
+ "required": true
115013
114064
  }
115014
114065
  }
115015
114066
  ],
115016
- "typeParameters": [
115017
- {
115018
- "kind": "typeParameter",
115019
- "name": "M",
115020
- "constraint": {
115021
- "kind": "symbol",
115022
- "name": "Model",
115023
- "typeParameters": [
115024
- {
115025
- "kind": "primitive",
115026
- "value": "any"
115027
- },
115028
- {
115029
- "kind": "primitive",
115030
- "value": "any"
115031
- }
115032
- ],
115033
- "value": "Model<State, Events>"
115034
- },
115035
- "required": true
115036
- },
115037
- {
115038
- "kind": "typeParameter",
115039
- "name": "O",
115040
- "constraint": {
115041
- "kind": "object",
115042
- "properties": []
115043
- },
115044
- "required": true
115045
- }
115046
- ]
114067
+ "value": "BaseHook<M, O>"
115047
114068
  },
115048
114069
  "trueType": {
115049
114070
  "kind": "conditional",
@@ -115052,78 +114073,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115052
114073
  "name": "H3"
115053
114074
  },
115054
114075
  "extends": {
115055
- "kind": "object",
115056
- "properties": [
114076
+ "kind": "symbol",
114077
+ "name": "BaseHook",
114078
+ "typeParameters": [
115057
114079
  {
115058
- "kind": "property",
115059
- "name": "__model",
115060
- "required": true,
115061
- "type": {
115062
- "kind": "generic",
115063
- "name": "M"
115064
- },
115065
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115066
- "declarations": [
115067
- {
115068
- "name": "__model",
115069
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115070
- }
115071
- ],
115072
- "tags": {
115073
- "private": ""
115074
- }
114080
+ "kind": "primitive",
114081
+ "value": "any"
115075
114082
  },
115076
114083
  {
115077
- "kind": "property",
115078
- "name": "__output",
115079
- "required": true,
115080
- "type": {
115081
- "kind": "generic",
115082
- "name": "O"
115083
- },
115084
- "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",
115085
- "declarations": [
115086
- {
115087
- "name": "__output",
115088
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115089
- }
115090
- ],
115091
- "tags": {
115092
- "private": ""
114084
+ "kind": "infer",
114085
+ "value": {
114086
+ "kind": "typeParameter",
114087
+ "name": "O3",
114088
+ "required": true
115093
114089
  }
115094
114090
  }
115095
114091
  ],
115096
- "typeParameters": [
115097
- {
115098
- "kind": "typeParameter",
115099
- "name": "M",
115100
- "constraint": {
115101
- "kind": "symbol",
115102
- "name": "Model",
115103
- "typeParameters": [
115104
- {
115105
- "kind": "primitive",
115106
- "value": "any"
115107
- },
115108
- {
115109
- "kind": "primitive",
115110
- "value": "any"
115111
- }
115112
- ],
115113
- "value": "Model<State, Events>"
115114
- },
115115
- "required": true
115116
- },
115117
- {
115118
- "kind": "typeParameter",
115119
- "name": "O",
115120
- "constraint": {
115121
- "kind": "object",
115122
- "properties": []
115123
- },
115124
- "required": true
115125
- }
115126
- ]
114092
+ "value": "BaseHook<M, O>"
115127
114093
  },
115128
114094
  "trueType": {
115129
114095
  "kind": "conditional",
@@ -115132,78 +114098,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115132
114098
  "name": "H4"
115133
114099
  },
115134
114100
  "extends": {
115135
- "kind": "object",
115136
- "properties": [
114101
+ "kind": "symbol",
114102
+ "name": "BaseHook",
114103
+ "typeParameters": [
115137
114104
  {
115138
- "kind": "property",
115139
- "name": "__model",
115140
- "required": true,
115141
- "type": {
115142
- "kind": "generic",
115143
- "name": "M"
115144
- },
115145
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115146
- "declarations": [
115147
- {
115148
- "name": "__model",
115149
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115150
- }
115151
- ],
115152
- "tags": {
115153
- "private": ""
115154
- }
114105
+ "kind": "primitive",
114106
+ "value": "any"
115155
114107
  },
115156
114108
  {
115157
- "kind": "property",
115158
- "name": "__output",
115159
- "required": true,
115160
- "type": {
115161
- "kind": "generic",
115162
- "name": "O"
115163
- },
115164
- "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",
115165
- "declarations": [
115166
- {
115167
- "name": "__output",
115168
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115169
- }
115170
- ],
115171
- "tags": {
115172
- "private": ""
114109
+ "kind": "infer",
114110
+ "value": {
114111
+ "kind": "typeParameter",
114112
+ "name": "O4",
114113
+ "required": true
115173
114114
  }
115174
114115
  }
115175
114116
  ],
115176
- "typeParameters": [
115177
- {
115178
- "kind": "typeParameter",
115179
- "name": "M",
115180
- "constraint": {
115181
- "kind": "symbol",
115182
- "name": "Model",
115183
- "typeParameters": [
115184
- {
115185
- "kind": "primitive",
115186
- "value": "any"
115187
- },
115188
- {
115189
- "kind": "primitive",
115190
- "value": "any"
115191
- }
115192
- ],
115193
- "value": "Model<State, Events>"
115194
- },
115195
- "required": true
115196
- },
115197
- {
115198
- "kind": "typeParameter",
115199
- "name": "O",
115200
- "constraint": {
115201
- "kind": "object",
115202
- "properties": []
115203
- },
115204
- "required": true
115205
- }
115206
- ]
114117
+ "value": "BaseHook<M, O>"
115207
114118
  },
115208
114119
  "trueType": {
115209
114120
  "kind": "conditional",
@@ -115212,78 +114123,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115212
114123
  "name": "H5"
115213
114124
  },
115214
114125
  "extends": {
115215
- "kind": "object",
115216
- "properties": [
114126
+ "kind": "symbol",
114127
+ "name": "BaseHook",
114128
+ "typeParameters": [
115217
114129
  {
115218
- "kind": "property",
115219
- "name": "__model",
115220
- "required": true,
115221
- "type": {
115222
- "kind": "generic",
115223
- "name": "M"
115224
- },
115225
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115226
- "declarations": [
115227
- {
115228
- "name": "__model",
115229
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115230
- }
115231
- ],
115232
- "tags": {
115233
- "private": ""
115234
- }
114130
+ "kind": "primitive",
114131
+ "value": "any"
115235
114132
  },
115236
114133
  {
115237
- "kind": "property",
115238
- "name": "__output",
115239
- "required": true,
115240
- "type": {
115241
- "kind": "generic",
115242
- "name": "O"
115243
- },
115244
- "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",
115245
- "declarations": [
115246
- {
115247
- "name": "__output",
115248
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115249
- }
115250
- ],
115251
- "tags": {
115252
- "private": ""
114134
+ "kind": "infer",
114135
+ "value": {
114136
+ "kind": "typeParameter",
114137
+ "name": "O5",
114138
+ "required": true
115253
114139
  }
115254
114140
  }
115255
114141
  ],
115256
- "typeParameters": [
115257
- {
115258
- "kind": "typeParameter",
115259
- "name": "M",
115260
- "constraint": {
115261
- "kind": "symbol",
115262
- "name": "Model",
115263
- "typeParameters": [
115264
- {
115265
- "kind": "primitive",
115266
- "value": "any"
115267
- },
115268
- {
115269
- "kind": "primitive",
115270
- "value": "any"
115271
- }
115272
- ],
115273
- "value": "Model<State, Events>"
115274
- },
115275
- "required": true
115276
- },
115277
- {
115278
- "kind": "typeParameter",
115279
- "name": "O",
115280
- "constraint": {
115281
- "kind": "object",
115282
- "properties": []
115283
- },
115284
- "required": true
115285
- }
115286
- ]
114142
+ "value": "BaseHook<M, O>"
115287
114143
  },
115288
114144
  "trueType": {
115289
114145
  "kind": "conditional",
@@ -115292,78 +114148,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115292
114148
  "name": "H6"
115293
114149
  },
115294
114150
  "extends": {
115295
- "kind": "object",
115296
- "properties": [
114151
+ "kind": "symbol",
114152
+ "name": "BaseHook",
114153
+ "typeParameters": [
115297
114154
  {
115298
- "kind": "property",
115299
- "name": "__model",
115300
- "required": true,
115301
- "type": {
115302
- "kind": "generic",
115303
- "name": "M"
115304
- },
115305
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115306
- "declarations": [
115307
- {
115308
- "name": "__model",
115309
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115310
- }
115311
- ],
115312
- "tags": {
115313
- "private": ""
115314
- }
114155
+ "kind": "primitive",
114156
+ "value": "any"
115315
114157
  },
115316
114158
  {
115317
- "kind": "property",
115318
- "name": "__output",
115319
- "required": true,
115320
- "type": {
115321
- "kind": "generic",
115322
- "name": "O"
115323
- },
115324
- "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",
115325
- "declarations": [
115326
- {
115327
- "name": "__output",
115328
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115329
- }
115330
- ],
115331
- "tags": {
115332
- "private": ""
114159
+ "kind": "infer",
114160
+ "value": {
114161
+ "kind": "typeParameter",
114162
+ "name": "O6",
114163
+ "required": true
115333
114164
  }
115334
114165
  }
115335
114166
  ],
115336
- "typeParameters": [
115337
- {
115338
- "kind": "typeParameter",
115339
- "name": "M",
115340
- "constraint": {
115341
- "kind": "symbol",
115342
- "name": "Model",
115343
- "typeParameters": [
115344
- {
115345
- "kind": "primitive",
115346
- "value": "any"
115347
- },
115348
- {
115349
- "kind": "primitive",
115350
- "value": "any"
115351
- }
115352
- ],
115353
- "value": "Model<State, Events>"
115354
- },
115355
- "required": true
115356
- },
115357
- {
115358
- "kind": "typeParameter",
115359
- "name": "O",
115360
- "constraint": {
115361
- "kind": "object",
115362
- "properties": []
115363
- },
115364
- "required": true
115365
- }
115366
- ]
114167
+ "value": "BaseHook<M, O>"
115367
114168
  },
115368
114169
  "trueType": {
115369
114170
  "kind": "symbol",
@@ -116561,7 +115362,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116561
115362
  }
116562
115363
  ],
116563
115364
  "tags": {
116564
- "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`."
116565
115366
  },
116566
115367
  "type": {
116567
115368
  "kind": "object",
@@ -116668,7 +115469,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116668
115469
  ],
116669
115470
  "tags": {
116670
115471
  "example": "type ModelConfig = {\n // additional config your model requires goes here\n id?: string\n} & Partial<ToModelConfig<State, Events, typeof eventMap>>",
116671
- "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."
116672
115473
  },
116673
115474
  "type": {
116674
115475
  "kind": "type",
@@ -116785,45 +115586,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116785
115586
  "kind": "typeParameter",
116786
115587
  "name": "TEvents",
116787
115588
  "constraint": {
116788
- "kind": "object",
116789
- "properties": [],
116790
- "indexSignature": {
116791
- "kind": "indexSignature",
116792
- "name": "key",
116793
- "type": {
116794
- "kind": "primitive",
116795
- "value": "string"
116796
- },
116797
- "value": {
116798
- "kind": "function",
116799
- "parameters": [
116800
- {
116801
- "kind": "parameter",
116802
- "name": "data",
116803
- "type": {
116804
- "kind": "unknown",
116805
- "value": "unknown",
116806
- "text": "object"
116807
- },
116808
- "required": false,
116809
- "rest": false,
116810
- "description": "",
116811
- "declarations": [
116812
- {
116813
- "name": "data",
116814
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116815
- }
116816
- ],
116817
- "tags": {}
116818
- }
116819
- ],
116820
- "members": [],
116821
- "returnType": {
116822
- "kind": "primitive",
116823
- "value": "void"
116824
- }
116825
- }
116826
- }
115589
+ "kind": "symbol",
115590
+ "name": "IEvent",
115591
+ "value": "IEvent"
116827
115592
  },
116828
115593
  "required": true
116829
115594
  },
@@ -116878,198 +115643,14 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116878
115643
  "kind": "intersection",
116879
115644
  "value": [
116880
115645
  {
116881
- "kind": "type",
116882
- "typeParameters": [
116883
- {
116884
- "kind": "typeParameter",
116885
- "name": "TState",
116886
- "constraint": {
116887
- "kind": "external",
116888
- "name": "Record",
116889
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116890
- "typeParameters": [
116891
- {
116892
- "kind": "primitive",
116893
- "value": "string"
116894
- },
116895
- {
116896
- "kind": "primitive",
116897
- "value": "any"
116898
- }
116899
- ]
116900
- },
116901
- "required": true
116902
- },
116903
- {
116904
- "kind": "typeParameter",
116905
- "name": "TEvents",
116906
- "constraint": {
116907
- "kind": "object",
116908
- "properties": [],
116909
- "indexSignature": {
116910
- "kind": "indexSignature",
116911
- "name": "key",
116912
- "type": {
116913
- "kind": "primitive",
116914
- "value": "string"
116915
- },
116916
- "value": {
116917
- "kind": "function",
116918
- "parameters": [
116919
- {
116920
- "kind": "parameter",
116921
- "name": "data",
116922
- "type": {
116923
- "kind": "unknown",
116924
- "value": "unknown",
116925
- "text": "object"
116926
- },
116927
- "required": false,
116928
- "rest": false,
116929
- "description": "",
116930
- "declarations": [
116931
- {
116932
- "name": "data",
116933
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116934
- }
116935
- ],
116936
- "tags": {}
116937
- }
116938
- ],
116939
- "members": [],
116940
- "returnType": {
116941
- "kind": "primitive",
116942
- "value": "void"
116943
- }
116944
- }
116945
- }
116946
- },
116947
- "required": true
116948
- },
116949
- {
116950
- "kind": "typeParameter",
116951
- "name": "TGuardMap",
116952
- "constraint": {
116953
- "kind": "external",
116954
- "name": "Record",
116955
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116956
- "typeParameters": [
116957
- {
116958
- "kind": "primitive",
116959
- "value": "string"
116960
- },
116961
- {
116962
- "kind": "unknown",
116963
- "value": "unknown",
116964
- "text": "keyof TEvents"
116965
- }
116966
- ]
116967
- },
116968
- "required": true
116969
- }
116970
- ],
116971
- "value": {
116972
- "kind": "unknown",
116973
- "value": "unknown",
116974
- "text": "{\n [K in keyof TGuardMap]: (event: {\n data: Parameters<TEvents[TGuardMap[K]]>[0];\n state: TState;\n }) => boolean;\n}"
116975
- }
115646
+ "kind": "symbol",
115647
+ "name": "ToGuardConfig",
115648
+ "value": "ToGuardConfig<TState, TEvents, TEventMap[\"guards\"]>"
116976
115649
  },
116977
115650
  {
116978
- "kind": "type",
116979
- "typeParameters": [
116980
- {
116981
- "kind": "typeParameter",
116982
- "name": "TState",
116983
- "constraint": {
116984
- "kind": "external",
116985
- "name": "Record",
116986
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116987
- "typeParameters": [
116988
- {
116989
- "kind": "primitive",
116990
- "value": "string"
116991
- },
116992
- {
116993
- "kind": "primitive",
116994
- "value": "any"
116995
- }
116996
- ]
116997
- },
116998
- "required": true
116999
- },
117000
- {
117001
- "kind": "typeParameter",
117002
- "name": "TEvents",
117003
- "constraint": {
117004
- "kind": "object",
117005
- "properties": [],
117006
- "indexSignature": {
117007
- "kind": "indexSignature",
117008
- "name": "key",
117009
- "type": {
117010
- "kind": "primitive",
117011
- "value": "string"
117012
- },
117013
- "value": {
117014
- "kind": "function",
117015
- "parameters": [
117016
- {
117017
- "kind": "parameter",
117018
- "name": "data",
117019
- "type": {
117020
- "kind": "unknown",
117021
- "value": "unknown",
117022
- "text": "object"
117023
- },
117024
- "required": false,
117025
- "rest": false,
117026
- "description": "",
117027
- "declarations": [
117028
- {
117029
- "name": "data",
117030
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117031
- }
117032
- ],
117033
- "tags": {}
117034
- }
117035
- ],
117036
- "members": [],
117037
- "returnType": {
117038
- "kind": "primitive",
117039
- "value": "void"
117040
- }
117041
- }
117042
- }
117043
- },
117044
- "required": true
117045
- },
117046
- {
117047
- "kind": "typeParameter",
117048
- "name": "TCallbackMap",
117049
- "constraint": {
117050
- "kind": "external",
117051
- "name": "Record",
117052
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117053
- "typeParameters": [
117054
- {
117055
- "kind": "primitive",
117056
- "value": "string"
117057
- },
117058
- {
117059
- "kind": "unknown",
117060
- "value": "unknown",
117061
- "text": "keyof TEvents"
117062
- }
117063
- ]
117064
- },
117065
- "required": true
117066
- }
117067
- ],
117068
- "value": {
117069
- "kind": "unknown",
117070
- "value": "unknown",
117071
- "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}"
117072
- }
115651
+ "kind": "symbol",
115652
+ "name": "ToCallbackConfig",
115653
+ "value": "ToCallbackConfig<TState, TEvents, TEventMap[\"callbacks\"]>"
117073
115654
  }
117074
115655
  ]
117075
115656
  }
@@ -117087,7 +115668,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117087
115668
  ],
117088
115669
  "tags": {
117089
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})",
117090
- "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."
117091
115672
  },
117092
115673
  "type": {
117093
115674
  "kind": "function",
@@ -117238,45 +115819,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117238
115819
  "kind": "typeParameter",
117239
115820
  "name": "TEvents",
117240
115821
  "constraint": {
117241
- "kind": "object",
117242
- "properties": [],
117243
- "indexSignature": {
117244
- "kind": "indexSignature",
117245
- "name": "key",
117246
- "type": {
117247
- "kind": "primitive",
117248
- "value": "string"
117249
- },
117250
- "value": {
117251
- "kind": "function",
117252
- "parameters": [
117253
- {
117254
- "kind": "parameter",
117255
- "name": "data",
117256
- "type": {
117257
- "kind": "unknown",
117258
- "value": "unknown",
117259
- "text": "object"
117260
- },
117261
- "required": false,
117262
- "rest": false,
117263
- "description": "",
117264
- "declarations": [
117265
- {
117266
- "name": "data",
117267
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117268
- }
117269
- ],
117270
- "tags": {}
117271
- }
117272
- ],
117273
- "members": [],
117274
- "returnType": {
117275
- "kind": "primitive",
117276
- "value": "void"
117277
- }
117278
- }
117279
- }
115822
+ "kind": "symbol",
115823
+ "name": "IEvent",
115824
+ "value": "IEvent"
117280
115825
  },
117281
115826
  "required": true
117282
115827
  },
@@ -117341,133 +115886,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117341
115886
  ],
117342
115887
  "members": [],
117343
115888
  "returnType": {
117344
- "kind": "object",
117345
- "properties": [
117346
- {
117347
- "kind": "property",
117348
- "name": "guards",
117349
- "required": true,
117350
- "type": {
117351
- "kind": "generic",
117352
- "name": "TGuardMap"
117353
- },
117354
- "description": "",
117355
- "declarations": [
117356
- {
117357
- "name": "guards",
117358
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117359
- }
117360
- ],
117361
- "tags": {}
117362
- },
117363
- {
117364
- "kind": "property",
117365
- "name": "callbacks",
117366
- "required": true,
117367
- "type": {
117368
- "kind": "generic",
117369
- "name": "TCallbackMap"
117370
- },
117371
- "description": "",
117372
- "declarations": [
117373
- {
117374
- "name": "callbacks",
117375
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117376
- }
117377
- ],
117378
- "tags": {}
117379
- }
117380
- ],
115889
+ "kind": "symbol",
115890
+ "name": "EventMap",
117381
115891
  "typeParameters": [
117382
115892
  {
117383
- "kind": "typeParameter",
117384
- "name": "TEvents",
117385
- "constraint": {
117386
- "kind": "object",
117387
- "properties": [],
117388
- "indexSignature": {
117389
- "kind": "indexSignature",
117390
- "name": "key",
117391
- "type": {
117392
- "kind": "primitive",
117393
- "value": "string"
117394
- },
117395
- "value": {
117396
- "kind": "function",
117397
- "parameters": [
117398
- {
117399
- "kind": "parameter",
117400
- "name": "data",
117401
- "type": {
117402
- "kind": "unknown",
117403
- "value": "unknown",
117404
- "text": "object"
117405
- },
117406
- "required": false,
117407
- "rest": false,
117408
- "description": "",
117409
- "declarations": [
117410
- {
117411
- "name": "data",
117412
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117413
- }
117414
- ],
117415
- "tags": {}
117416
- }
117417
- ],
117418
- "members": [],
117419
- "returnType": {
117420
- "kind": "primitive",
117421
- "value": "void"
117422
- }
117423
- }
117424
- }
117425
- },
117426
- "required": true
115893
+ "kind": "generic",
115894
+ "name": "TEvents"
117427
115895
  },
117428
115896
  {
117429
- "kind": "typeParameter",
117430
- "name": "TGuardMap",
117431
- "constraint": {
117432
- "kind": "external",
117433
- "name": "Record",
117434
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117435
- "typeParameters": [
117436
- {
117437
- "kind": "primitive",
117438
- "value": "string"
117439
- },
117440
- {
117441
- "kind": "unknown",
117442
- "value": "unknown",
117443
- "text": "keyof TEvents"
117444
- }
117445
- ]
117446
- },
117447
- "required": true
115897
+ "kind": "generic",
115898
+ "name": "TGuardMap"
117448
115899
  },
117449
115900
  {
117450
- "kind": "typeParameter",
117451
- "name": "TCallbackMap",
117452
- "constraint": {
117453
- "kind": "external",
117454
- "name": "Record",
117455
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117456
- "typeParameters": [
117457
- {
117458
- "kind": "primitive",
117459
- "value": "string"
117460
- },
117461
- {
117462
- "kind": "unknown",
117463
- "value": "unknown",
117464
- "text": "keyof TEvents"
117465
- }
117466
- ]
117467
- },
117468
- "required": true
115901
+ "kind": "generic",
115902
+ "name": "TCallbackMap"
117469
115903
  }
117470
- ]
115904
+ ],
115905
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117471
115906
  }
117472
115907
  }
117473
115908
  }
@@ -117485,7 +115920,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117485
115920
  "tags": {
117486
115921
  "param": "eventMap\nstate\nconfig\nevents",
117487
115922
  "example": "const useDiscloseModel = (config: ModelConfig = {}): DiscloseModel => {\n const events = useEventMap(eventMap, state, config, {\n open() {\n // do something\n }\n }\n})",
117488
- "deprecated": "Use `createModelHook` instead"
115923
+ "deprecated": "⚠️ `useEventMap` has been deprecated and will be removed in a future major version. Please use `createModelHook` instead."
117489
115924
  },
117490
115925
  "type": {
117491
115926
  "kind": "function",
@@ -117660,45 +116095,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117660
116095
  "kind": "typeParameter",
117661
116096
  "name": "TEvents",
117662
116097
  "constraint": {
117663
- "kind": "object",
117664
- "properties": [],
117665
- "indexSignature": {
117666
- "kind": "indexSignature",
117667
- "name": "key",
117668
- "type": {
117669
- "kind": "primitive",
117670
- "value": "string"
117671
- },
117672
- "value": {
117673
- "kind": "function",
117674
- "parameters": [
117675
- {
117676
- "kind": "parameter",
117677
- "name": "data",
117678
- "type": {
117679
- "kind": "unknown",
117680
- "value": "unknown",
117681
- "text": "object"
117682
- },
117683
- "required": false,
117684
- "rest": false,
117685
- "description": "",
117686
- "declarations": [
117687
- {
117688
- "name": "data",
117689
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117690
- }
117691
- ],
117692
- "tags": {}
117693
- }
117694
- ],
117695
- "members": [],
117696
- "returnType": {
117697
- "kind": "primitive",
117698
- "value": "void"
117699
- }
117700
- }
117701
- }
116098
+ "kind": "symbol",
116099
+ "name": "IEvent",
116100
+ "value": "IEvent"
117702
116101
  },
117703
116102
  "required": true
117704
116103
  },
@@ -117760,133 +116159,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117760
116159
  "kind": "parameter",
117761
116160
  "name": "eventMap",
117762
116161
  "type": {
117763
- "kind": "object",
117764
- "properties": [
117765
- {
117766
- "kind": "property",
117767
- "name": "guards",
117768
- "required": true,
117769
- "type": {
117770
- "kind": "generic",
117771
- "name": "TGuardMap"
117772
- },
117773
- "description": "",
117774
- "declarations": [
117775
- {
117776
- "name": "guards",
117777
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117778
- }
117779
- ],
117780
- "tags": {}
117781
- },
117782
- {
117783
- "kind": "property",
117784
- "name": "callbacks",
117785
- "required": true,
117786
- "type": {
117787
- "kind": "generic",
117788
- "name": "TCallbackMap"
117789
- },
117790
- "description": "",
117791
- "declarations": [
117792
- {
117793
- "name": "callbacks",
117794
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117795
- }
117796
- ],
117797
- "tags": {}
117798
- }
117799
- ],
116162
+ "kind": "symbol",
116163
+ "name": "EventMap",
117800
116164
  "typeParameters": [
117801
116165
  {
117802
- "kind": "typeParameter",
117803
- "name": "TEvents",
117804
- "constraint": {
117805
- "kind": "object",
117806
- "properties": [],
117807
- "indexSignature": {
117808
- "kind": "indexSignature",
117809
- "name": "key",
117810
- "type": {
117811
- "kind": "primitive",
117812
- "value": "string"
117813
- },
117814
- "value": {
117815
- "kind": "function",
117816
- "parameters": [
117817
- {
117818
- "kind": "parameter",
117819
- "name": "data",
117820
- "type": {
117821
- "kind": "unknown",
117822
- "value": "unknown",
117823
- "text": "object"
117824
- },
117825
- "required": false,
117826
- "rest": false,
117827
- "description": "",
117828
- "declarations": [
117829
- {
117830
- "name": "data",
117831
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117832
- }
117833
- ],
117834
- "tags": {}
117835
- }
117836
- ],
117837
- "members": [],
117838
- "returnType": {
117839
- "kind": "primitive",
117840
- "value": "void"
117841
- }
117842
- }
117843
- }
117844
- },
117845
- "required": true
116166
+ "kind": "generic",
116167
+ "name": "TEvents"
117846
116168
  },
117847
116169
  {
117848
- "kind": "typeParameter",
117849
- "name": "TGuardMap",
117850
- "constraint": {
117851
- "kind": "external",
117852
- "name": "Record",
117853
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117854
- "typeParameters": [
117855
- {
117856
- "kind": "primitive",
117857
- "value": "string"
117858
- },
117859
- {
117860
- "kind": "unknown",
117861
- "value": "unknown",
117862
- "text": "keyof TEvents"
117863
- }
117864
- ]
117865
- },
117866
- "required": true
116170
+ "kind": "generic",
116171
+ "name": "TGuardMap"
117867
116172
  },
117868
116173
  {
117869
- "kind": "typeParameter",
117870
- "name": "TCallbackMap",
117871
- "constraint": {
117872
- "kind": "external",
117873
- "name": "Record",
117874
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117875
- "typeParameters": [
117876
- {
117877
- "kind": "primitive",
117878
- "value": "string"
117879
- },
117880
- {
117881
- "kind": "unknown",
117882
- "value": "unknown",
117883
- "text": "keyof TEvents"
117884
- }
117885
- ]
117886
- },
117887
- "required": true
116174
+ "kind": "generic",
116175
+ "name": "TCallbackMap"
117888
116176
  }
117889
- ]
116177
+ ],
116178
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117890
116179
  },
117891
116180
  "required": true,
117892
116181
  "rest": false,
@@ -118263,48 +116552,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118263
116552
  "kind": "typeParameter",
118264
116553
  "name": "TEvents",
118265
116554
  "constraint": {
118266
- "kind": "object",
118267
- "properties": [],
118268
- "indexSignature": {
118269
- "kind": "indexSignature",
118270
- "name": "key",
118271
- "type": {
118272
- "kind": "primitive",
118273
- "value": "string"
118274
- },
118275
- "value": {
118276
- "kind": "function",
118277
- "parameters": [
118278
- {
118279
- "kind": "parameter",
118280
- "name": "args",
118281
- "type": {
118282
- "kind": "array",
118283
- "value": {
118284
- "kind": "primitive",
118285
- "value": "any"
118286
- }
118287
- },
118288
- "required": true,
118289
- "rest": true,
118290
- "description": "",
118291
- "declarations": [
118292
- {
118293
- "name": "args",
118294
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118295
- }
118296
- ],
118297
- "tags": {}
118298
- }
118299
- ],
118300
- "members": [],
118301
- "returnType": {
118302
- "kind": "unknown",
118303
- "value": "unknown",
118304
- "text": "object"
118305
- }
118306
- }
118307
- }
116555
+ "kind": "symbol",
116556
+ "name": "EventCreator",
116557
+ "value": "EventCreator"
118308
116558
  },
118309
116559
  "required": true
118310
116560
  },
@@ -118326,133 +116576,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118326
116576
  "text": "config"
118327
116577
  },
118328
116578
  "type": {
118329
- "kind": "object",
118330
- "properties": [
118331
- {
118332
- "kind": "property",
118333
- "name": "guards",
118334
- "required": true,
118335
- "type": {
118336
- "kind": "generic",
118337
- "name": "TGuardMap"
118338
- },
118339
- "description": "",
118340
- "declarations": [
118341
- {
118342
- "name": "guards",
118343
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118344
- }
118345
- ],
118346
- "tags": {}
118347
- },
118348
- {
118349
- "kind": "property",
118350
- "name": "callbacks",
118351
- "required": true,
118352
- "type": {
118353
- "kind": "generic",
118354
- "name": "TCallbackMap"
118355
- },
118356
- "description": "",
118357
- "declarations": [
118358
- {
118359
- "name": "callbacks",
118360
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118361
- }
118362
- ],
118363
- "tags": {}
118364
- }
118365
- ],
118366
- "typeParameters": [
118367
- {
118368
- "kind": "typeParameter",
118369
- "name": "TEvents",
118370
- "constraint": {
118371
- "kind": "object",
118372
- "properties": [],
118373
- "indexSignature": {
118374
- "kind": "indexSignature",
118375
- "name": "key",
118376
- "type": {
118377
- "kind": "primitive",
118378
- "value": "string"
118379
- },
118380
- "value": {
118381
- "kind": "function",
118382
- "parameters": [
118383
- {
118384
- "kind": "parameter",
118385
- "name": "data",
118386
- "type": {
118387
- "kind": "unknown",
118388
- "value": "unknown",
118389
- "text": "object"
118390
- },
118391
- "required": false,
118392
- "rest": false,
118393
- "description": "",
118394
- "declarations": [
118395
- {
118396
- "name": "data",
118397
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118398
- }
118399
- ],
118400
- "tags": {}
118401
- }
118402
- ],
118403
- "members": [],
118404
- "returnType": {
118405
- "kind": "primitive",
118406
- "value": "void"
118407
- }
118408
- }
118409
- }
118410
- },
118411
- "required": true
118412
- },
118413
- {
118414
- "kind": "typeParameter",
118415
- "name": "TGuardMap",
118416
- "constraint": {
118417
- "kind": "external",
118418
- "name": "Record",
118419
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118420
- "typeParameters": [
118421
- {
118422
- "kind": "primitive",
118423
- "value": "string"
118424
- },
118425
- {
118426
- "kind": "unknown",
118427
- "value": "unknown",
118428
- "text": "keyof TEvents"
118429
- }
118430
- ]
118431
- },
118432
- "required": true
118433
- },
118434
- {
118435
- "kind": "typeParameter",
118436
- "name": "TCallbackMap",
118437
- "constraint": {
118438
- "kind": "external",
118439
- "name": "Record",
118440
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118441
- "typeParameters": [
118442
- {
118443
- "kind": "primitive",
118444
- "value": "string"
118445
- },
118446
- {
118447
- "kind": "unknown",
118448
- "value": "unknown",
118449
- "text": "keyof TEvents"
118450
- }
118451
- ]
118452
- },
118453
- "required": true
118454
- }
118455
- ]
116579
+ "kind": "symbol",
116580
+ "name": "EventMap",
116581
+ "value": "EventMap<ToEvent<TEvents>, TGuardMap, TCallbackMap>"
118456
116582
  },
118457
116583
  "required": true,
118458
116584
  "description": "",
@@ -119693,25 +117819,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
119693
117819
  "parameters": [],
119694
117820
  "members": [],
119695
117821
  "returnType": {
119696
- "kind": "type",
119697
- "typeParameters": [],
119698
- "value": {
119699
- "kind": "union",
119700
- "value": [
119701
- {
119702
- "kind": "string",
119703
- "value": "mouse"
119704
- },
119705
- {
119706
- "kind": "string",
119707
- "value": "touch"
119708
- },
119709
- {
119710
- "kind": "string",
119711
- "value": "pen"
119712
- }
119713
- ]
119714
- }
117822
+ "kind": "symbol",
117823
+ "name": "Modality",
117824
+ "value": "Modality"
119715
117825
  }
119716
117826
  }
119717
117827
  },
@@ -119932,7 +118042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
119932
118042
  }
119933
118043
  ],
119934
118044
  "tags": {
119935
- "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."
119936
118046
  },
119937
118047
  "type": {
119938
118048
  "kind": "symbol",
@@ -162565,37 +160675,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162565
160675
  "kind": "parameter",
162566
160676
  "name": "__0",
162567
160677
  "type": {
162568
- "kind": "type",
162569
- "typeParameters": [],
162570
- "value": {
162571
- "kind": "symbol",
162572
- "name": "Pick",
162573
- "typeParameters": [
162574
- {
162575
- "kind": "symbol",
162576
- "name": "PaginationState",
162577
- "value": "PaginationState"
162578
- },
162579
- {
162580
- "kind": "union",
162581
- "value": [
162582
- {
162583
- "kind": "string",
162584
- "value": "currentPage"
162585
- },
162586
- {
162587
- "kind": "string",
162588
- "value": "lastPage"
162589
- },
162590
- {
162591
- "kind": "string",
162592
- "value": "rangeSize"
162593
- }
162594
- ]
162595
- }
162596
- ],
162597
- "value": "Pick<T, K>"
162598
- }
160678
+ "kind": "symbol",
160679
+ "name": "BuildPageRangeConfig",
160680
+ "value": "BuildPageRangeConfig"
162599
160681
  },
162600
160682
  "required": true,
162601
160683
  "rest": false,
@@ -162843,124 +160925,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162843
160925
  "kind": "parameter",
162844
160926
  "name": "config",
162845
160927
  "defaultValue": {
162846
- "kind": "object",
162847
- "properties": [
162848
- {
162849
- "kind": "property",
162850
- "name": "aria-atomic",
162851
- "required": false,
162852
- "type": {
162853
- "kind": "union",
162854
- "value": [
162855
- {
162856
- "kind": "parenthesis",
162857
- "value": {
162858
- "kind": "union",
162859
- "value": [
162860
- {
162861
- "kind": "primitive",
162862
- "value": "boolean"
162863
- },
162864
- {
162865
- "kind": "string",
162866
- "value": "false"
162867
- },
162868
- {
162869
- "kind": "string",
162870
- "value": "true"
162871
- }
162872
- ]
162873
- }
162874
- },
162875
- {
162876
- "kind": "primitive",
162877
- "value": "undefined"
162878
- }
162879
- ]
162880
- },
162881
- "description": "",
162882
- "declarations": [
162883
- {
162884
- "name": "aria-atomic",
162885
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162886
- }
162887
- ],
162888
- "tags": {}
162889
- },
162890
- {
162891
- "kind": "property",
162892
- "name": "aria-live",
162893
- "required": false,
162894
- "type": {
162895
- "kind": "union",
162896
- "value": [
162897
- {
162898
- "kind": "string",
162899
- "value": "polite"
162900
- },
162901
- {
162902
- "kind": "string",
162903
- "value": "assertive"
162904
- }
162905
- ]
162906
- },
162907
- "description": "",
162908
- "declarations": [
162909
- {
162910
- "name": "aria-live",
162911
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162912
- }
162913
- ],
162914
- "tags": {}
162915
- },
162916
- {
162917
- "kind": "property",
162918
- "name": "role",
162919
- "required": false,
162920
- "type": {
162921
- "kind": "union",
162922
- "value": [
162923
- {
162924
- "kind": "string",
162925
- "value": "status"
162926
- },
162927
- {
162928
- "kind": "string",
162929
- "value": "alert"
162930
- },
162931
- {
162932
- "kind": "string",
162933
- "value": "log"
162934
- }
162935
- ]
162936
- },
162937
- "description": "",
162938
- "declarations": [
162939
- {
162940
- "name": "role",
162941
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162942
- }
162943
- ],
162944
- "tags": {}
162945
- },
162946
- {
162947
- "kind": "property",
162948
- "name": "shouldAnnounceToScreenReader",
162949
- "required": false,
162950
- "type": {
162951
- "kind": "primitive",
162952
- "value": "boolean"
162953
- },
162954
- "description": "",
162955
- "declarations": [
162956
- {
162957
- "name": "shouldAnnounceToScreenReader",
162958
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162959
- }
162960
- ],
162961
- "tags": {}
162962
- }
162963
- ]
160928
+ "kind": "symbol",
160929
+ "name": "UseLiveRegionConfig",
160930
+ "value": "UseLiveRegionConfig"
162964
160931
  },
162965
160932
  "type": {
162966
160933
  "kind": "object",
@@ -163096,124 +161063,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
163096
161063
  ],
163097
161064
  "members": [],
163098
161065
  "returnType": {
163099
- "kind": "object",
163100
- "properties": [
163101
- {
163102
- "kind": "property",
163103
- "name": "aria-atomic",
163104
- "required": false,
163105
- "type": {
163106
- "kind": "union",
163107
- "value": [
163108
- {
163109
- "kind": "parenthesis",
163110
- "value": {
163111
- "kind": "union",
163112
- "value": [
163113
- {
163114
- "kind": "primitive",
163115
- "value": "boolean"
163116
- },
163117
- {
163118
- "kind": "string",
163119
- "value": "false"
163120
- },
163121
- {
163122
- "kind": "string",
163123
- "value": "true"
163124
- }
163125
- ]
163126
- }
163127
- },
163128
- {
163129
- "kind": "primitive",
163130
- "value": "undefined"
163131
- }
163132
- ]
163133
- },
163134
- "description": "",
163135
- "declarations": [
163136
- {
163137
- "name": "aria-atomic",
163138
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163139
- }
163140
- ],
163141
- "tags": {}
163142
- },
163143
- {
163144
- "kind": "property",
163145
- "name": "aria-live",
163146
- "required": false,
163147
- "type": {
163148
- "kind": "union",
163149
- "value": [
163150
- {
163151
- "kind": "string",
163152
- "value": "polite"
163153
- },
163154
- {
163155
- "kind": "string",
163156
- "value": "assertive"
163157
- }
163158
- ]
163159
- },
163160
- "description": "",
163161
- "declarations": [
163162
- {
163163
- "name": "aria-live",
163164
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163165
- }
163166
- ],
163167
- "tags": {}
163168
- },
163169
- {
163170
- "kind": "property",
163171
- "name": "role",
163172
- "required": false,
163173
- "type": {
163174
- "kind": "union",
163175
- "value": [
163176
- {
163177
- "kind": "string",
163178
- "value": "status"
163179
- },
163180
- {
163181
- "kind": "string",
163182
- "value": "alert"
163183
- },
163184
- {
163185
- "kind": "string",
163186
- "value": "log"
163187
- }
163188
- ]
163189
- },
163190
- "description": "",
163191
- "declarations": [
163192
- {
163193
- "name": "role",
163194
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163195
- }
163196
- ],
163197
- "tags": {}
163198
- },
163199
- {
163200
- "kind": "property",
163201
- "name": "shouldAnnounceToScreenReader",
163202
- "required": false,
163203
- "type": {
163204
- "kind": "primitive",
163205
- "value": "boolean"
163206
- },
163207
- "description": "",
163208
- "declarations": [
163209
- {
163210
- "name": "shouldAnnounceToScreenReader",
163211
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163212
- }
163213
- ],
163214
- "tags": {}
163215
- }
163216
- ]
161066
+ "kind": "symbol",
161067
+ "name": "UseLiveRegionConfig",
161068
+ "value": "UseLiveRegionConfig"
163217
161069
  }
163218
161070
  }
163219
161071
  },
@@ -190969,7 +188821,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
190969
188821
  {
190970
188822
  "name": "StatusIndicatorType",
190971
188823
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
190972
- "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": "",
190973
188825
  "declarations": [
190974
188826
  {
190975
188827
  "name": "StatusIndicatorType",
@@ -190977,7 +188829,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
190977
188829
  }
190978
188830
  ],
190979
188831
  "tags": {
190980
- "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."
190981
188833
  },
190982
188834
  "type": {
190983
188835
  "kind": "object",
@@ -191038,7 +188890,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191038
188890
  {
191039
188891
  "name": "StatusIndicatorEmphasis",
191040
188892
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191041
- "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": "",
191042
188894
  "declarations": [
191043
188895
  {
191044
188896
  "name": "StatusIndicatorEmphasis",
@@ -191046,7 +188898,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191046
188898
  }
191047
188899
  ],
191048
188900
  "tags": {
191049
- "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."
191050
188902
  },
191051
188903
  "type": {
191052
188904
  "kind": "object",
@@ -191075,7 +188927,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191075
188927
  {
191076
188928
  "name": "StatusIndicatorGenericStyle",
191077
188929
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191078
- "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": "",
191079
188931
  "declarations": [
191080
188932
  {
191081
188933
  "name": "StatusIndicatorGenericStyle",
@@ -191083,7 +188935,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191083
188935
  }
191084
188936
  ],
191085
188937
  "tags": {
191086
- "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."
191087
188939
  },
191088
188940
  "type": {
191089
188941
  "kind": "object",
@@ -191171,7 +189023,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191171
189023
  {
191172
189024
  "name": "statusIndicatorStyles",
191173
189025
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191174
- "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": "",
191175
189027
  "declarations": [
191176
189028
  {
191177
189029
  "name": "statusIndicatorStyles",
@@ -191179,7 +189031,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191179
189031
  }
191180
189032
  ],
191181
189033
  "tags": {
191182
- "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."
191183
189035
  },
191184
189036
  "type": {
191185
189037
  "kind": "symbol",
@@ -191190,7 +189042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191190
189042
  {
191191
189043
  "name": "StatusIndicatorProps",
191192
189044
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191193
- "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": "",
191194
189046
  "declarations": [
191195
189047
  {
191196
189048
  "name": "StatusIndicatorProps",
@@ -191198,7 +189050,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191198
189050
  }
191199
189051
  ],
191200
189052
  "tags": {
191201
- "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."
191202
189054
  },
191203
189055
  "type": {
191204
189056
  "kind": "alias",
@@ -191208,7 +189060,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191208
189060
  {
191209
189061
  "name": "StatusIndicator",
191210
189062
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/status-indicator/lib/StatusIndicator.tsx",
191211
- "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": "",
191212
189064
  "declarations": [
191213
189065
  {
191214
189066
  "name": "StatusIndicator",
@@ -191216,7 +189068,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191216
189068
  }
191217
189069
  ],
191218
189070
  "tags": {
191219
- "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."
191220
189072
  },
191221
189073
  "type": {
191222
189074
  "kind": "component",
@@ -192100,7 +189952,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
192100
189952
  }
192101
189953
  ],
192102
189954
  "tags": {
192103
- "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."
192104
189956
  }
192105
189957
  },
192106
189958
  {
@@ -238558,9 +236410,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238558
236410
  "kind": "property",
238559
236411
  "name": "onBlur",
238560
236412
  "defaultValue": {
238561
- "kind": "unknown",
238562
- "value": "unknown",
238563
- "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"
238564
236417
  },
238565
236418
  "type": {
238566
236419
  "kind": "function",
@@ -238681,9 +236534,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238681
236534
  "kind": "property",
238682
236535
  "name": "open",
238683
236536
  "defaultValue": {
238684
- "kind": "unknown",
238685
- "value": "unknown",
238686
- "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"
238687
236541
  },
238688
236542
  "type": {
238689
236543
  "kind": "primitive",
@@ -238852,9 +236706,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238852
236706
  "kind": "property",
238853
236707
  "name": "onMouseLeave",
238854
236708
  "defaultValue": {
238855
- "kind": "unknown",
238856
- "value": "unknown",
238857
- "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"
238858
236713
  },
238859
236714
  "type": {
238860
236715
  "kind": "function",
@@ -238936,9 +236791,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238936
236791
  "kind": "property",
238937
236792
  "name": "onMouseEnter",
238938
236793
  "defaultValue": {
238939
- "kind": "unknown",
238940
- "value": "unknown",
238941
- "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"
238942
236798
  },
238943
236799
  "type": {
238944
236800
  "kind": "function",
@@ -238963,9 +236819,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238963
236819
  "kind": "property",
238964
236820
  "name": "onMouseLeave",
238965
236821
  "defaultValue": {
238966
- "kind": "unknown",
238967
- "value": "unknown",
238968
- "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"
238969
236826
  },
238970
236827
  "type": {
238971
236828
  "kind": "function",