@workday/canvas-kit-docs 8.5.3 → 8.5.4
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.
package/dist/es6/lib/docs.js
CHANGED
|
@@ -30055,64 +30055,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
30055
30055
|
],
|
|
30056
30056
|
"tags": {}
|
|
30057
30057
|
},
|
|
30058
|
-
{
|
|
30059
|
-
"kind": "property",
|
|
30060
|
-
"name": "hasError",
|
|
30061
|
-
"type": {
|
|
30062
|
-
"kind": "boolean",
|
|
30063
|
-
"value": false
|
|
30064
|
-
},
|
|
30065
|
-
"required": true,
|
|
30066
|
-
"description": "Optional flag to denote if this field has an error to display. When true the `FormField.Input` will have\n`required` set to true, and usually some subcomponents will have a error color applied.",
|
|
30067
|
-
"declarations": [
|
|
30068
|
-
{
|
|
30069
|
-
"name": "hasError",
|
|
30070
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30071
|
-
}
|
|
30072
|
-
],
|
|
30073
|
-
"tags": {}
|
|
30074
|
-
},
|
|
30075
|
-
{
|
|
30076
|
-
"kind": "property",
|
|
30077
|
-
"name": "id",
|
|
30078
|
-
"defaultValue": {
|
|
30079
|
-
"kind": "symbol",
|
|
30080
|
-
"name": "useUniqueId",
|
|
30081
|
-
"value": "useUniqueId"
|
|
30082
|
-
},
|
|
30083
|
-
"type": {
|
|
30084
|
-
"kind": "primitive",
|
|
30085
|
-
"value": "string"
|
|
30086
|
-
},
|
|
30087
|
-
"required": true,
|
|
30088
|
-
"description": "Optional `id` provided to `FormField`'s subcomponents as HTML attributes:\n- `FormField.Input` will set `aria-describedby` to `hint-${id}`\n- `FormField.Input` will set `id` to `input-${id}`\n- `FormField.Label` will set `htmlFor` to `input-${id}`\n- `FormField.Hint` will set `id` to `hint-${id}`\n\nIf a value is not provided, a unique id will be automatically created by `useUniqueId()`.",
|
|
30089
|
-
"declarations": [
|
|
30090
|
-
{
|
|
30091
|
-
"name": "id",
|
|
30092
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30093
|
-
}
|
|
30094
|
-
],
|
|
30095
|
-
"tags": {
|
|
30096
|
-
"default": "{useUniqueId}"
|
|
30097
|
-
}
|
|
30098
|
-
},
|
|
30099
|
-
{
|
|
30100
|
-
"kind": "property",
|
|
30101
|
-
"name": "isRequired",
|
|
30102
|
-
"type": {
|
|
30103
|
-
"kind": "boolean",
|
|
30104
|
-
"value": false
|
|
30105
|
-
},
|
|
30106
|
-
"required": true,
|
|
30107
|
-
"description": "Optional flag to denote if this field is required. When true the `FormField.Input` will have\n`required` set to true, and an asterisk will be appended to the `FormField.Label`.",
|
|
30108
|
-
"declarations": [
|
|
30109
|
-
{
|
|
30110
|
-
"name": "isRequired",
|
|
30111
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30112
|
-
}
|
|
30113
|
-
],
|
|
30114
|
-
"tags": {}
|
|
30115
|
-
},
|
|
30116
30058
|
{
|
|
30117
30059
|
"kind": "property",
|
|
30118
30060
|
"name": "as",
|
|
@@ -30552,64 +30494,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
30552
30494
|
],
|
|
30553
30495
|
"tags": {}
|
|
30554
30496
|
},
|
|
30555
|
-
{
|
|
30556
|
-
"kind": "property",
|
|
30557
|
-
"name": "hasError",
|
|
30558
|
-
"type": {
|
|
30559
|
-
"kind": "boolean",
|
|
30560
|
-
"value": false
|
|
30561
|
-
},
|
|
30562
|
-
"required": true,
|
|
30563
|
-
"description": "Optional flag to denote if this field has an error to display. When true the `FormField.Input` will have\n`required` set to true, and usually some subcomponents will have a error color applied.",
|
|
30564
|
-
"declarations": [
|
|
30565
|
-
{
|
|
30566
|
-
"name": "hasError",
|
|
30567
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30568
|
-
}
|
|
30569
|
-
],
|
|
30570
|
-
"tags": {}
|
|
30571
|
-
},
|
|
30572
|
-
{
|
|
30573
|
-
"kind": "property",
|
|
30574
|
-
"name": "id",
|
|
30575
|
-
"defaultValue": {
|
|
30576
|
-
"kind": "symbol",
|
|
30577
|
-
"name": "useUniqueId",
|
|
30578
|
-
"value": "useUniqueId"
|
|
30579
|
-
},
|
|
30580
|
-
"type": {
|
|
30581
|
-
"kind": "primitive",
|
|
30582
|
-
"value": "string"
|
|
30583
|
-
},
|
|
30584
|
-
"required": true,
|
|
30585
|
-
"description": "Optional `id` provided to `FormField`'s subcomponents as HTML attributes:\n- `FormField.Input` will set `aria-describedby` to `hint-${id}`\n- `FormField.Input` will set `id` to `input-${id}`\n- `FormField.Label` will set `htmlFor` to `input-${id}`\n- `FormField.Hint` will set `id` to `hint-${id}`\n\nIf a value is not provided, a unique id will be automatically created by `useUniqueId()`.",
|
|
30586
|
-
"declarations": [
|
|
30587
|
-
{
|
|
30588
|
-
"name": "id",
|
|
30589
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30590
|
-
}
|
|
30591
|
-
],
|
|
30592
|
-
"tags": {
|
|
30593
|
-
"default": "{useUniqueId}"
|
|
30594
|
-
}
|
|
30595
|
-
},
|
|
30596
|
-
{
|
|
30597
|
-
"kind": "property",
|
|
30598
|
-
"name": "isRequired",
|
|
30599
|
-
"type": {
|
|
30600
|
-
"kind": "boolean",
|
|
30601
|
-
"value": false
|
|
30602
|
-
},
|
|
30603
|
-
"required": true,
|
|
30604
|
-
"description": "Optional flag to denote if this field is required. When true the `FormField.Input` will have\n`required` set to true, and an asterisk will be appended to the `FormField.Label`.",
|
|
30605
|
-
"declarations": [
|
|
30606
|
-
{
|
|
30607
|
-
"name": "isRequired",
|
|
30608
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/form-field/lib/hooks/useFormFieldModel.tsx"
|
|
30609
|
-
}
|
|
30610
|
-
],
|
|
30611
|
-
"tags": {}
|
|
30612
|
-
},
|
|
30613
30497
|
{
|
|
30614
30498
|
"kind": "property",
|
|
30615
30499
|
"name": "as",
|
|
@@ -42430,1924 +42314,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
42430
42314
|
],
|
|
42431
42315
|
"tags": {}
|
|
42432
42316
|
},
|
|
42433
|
-
{
|
|
42434
|
-
"kind": "property",
|
|
42435
|
-
"name": "mode",
|
|
42436
|
-
"type": {
|
|
42437
|
-
"kind": "union",
|
|
42438
|
-
"value": [
|
|
42439
|
-
{
|
|
42440
|
-
"kind": "string",
|
|
42441
|
-
"value": "multiple"
|
|
42442
|
-
},
|
|
42443
|
-
{
|
|
42444
|
-
"kind": "string",
|
|
42445
|
-
"value": "single"
|
|
42446
|
-
}
|
|
42447
|
-
]
|
|
42448
|
-
},
|
|
42449
|
-
"required": true,
|
|
42450
|
-
"description": "Determines the default selection manager used as well as if the menu closes when an item is selected",
|
|
42451
|
-
"declarations": [
|
|
42452
|
-
{
|
|
42453
|
-
"name": "mode",
|
|
42454
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/useMenuModel.tsx"
|
|
42455
|
-
}
|
|
42456
|
-
],
|
|
42457
|
-
"tags": {}
|
|
42458
|
-
},
|
|
42459
|
-
{
|
|
42460
|
-
"kind": "property",
|
|
42461
|
-
"name": "returnFocusRef",
|
|
42462
|
-
"type": {
|
|
42463
|
-
"kind": "union",
|
|
42464
|
-
"value": [
|
|
42465
|
-
{
|
|
42466
|
-
"kind": "symbol",
|
|
42467
|
-
"name": "RefObject",
|
|
42468
|
-
"typeParameters": [
|
|
42469
|
-
{
|
|
42470
|
-
"kind": "primitive",
|
|
42471
|
-
"value": "any"
|
|
42472
|
-
}
|
|
42473
|
-
],
|
|
42474
|
-
"value": "any"
|
|
42475
|
-
},
|
|
42476
|
-
{
|
|
42477
|
-
"kind": "primitive",
|
|
42478
|
-
"value": "undefined"
|
|
42479
|
-
}
|
|
42480
|
-
]
|
|
42481
|
-
},
|
|
42482
|
-
"required": false,
|
|
42483
|
-
"description": "Optional reference to an element that should receive focus when a popup is hidden. If left\nblank, focus will return to the `targetRef`",
|
|
42484
|
-
"declarations": [
|
|
42485
|
-
{
|
|
42486
|
-
"name": "returnFocusRef",
|
|
42487
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
42488
|
-
}
|
|
42489
|
-
],
|
|
42490
|
-
"tags": {}
|
|
42491
|
-
},
|
|
42492
|
-
{
|
|
42493
|
-
"kind": "property",
|
|
42494
|
-
"name": "initialFocusRef",
|
|
42495
|
-
"type": {
|
|
42496
|
-
"kind": "union",
|
|
42497
|
-
"value": [
|
|
42498
|
-
{
|
|
42499
|
-
"kind": "symbol",
|
|
42500
|
-
"name": "RefObject",
|
|
42501
|
-
"typeParameters": [
|
|
42502
|
-
{
|
|
42503
|
-
"kind": "primitive",
|
|
42504
|
-
"value": "any"
|
|
42505
|
-
}
|
|
42506
|
-
],
|
|
42507
|
-
"value": "any"
|
|
42508
|
-
},
|
|
42509
|
-
{
|
|
42510
|
-
"kind": "primitive",
|
|
42511
|
-
"value": "undefined"
|
|
42512
|
-
}
|
|
42513
|
-
]
|
|
42514
|
-
},
|
|
42515
|
-
"required": false,
|
|
42516
|
-
"description": "Optional reference to an element that should receive focus when a popup is shown. If left blank,\nfocus will be moved to the first focusable element inside the popup.",
|
|
42517
|
-
"declarations": [
|
|
42518
|
-
{
|
|
42519
|
-
"name": "initialFocusRef",
|
|
42520
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
42521
|
-
}
|
|
42522
|
-
],
|
|
42523
|
-
"tags": {}
|
|
42524
|
-
},
|
|
42525
|
-
{
|
|
42526
|
-
"kind": "property",
|
|
42527
|
-
"name": "id",
|
|
42528
|
-
"type": {
|
|
42529
|
-
"kind": "primitive",
|
|
42530
|
-
"value": "string"
|
|
42531
|
-
},
|
|
42532
|
-
"required": true,
|
|
42533
|
-
"description": "ID reference of the list. Children ids can be derived from this id",
|
|
42534
|
-
"declarations": [
|
|
42535
|
-
{
|
|
42536
|
-
"name": "id",
|
|
42537
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
42538
|
-
}
|
|
42539
|
-
],
|
|
42540
|
-
"tags": {}
|
|
42541
|
-
},
|
|
42542
|
-
{
|
|
42543
|
-
"kind": "property",
|
|
42544
|
-
"name": "initialVisibility",
|
|
42545
|
-
"defaultValue": {
|
|
42546
|
-
"kind": "string",
|
|
42547
|
-
"value": "hidden"
|
|
42548
|
-
},
|
|
42549
|
-
"type": {
|
|
42550
|
-
"kind": "symbol",
|
|
42551
|
-
"name": "Visibility",
|
|
42552
|
-
"value": "Visibility"
|
|
42553
|
-
},
|
|
42554
|
-
"required": true,
|
|
42555
|
-
"description": "The initial visibility of the disclosed content",
|
|
42556
|
-
"declarations": [
|
|
42557
|
-
{
|
|
42558
|
-
"name": "initialVisibility",
|
|
42559
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
42560
|
-
}
|
|
42561
|
-
],
|
|
42562
|
-
"tags": {
|
|
42563
|
-
"default": "'hidden'"
|
|
42564
|
-
}
|
|
42565
|
-
},
|
|
42566
|
-
{
|
|
42567
|
-
"kind": "property",
|
|
42568
|
-
"name": "initialSelectedIds",
|
|
42569
|
-
"type": {
|
|
42570
|
-
"kind": "symbol",
|
|
42571
|
-
"name": "SelectedIds",
|
|
42572
|
-
"value": "SelectedIds"
|
|
42573
|
-
},
|
|
42574
|
-
"required": true,
|
|
42575
|
-
"description": "",
|
|
42576
|
-
"declarations": [
|
|
42577
|
-
{
|
|
42578
|
-
"name": "initialSelectedIds",
|
|
42579
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
42580
|
-
}
|
|
42581
|
-
],
|
|
42582
|
-
"tags": {}
|
|
42583
|
-
},
|
|
42584
|
-
{
|
|
42585
|
-
"kind": "property",
|
|
42586
|
-
"name": "initialUnselectedIds",
|
|
42587
|
-
"type": {
|
|
42588
|
-
"kind": "array",
|
|
42589
|
-
"value": {
|
|
42590
|
-
"kind": "primitive",
|
|
42591
|
-
"value": "string"
|
|
42592
|
-
}
|
|
42593
|
-
},
|
|
42594
|
-
"required": true,
|
|
42595
|
-
"description": "",
|
|
42596
|
-
"declarations": [
|
|
42597
|
-
{
|
|
42598
|
-
"name": "initialUnselectedIds",
|
|
42599
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
42600
|
-
}
|
|
42601
|
-
],
|
|
42602
|
-
"tags": {}
|
|
42603
|
-
},
|
|
42604
|
-
{
|
|
42605
|
-
"kind": "property",
|
|
42606
|
-
"name": "selection",
|
|
42607
|
-
"type": {
|
|
42608
|
-
"kind": "symbol",
|
|
42609
|
-
"name": "SelectionManager",
|
|
42610
|
-
"value": "SelectionManager"
|
|
42611
|
-
},
|
|
42612
|
-
"required": true,
|
|
42613
|
-
"description": "",
|
|
42614
|
-
"declarations": [
|
|
42615
|
-
{
|
|
42616
|
-
"name": "selection",
|
|
42617
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
42618
|
-
}
|
|
42619
|
-
],
|
|
42620
|
-
"tags": {}
|
|
42621
|
-
},
|
|
42622
|
-
{
|
|
42623
|
-
"kind": "property",
|
|
42624
|
-
"name": "initialCursorId",
|
|
42625
|
-
"type": {
|
|
42626
|
-
"kind": "primitive",
|
|
42627
|
-
"value": "string"
|
|
42628
|
-
},
|
|
42629
|
-
"required": true,
|
|
42630
|
-
"description": "Initial cursor position. If not provided, the cursor will point to the first item in the list",
|
|
42631
|
-
"declarations": [
|
|
42632
|
-
{
|
|
42633
|
-
"name": "initialCursorId",
|
|
42634
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
42635
|
-
}
|
|
42636
|
-
],
|
|
42637
|
-
"tags": {}
|
|
42638
|
-
},
|
|
42639
|
-
{
|
|
42640
|
-
"kind": "property",
|
|
42641
|
-
"name": "columnCount",
|
|
42642
|
-
"defaultValue": {
|
|
42643
|
-
"kind": "number",
|
|
42644
|
-
"value": 0
|
|
42645
|
-
},
|
|
42646
|
-
"type": {
|
|
42647
|
-
"kind": "primitive",
|
|
42648
|
-
"value": "number"
|
|
42649
|
-
},
|
|
42650
|
-
"required": true,
|
|
42651
|
-
"description": "If this is set it will cause a wrapping of a list that will turn it into a grid",
|
|
42652
|
-
"declarations": [
|
|
42653
|
-
{
|
|
42654
|
-
"name": "columnCount",
|
|
42655
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
42656
|
-
}
|
|
42657
|
-
],
|
|
42658
|
-
"tags": {
|
|
42659
|
-
"default": "0"
|
|
42660
|
-
}
|
|
42661
|
-
},
|
|
42662
|
-
{
|
|
42663
|
-
"kind": "property",
|
|
42664
|
-
"name": "navigation",
|
|
42665
|
-
"type": {
|
|
42666
|
-
"kind": "symbol",
|
|
42667
|
-
"name": "NavigationManager",
|
|
42668
|
-
"value": "NavigationManager"
|
|
42669
|
-
},
|
|
42670
|
-
"required": true,
|
|
42671
|
-
"description": "Controls the state changes when the user sends navigation events to the model. For example,\nwhen the user hits the \"right\" arrow, a behavior hook will determine directionality\n(left-to-right or right-to-left) and call the correct navigation method. In our example, a\nleft-to-right language would send a `getNext`. The navigation manager may return the next item\nin the list. Different managers can be created for slightly different use cases. The default\nnavigation manager will accept `orientation` and directionality to determine mapping.\n\nAn example override might be a tab list with an overflow menu that is meant to be transparent\nto screen reader users. This would require the overflow menu to accept both up/down keys as\nwell as left/right keys to give a more consistent experience to all users.",
|
|
42672
|
-
"declarations": [
|
|
42673
|
-
{
|
|
42674
|
-
"name": "navigation",
|
|
42675
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
42676
|
-
}
|
|
42677
|
-
],
|
|
42678
|
-
"tags": {}
|
|
42679
|
-
},
|
|
42680
|
-
{
|
|
42681
|
-
"kind": "property",
|
|
42682
|
-
"name": "getId",
|
|
42683
|
-
"type": {
|
|
42684
|
-
"kind": "function",
|
|
42685
|
-
"parameters": [
|
|
42686
|
-
{
|
|
42687
|
-
"kind": "parameter",
|
|
42688
|
-
"name": "item",
|
|
42689
|
-
"type": {
|
|
42690
|
-
"kind": "symbol",
|
|
42691
|
-
"name": "Generic",
|
|
42692
|
-
"value": "any"
|
|
42693
|
-
},
|
|
42694
|
-
"required": true,
|
|
42695
|
-
"rest": false,
|
|
42696
|
-
"description": "",
|
|
42697
|
-
"declarations": [
|
|
42698
|
-
{
|
|
42699
|
-
"name": "item",
|
|
42700
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42701
|
-
}
|
|
42702
|
-
],
|
|
42703
|
-
"tags": {}
|
|
42704
|
-
}
|
|
42705
|
-
],
|
|
42706
|
-
"members": [],
|
|
42707
|
-
"returnType": {
|
|
42708
|
-
"kind": "primitive",
|
|
42709
|
-
"value": "string"
|
|
42710
|
-
}
|
|
42711
|
-
},
|
|
42712
|
-
"required": true,
|
|
42713
|
-
"description": "Optional function to return an id of an item. If not provided, the default function will return\nthe `id` property from the object of each item. If you did not provide `items`, do not override\nthis function. If you don't provided `items` and instead provide static items via JSX, the list\nwill create an internal array of items where `id` is the only property and the default `getId`\nwill return the desired result.",
|
|
42714
|
-
"declarations": [
|
|
42715
|
-
{
|
|
42716
|
-
"name": "getId",
|
|
42717
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42718
|
-
}
|
|
42719
|
-
],
|
|
42720
|
-
"tags": {}
|
|
42721
|
-
},
|
|
42722
|
-
{
|
|
42723
|
-
"kind": "property",
|
|
42724
|
-
"name": "getTextValue",
|
|
42725
|
-
"type": {
|
|
42726
|
-
"kind": "function",
|
|
42727
|
-
"parameters": [
|
|
42728
|
-
{
|
|
42729
|
-
"kind": "parameter",
|
|
42730
|
-
"name": "item",
|
|
42731
|
-
"type": {
|
|
42732
|
-
"kind": "symbol",
|
|
42733
|
-
"name": "Generic",
|
|
42734
|
-
"value": "any"
|
|
42735
|
-
},
|
|
42736
|
-
"required": true,
|
|
42737
|
-
"rest": false,
|
|
42738
|
-
"description": "",
|
|
42739
|
-
"declarations": [
|
|
42740
|
-
{
|
|
42741
|
-
"name": "item",
|
|
42742
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42743
|
-
}
|
|
42744
|
-
],
|
|
42745
|
-
"tags": {}
|
|
42746
|
-
}
|
|
42747
|
-
],
|
|
42748
|
-
"members": [],
|
|
42749
|
-
"returnType": {
|
|
42750
|
-
"kind": "primitive",
|
|
42751
|
-
"value": "string"
|
|
42752
|
-
}
|
|
42753
|
-
},
|
|
42754
|
-
"required": true,
|
|
42755
|
-
"description": "",
|
|
42756
|
-
"declarations": [
|
|
42757
|
-
{
|
|
42758
|
-
"name": "getTextValue",
|
|
42759
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42760
|
-
}
|
|
42761
|
-
],
|
|
42762
|
-
"tags": {}
|
|
42763
|
-
},
|
|
42764
|
-
{
|
|
42765
|
-
"kind": "property",
|
|
42766
|
-
"name": "nonInteractiveIds",
|
|
42767
|
-
"type": {
|
|
42768
|
-
"kind": "array",
|
|
42769
|
-
"value": {
|
|
42770
|
-
"kind": "primitive",
|
|
42771
|
-
"value": "string"
|
|
42772
|
-
}
|
|
42773
|
-
},
|
|
42774
|
-
"required": true,
|
|
42775
|
-
"description": "Array of all ids which are currently disabled. This is used for navigation to skip over items\nwhich are not focusable.",
|
|
42776
|
-
"declarations": [
|
|
42777
|
-
{
|
|
42778
|
-
"name": "nonInteractiveIds",
|
|
42779
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42780
|
-
}
|
|
42781
|
-
],
|
|
42782
|
-
"tags": {}
|
|
42783
|
-
},
|
|
42784
|
-
{
|
|
42785
|
-
"kind": "property",
|
|
42786
|
-
"name": "orientation",
|
|
42787
|
-
"defaultValue": {
|
|
42788
|
-
"kind": "string",
|
|
42789
|
-
"value": "vertical"
|
|
42790
|
-
},
|
|
42791
|
-
"type": {
|
|
42792
|
-
"kind": "symbol",
|
|
42793
|
-
"name": "Orientation",
|
|
42794
|
-
"value": "Orientation"
|
|
42795
|
-
},
|
|
42796
|
-
"required": true,
|
|
42797
|
-
"description": "The orientation of a list of items. Values are either `vertical` or `horizontal`. This value will\neffect which ids activate progression through a list. For example, `horizontal` will activate with\nleft and right arrows while `vertical` will activate with up and down arrows.",
|
|
42798
|
-
"declarations": [
|
|
42799
|
-
{
|
|
42800
|
-
"name": "orientation",
|
|
42801
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42802
|
-
}
|
|
42803
|
-
],
|
|
42804
|
-
"tags": {
|
|
42805
|
-
"default": "'vertical'"
|
|
42806
|
-
}
|
|
42807
|
-
},
|
|
42808
|
-
{
|
|
42809
|
-
"kind": "property",
|
|
42810
|
-
"name": "defaultItemHeight",
|
|
42811
|
-
"defaultValue": {
|
|
42812
|
-
"kind": "number",
|
|
42813
|
-
"value": 50
|
|
42814
|
-
},
|
|
42815
|
-
"type": {
|
|
42816
|
-
"kind": "primitive",
|
|
42817
|
-
"value": "number"
|
|
42818
|
-
},
|
|
42819
|
-
"required": true,
|
|
42820
|
-
"description": "Best guess to the default item height for virtualization. Getting this number correct\navoids a rerender while the list is initializing.",
|
|
42821
|
-
"declarations": [
|
|
42822
|
-
{
|
|
42823
|
-
"name": "defaultItemHeight",
|
|
42824
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42825
|
-
}
|
|
42826
|
-
],
|
|
42827
|
-
"tags": {
|
|
42828
|
-
"default": "50"
|
|
42829
|
-
}
|
|
42830
|
-
},
|
|
42831
|
-
{
|
|
42832
|
-
"kind": "property",
|
|
42833
|
-
"name": "shouldVirtualize",
|
|
42834
|
-
"type": {
|
|
42835
|
-
"kind": "boolean",
|
|
42836
|
-
"value": true
|
|
42837
|
-
},
|
|
42838
|
-
"required": true,
|
|
42839
|
-
"description": "",
|
|
42840
|
-
"declarations": [
|
|
42841
|
-
{
|
|
42842
|
-
"name": "shouldVirtualize",
|
|
42843
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42844
|
-
}
|
|
42845
|
-
],
|
|
42846
|
-
"tags": {}
|
|
42847
|
-
},
|
|
42848
|
-
{
|
|
42849
|
-
"kind": "property",
|
|
42850
|
-
"name": "items",
|
|
42851
|
-
"required": true,
|
|
42852
|
-
"type": {
|
|
42853
|
-
"kind": "array",
|
|
42854
|
-
"value": {
|
|
42855
|
-
"kind": "symbol",
|
|
42856
|
-
"name": "Generic",
|
|
42857
|
-
"value": "any"
|
|
42858
|
-
}
|
|
42859
|
-
},
|
|
42860
|
-
"description": "Optional array of items. If provided, use a render prop for list children instead of static\nchildren. If the shape of each item object does not have an `id` property or uses a different\nproperty to uniquely identify each item, a `getId` must also be supplied.",
|
|
42861
|
-
"declarations": [
|
|
42862
|
-
{
|
|
42863
|
-
"name": "items",
|
|
42864
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
42865
|
-
}
|
|
42866
|
-
],
|
|
42867
|
-
"tags": {}
|
|
42868
|
-
},
|
|
42869
|
-
{
|
|
42870
|
-
"kind": "property",
|
|
42871
|
-
"name": "updatePlacement",
|
|
42872
|
-
"type": {
|
|
42873
|
-
"kind": "function",
|
|
42874
|
-
"parameters": [
|
|
42875
|
-
{
|
|
42876
|
-
"kind": "parameter",
|
|
42877
|
-
"name": "data",
|
|
42878
|
-
"type": {
|
|
42879
|
-
"kind": "object",
|
|
42880
|
-
"properties": [
|
|
42881
|
-
{
|
|
42882
|
-
"kind": "property",
|
|
42883
|
-
"name": "placement",
|
|
42884
|
-
"required": true,
|
|
42885
|
-
"type": {
|
|
42886
|
-
"kind": "symbol",
|
|
42887
|
-
"name": "Placement",
|
|
42888
|
-
"value": "Placement"
|
|
42889
|
-
},
|
|
42890
|
-
"description": "",
|
|
42891
|
-
"declarations": [
|
|
42892
|
-
{
|
|
42893
|
-
"name": "placement",
|
|
42894
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
42895
|
-
}
|
|
42896
|
-
],
|
|
42897
|
-
"tags": {}
|
|
42898
|
-
}
|
|
42899
|
-
]
|
|
42900
|
-
},
|
|
42901
|
-
"required": true,
|
|
42902
|
-
"rest": false,
|
|
42903
|
-
"description": "",
|
|
42904
|
-
"declarations": [
|
|
42905
|
-
{
|
|
42906
|
-
"name": "data",
|
|
42907
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
42908
|
-
}
|
|
42909
|
-
],
|
|
42910
|
-
"tags": {}
|
|
42911
|
-
}
|
|
42912
|
-
],
|
|
42913
|
-
"members": [],
|
|
42914
|
-
"returnType": {
|
|
42915
|
-
"kind": "primitive",
|
|
42916
|
-
"value": "void"
|
|
42917
|
-
}
|
|
42918
|
-
},
|
|
42919
|
-
"required": true,
|
|
42920
|
-
"description": "Called whenever a popup placement changes around a target. This is useful for animations that\ndepend on the placement chosen.",
|
|
42921
|
-
"declarations": [
|
|
42922
|
-
{
|
|
42923
|
-
"name": "updatePlacement",
|
|
42924
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
42925
|
-
}
|
|
42926
|
-
],
|
|
42927
|
-
"tags": {}
|
|
42928
|
-
},
|
|
42929
|
-
{
|
|
42930
|
-
"kind": "property",
|
|
42931
|
-
"name": "show",
|
|
42932
|
-
"type": {
|
|
42933
|
-
"kind": "function",
|
|
42934
|
-
"parameters": [
|
|
42935
|
-
{
|
|
42936
|
-
"kind": "parameter",
|
|
42937
|
-
"name": "event",
|
|
42938
|
-
"type": {
|
|
42939
|
-
"kind": "union",
|
|
42940
|
-
"value": [
|
|
42941
|
-
{
|
|
42942
|
-
"kind": "external",
|
|
42943
|
-
"name": "Event",
|
|
42944
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
42945
|
-
},
|
|
42946
|
-
{
|
|
42947
|
-
"kind": "external",
|
|
42948
|
-
"name": "SyntheticEvent",
|
|
42949
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
42950
|
-
}
|
|
42951
|
-
]
|
|
42952
|
-
},
|
|
42953
|
-
"required": false,
|
|
42954
|
-
"rest": false,
|
|
42955
|
-
"description": "",
|
|
42956
|
-
"declarations": [
|
|
42957
|
-
{
|
|
42958
|
-
"name": "event",
|
|
42959
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
42960
|
-
}
|
|
42961
|
-
],
|
|
42962
|
-
"tags": {}
|
|
42963
|
-
}
|
|
42964
|
-
],
|
|
42965
|
-
"members": [],
|
|
42966
|
-
"returnType": {
|
|
42967
|
-
"kind": "primitive",
|
|
42968
|
-
"value": "void"
|
|
42969
|
-
}
|
|
42970
|
-
},
|
|
42971
|
-
"required": true,
|
|
42972
|
-
"description": "Start showing the disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
42973
|
-
"declarations": [
|
|
42974
|
-
{
|
|
42975
|
-
"name": "show",
|
|
42976
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
42977
|
-
}
|
|
42978
|
-
],
|
|
42979
|
-
"tags": {}
|
|
42980
|
-
},
|
|
42981
|
-
{
|
|
42982
|
-
"kind": "property",
|
|
42983
|
-
"name": "hide",
|
|
42984
|
-
"type": {
|
|
42985
|
-
"kind": "function",
|
|
42986
|
-
"parameters": [
|
|
42987
|
-
{
|
|
42988
|
-
"kind": "parameter",
|
|
42989
|
-
"name": "event",
|
|
42990
|
-
"type": {
|
|
42991
|
-
"kind": "union",
|
|
42992
|
-
"value": [
|
|
42993
|
-
{
|
|
42994
|
-
"kind": "external",
|
|
42995
|
-
"name": "Event",
|
|
42996
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
42997
|
-
},
|
|
42998
|
-
{
|
|
42999
|
-
"kind": "external",
|
|
43000
|
-
"name": "SyntheticEvent",
|
|
43001
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
43002
|
-
}
|
|
43003
|
-
]
|
|
43004
|
-
},
|
|
43005
|
-
"required": false,
|
|
43006
|
-
"rest": false,
|
|
43007
|
-
"description": "",
|
|
43008
|
-
"declarations": [
|
|
43009
|
-
{
|
|
43010
|
-
"name": "event",
|
|
43011
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43012
|
-
}
|
|
43013
|
-
],
|
|
43014
|
-
"tags": {}
|
|
43015
|
-
}
|
|
43016
|
-
],
|
|
43017
|
-
"members": [],
|
|
43018
|
-
"returnType": {
|
|
43019
|
-
"kind": "primitive",
|
|
43020
|
-
"value": "void"
|
|
43021
|
-
}
|
|
43022
|
-
},
|
|
43023
|
-
"required": true,
|
|
43024
|
-
"description": "Start hiding this disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
43025
|
-
"declarations": [
|
|
43026
|
-
{
|
|
43027
|
-
"name": "hide",
|
|
43028
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43029
|
-
}
|
|
43030
|
-
],
|
|
43031
|
-
"tags": {}
|
|
43032
|
-
},
|
|
43033
|
-
{
|
|
43034
|
-
"kind": "property",
|
|
43035
|
-
"name": "select",
|
|
43036
|
-
"type": {
|
|
43037
|
-
"kind": "function",
|
|
43038
|
-
"parameters": [
|
|
43039
|
-
{
|
|
43040
|
-
"kind": "parameter",
|
|
43041
|
-
"name": "data",
|
|
43042
|
-
"type": {
|
|
43043
|
-
"kind": "object",
|
|
43044
|
-
"properties": [
|
|
43045
|
-
{
|
|
43046
|
-
"kind": "property",
|
|
43047
|
-
"name": "id",
|
|
43048
|
-
"required": true,
|
|
43049
|
-
"type": {
|
|
43050
|
-
"kind": "primitive",
|
|
43051
|
-
"value": "string"
|
|
43052
|
-
},
|
|
43053
|
-
"description": "",
|
|
43054
|
-
"declarations": [
|
|
43055
|
-
{
|
|
43056
|
-
"name": "id",
|
|
43057
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43058
|
-
}
|
|
43059
|
-
],
|
|
43060
|
-
"tags": {}
|
|
43061
|
-
}
|
|
43062
|
-
]
|
|
43063
|
-
},
|
|
43064
|
-
"required": true,
|
|
43065
|
-
"rest": false,
|
|
43066
|
-
"description": "",
|
|
43067
|
-
"declarations": [
|
|
43068
|
-
{
|
|
43069
|
-
"name": "data",
|
|
43070
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43071
|
-
}
|
|
43072
|
-
],
|
|
43073
|
-
"tags": {}
|
|
43074
|
-
}
|
|
43075
|
-
],
|
|
43076
|
-
"members": [],
|
|
43077
|
-
"returnType": {
|
|
43078
|
-
"kind": "primitive",
|
|
43079
|
-
"value": "void"
|
|
43080
|
-
}
|
|
43081
|
-
},
|
|
43082
|
-
"required": true,
|
|
43083
|
-
"description": "Select a specific item by its identifier.",
|
|
43084
|
-
"declarations": [
|
|
43085
|
-
{
|
|
43086
|
-
"name": "select",
|
|
43087
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43088
|
-
}
|
|
43089
|
-
],
|
|
43090
|
-
"tags": {}
|
|
43091
|
-
},
|
|
43092
|
-
{
|
|
43093
|
-
"kind": "property",
|
|
43094
|
-
"name": "selectAll",
|
|
43095
|
-
"type": {
|
|
43096
|
-
"kind": "function",
|
|
43097
|
-
"parameters": [],
|
|
43098
|
-
"members": [],
|
|
43099
|
-
"returnType": {
|
|
43100
|
-
"kind": "primitive",
|
|
43101
|
-
"value": "void"
|
|
43102
|
-
}
|
|
43103
|
-
},
|
|
43104
|
-
"required": true,
|
|
43105
|
-
"description": "Select all items. This will set `selectedIds` to `'all'` and remove all `unselectedIds`.\nThis is especially useful for virtual lists where not all items are loaded in memory.",
|
|
43106
|
-
"declarations": [
|
|
43107
|
-
{
|
|
43108
|
-
"name": "selectAll",
|
|
43109
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43110
|
-
}
|
|
43111
|
-
],
|
|
43112
|
-
"tags": {}
|
|
43113
|
-
},
|
|
43114
|
-
{
|
|
43115
|
-
"kind": "property",
|
|
43116
|
-
"name": "unselectAll",
|
|
43117
|
-
"type": {
|
|
43118
|
-
"kind": "function",
|
|
43119
|
-
"parameters": [],
|
|
43120
|
-
"members": [],
|
|
43121
|
-
"returnType": {
|
|
43122
|
-
"kind": "primitive",
|
|
43123
|
-
"value": "void"
|
|
43124
|
-
}
|
|
43125
|
-
},
|
|
43126
|
-
"required": true,
|
|
43127
|
-
"description": "Unselect all items.",
|
|
43128
|
-
"declarations": [
|
|
43129
|
-
{
|
|
43130
|
-
"name": "unselectAll",
|
|
43131
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43132
|
-
}
|
|
43133
|
-
],
|
|
43134
|
-
"tags": {}
|
|
43135
|
-
},
|
|
43136
|
-
{
|
|
43137
|
-
"kind": "property",
|
|
43138
|
-
"name": "registerItem",
|
|
43139
|
-
"type": {
|
|
43140
|
-
"kind": "function",
|
|
43141
|
-
"parameters": [
|
|
43142
|
-
{
|
|
43143
|
-
"kind": "parameter",
|
|
43144
|
-
"name": "data",
|
|
43145
|
-
"type": {
|
|
43146
|
-
"kind": "object",
|
|
43147
|
-
"properties": [
|
|
43148
|
-
{
|
|
43149
|
-
"kind": "property",
|
|
43150
|
-
"name": "item",
|
|
43151
|
-
"required": true,
|
|
43152
|
-
"type": {
|
|
43153
|
-
"kind": "symbol",
|
|
43154
|
-
"name": "Generic",
|
|
43155
|
-
"value": "any"
|
|
43156
|
-
},
|
|
43157
|
-
"description": "",
|
|
43158
|
-
"declarations": [
|
|
43159
|
-
{
|
|
43160
|
-
"name": "item",
|
|
43161
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43162
|
-
}
|
|
43163
|
-
],
|
|
43164
|
-
"tags": {}
|
|
43165
|
-
},
|
|
43166
|
-
{
|
|
43167
|
-
"kind": "property",
|
|
43168
|
-
"name": "textValue",
|
|
43169
|
-
"required": true,
|
|
43170
|
-
"type": {
|
|
43171
|
-
"kind": "primitive",
|
|
43172
|
-
"value": "string"
|
|
43173
|
-
},
|
|
43174
|
-
"description": "",
|
|
43175
|
-
"declarations": [
|
|
43176
|
-
{
|
|
43177
|
-
"name": "textValue",
|
|
43178
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43179
|
-
}
|
|
43180
|
-
],
|
|
43181
|
-
"tags": {}
|
|
43182
|
-
}
|
|
43183
|
-
]
|
|
43184
|
-
},
|
|
43185
|
-
"required": true,
|
|
43186
|
-
"rest": false,
|
|
43187
|
-
"description": "",
|
|
43188
|
-
"declarations": [
|
|
43189
|
-
{
|
|
43190
|
-
"name": "data",
|
|
43191
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43192
|
-
}
|
|
43193
|
-
],
|
|
43194
|
-
"tags": {}
|
|
43195
|
-
}
|
|
43196
|
-
],
|
|
43197
|
-
"members": [],
|
|
43198
|
-
"returnType": {
|
|
43199
|
-
"kind": "primitive",
|
|
43200
|
-
"value": "void"
|
|
43201
|
-
}
|
|
43202
|
-
},
|
|
43203
|
-
"required": true,
|
|
43204
|
-
"description": "Register an item to the list. Takes in an identifier, a React.Ref and an optional index. This\nshould be called on component mount",
|
|
43205
|
-
"declarations": [
|
|
43206
|
-
{
|
|
43207
|
-
"name": "registerItem",
|
|
43208
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43209
|
-
}
|
|
43210
|
-
],
|
|
43211
|
-
"tags": {}
|
|
43212
|
-
},
|
|
43213
|
-
{
|
|
43214
|
-
"kind": "property",
|
|
43215
|
-
"name": "goTo",
|
|
43216
|
-
"type": {
|
|
43217
|
-
"kind": "function",
|
|
43218
|
-
"parameters": [
|
|
43219
|
-
{
|
|
43220
|
-
"kind": "parameter",
|
|
43221
|
-
"name": "data",
|
|
43222
|
-
"type": {
|
|
43223
|
-
"kind": "object",
|
|
43224
|
-
"properties": [
|
|
43225
|
-
{
|
|
43226
|
-
"kind": "property",
|
|
43227
|
-
"name": "id",
|
|
43228
|
-
"required": true,
|
|
43229
|
-
"type": {
|
|
43230
|
-
"kind": "primitive",
|
|
43231
|
-
"value": "string"
|
|
43232
|
-
},
|
|
43233
|
-
"description": "",
|
|
43234
|
-
"declarations": [
|
|
43235
|
-
{
|
|
43236
|
-
"name": "id",
|
|
43237
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43238
|
-
}
|
|
43239
|
-
],
|
|
43240
|
-
"tags": {}
|
|
43241
|
-
}
|
|
43242
|
-
]
|
|
43243
|
-
},
|
|
43244
|
-
"required": true,
|
|
43245
|
-
"rest": false,
|
|
43246
|
-
"description": "",
|
|
43247
|
-
"declarations": [
|
|
43248
|
-
{
|
|
43249
|
-
"name": "data",
|
|
43250
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43251
|
-
}
|
|
43252
|
-
],
|
|
43253
|
-
"tags": {}
|
|
43254
|
-
}
|
|
43255
|
-
],
|
|
43256
|
-
"members": [],
|
|
43257
|
-
"returnType": {
|
|
43258
|
-
"kind": "primitive",
|
|
43259
|
-
"value": "void"
|
|
43260
|
-
}
|
|
43261
|
-
},
|
|
43262
|
-
"required": true,
|
|
43263
|
-
"description": "Directly sets the cursor to the list item by its identifier.",
|
|
43264
|
-
"declarations": [
|
|
43265
|
-
{
|
|
43266
|
-
"name": "goTo",
|
|
43267
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43268
|
-
}
|
|
43269
|
-
],
|
|
43270
|
-
"tags": {}
|
|
43271
|
-
},
|
|
43272
|
-
{
|
|
43273
|
-
"kind": "property",
|
|
43274
|
-
"name": "goToNext",
|
|
43275
|
-
"type": {
|
|
43276
|
-
"kind": "function",
|
|
43277
|
-
"parameters": [],
|
|
43278
|
-
"members": [],
|
|
43279
|
-
"returnType": {
|
|
43280
|
-
"kind": "primitive",
|
|
43281
|
-
"value": "void"
|
|
43282
|
-
}
|
|
43283
|
-
},
|
|
43284
|
-
"required": true,
|
|
43285
|
-
"description": "Set the cursor to the \"next\" item in the list. This event delegates to the `getNext` method of\nthe navigation manager. For a list, the default navigation manager will wrap if cursor is\ncurrently on the last item. For a grid, the default navigation manager will stay on the last\nitem in a row.",
|
|
43286
|
-
"declarations": [
|
|
43287
|
-
{
|
|
43288
|
-
"name": "goToNext",
|
|
43289
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43290
|
-
}
|
|
43291
|
-
],
|
|
43292
|
-
"tags": {}
|
|
43293
|
-
},
|
|
43294
|
-
{
|
|
43295
|
-
"kind": "property",
|
|
43296
|
-
"name": "goToPrevious",
|
|
43297
|
-
"type": {
|
|
43298
|
-
"kind": "function",
|
|
43299
|
-
"parameters": [],
|
|
43300
|
-
"members": [],
|
|
43301
|
-
"returnType": {
|
|
43302
|
-
"kind": "primitive",
|
|
43303
|
-
"value": "void"
|
|
43304
|
-
}
|
|
43305
|
-
},
|
|
43306
|
-
"required": true,
|
|
43307
|
-
"description": "Set the cursor to the \"previous\" item in the list. If the beginning of the list is detected,\nit will wrap to the last item",
|
|
43308
|
-
"declarations": [
|
|
43309
|
-
{
|
|
43310
|
-
"name": "goToPrevious",
|
|
43311
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43312
|
-
}
|
|
43313
|
-
],
|
|
43314
|
-
"tags": {}
|
|
43315
|
-
},
|
|
43316
|
-
{
|
|
43317
|
-
"kind": "property",
|
|
43318
|
-
"name": "goToPreviousRow",
|
|
43319
|
-
"type": {
|
|
43320
|
-
"kind": "function",
|
|
43321
|
-
"parameters": [],
|
|
43322
|
-
"members": [],
|
|
43323
|
-
"returnType": {
|
|
43324
|
-
"kind": "primitive",
|
|
43325
|
-
"value": "void"
|
|
43326
|
-
}
|
|
43327
|
-
},
|
|
43328
|
-
"required": true,
|
|
43329
|
-
"description": "Previous item perpendicular to the orientation of a list, or the previous row in a grid. For\nexample, if a list is horizontal, the previous row would describe an up direction. This could\nbe ignored by the navigation manager, or return the same result as `previous()`. In a grid,\nthis would be the previous row (current position - column count).",
|
|
43330
|
-
"declarations": [
|
|
43331
|
-
{
|
|
43332
|
-
"name": "goToPreviousRow",
|
|
43333
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43334
|
-
}
|
|
43335
|
-
],
|
|
43336
|
-
"tags": {}
|
|
43337
|
-
},
|
|
43338
|
-
{
|
|
43339
|
-
"kind": "property",
|
|
43340
|
-
"name": "goToNextRow",
|
|
43341
|
-
"type": {
|
|
43342
|
-
"kind": "function",
|
|
43343
|
-
"parameters": [],
|
|
43344
|
-
"members": [],
|
|
43345
|
-
"returnType": {
|
|
43346
|
-
"kind": "primitive",
|
|
43347
|
-
"value": "void"
|
|
43348
|
-
}
|
|
43349
|
-
},
|
|
43350
|
-
"required": true,
|
|
43351
|
-
"description": "Next item perpendicular to the orientation of a list, or the next row in a grid. For example,\nif a list is horizontal, the next row would describe a down direction. This could be ignored by\nthe navigation manager, or return the same result as `next()`. In a grid, this would be the\nnext row (current position + column count).",
|
|
43352
|
-
"declarations": [
|
|
43353
|
-
{
|
|
43354
|
-
"name": "goToNextRow",
|
|
43355
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43356
|
-
}
|
|
43357
|
-
],
|
|
43358
|
-
"tags": {}
|
|
43359
|
-
},
|
|
43360
|
-
{
|
|
43361
|
-
"kind": "property",
|
|
43362
|
-
"name": "goToFirst",
|
|
43363
|
-
"type": {
|
|
43364
|
-
"kind": "function",
|
|
43365
|
-
"parameters": [],
|
|
43366
|
-
"members": [],
|
|
43367
|
-
"returnType": {
|
|
43368
|
-
"kind": "primitive",
|
|
43369
|
-
"value": "void"
|
|
43370
|
-
}
|
|
43371
|
-
},
|
|
43372
|
-
"required": true,
|
|
43373
|
-
"description": "Set the cursor to the first item in the list",
|
|
43374
|
-
"declarations": [
|
|
43375
|
-
{
|
|
43376
|
-
"name": "goToFirst",
|
|
43377
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43378
|
-
}
|
|
43379
|
-
],
|
|
43380
|
-
"tags": {}
|
|
43381
|
-
},
|
|
43382
|
-
{
|
|
43383
|
-
"kind": "property",
|
|
43384
|
-
"name": "goToLast",
|
|
43385
|
-
"type": {
|
|
43386
|
-
"kind": "function",
|
|
43387
|
-
"parameters": [],
|
|
43388
|
-
"members": [],
|
|
43389
|
-
"returnType": {
|
|
43390
|
-
"kind": "primitive",
|
|
43391
|
-
"value": "void"
|
|
43392
|
-
}
|
|
43393
|
-
},
|
|
43394
|
-
"required": true,
|
|
43395
|
-
"description": "Set the cursor to the last item in the list",
|
|
43396
|
-
"declarations": [
|
|
43397
|
-
{
|
|
43398
|
-
"name": "goToLast",
|
|
43399
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43400
|
-
}
|
|
43401
|
-
],
|
|
43402
|
-
"tags": {}
|
|
43403
|
-
},
|
|
43404
|
-
{
|
|
43405
|
-
"kind": "property",
|
|
43406
|
-
"name": "goToFirstOfRow",
|
|
43407
|
-
"type": {
|
|
43408
|
-
"kind": "function",
|
|
43409
|
-
"parameters": [],
|
|
43410
|
-
"members": [],
|
|
43411
|
-
"returnType": {
|
|
43412
|
-
"kind": "primitive",
|
|
43413
|
-
"value": "void"
|
|
43414
|
-
}
|
|
43415
|
-
},
|
|
43416
|
-
"required": true,
|
|
43417
|
-
"description": "",
|
|
43418
|
-
"declarations": [
|
|
43419
|
-
{
|
|
43420
|
-
"name": "goToFirstOfRow",
|
|
43421
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43422
|
-
}
|
|
43423
|
-
],
|
|
43424
|
-
"tags": {}
|
|
43425
|
-
},
|
|
43426
|
-
{
|
|
43427
|
-
"kind": "property",
|
|
43428
|
-
"name": "goToLastOfRow",
|
|
43429
|
-
"type": {
|
|
43430
|
-
"kind": "function",
|
|
43431
|
-
"parameters": [],
|
|
43432
|
-
"members": [],
|
|
43433
|
-
"returnType": {
|
|
43434
|
-
"kind": "primitive",
|
|
43435
|
-
"value": "void"
|
|
43436
|
-
}
|
|
43437
|
-
},
|
|
43438
|
-
"required": true,
|
|
43439
|
-
"description": "",
|
|
43440
|
-
"declarations": [
|
|
43441
|
-
{
|
|
43442
|
-
"name": "goToLastOfRow",
|
|
43443
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43444
|
-
}
|
|
43445
|
-
],
|
|
43446
|
-
"tags": {}
|
|
43447
|
-
},
|
|
43448
|
-
{
|
|
43449
|
-
"kind": "property",
|
|
43450
|
-
"name": "goToNextPage",
|
|
43451
|
-
"type": {
|
|
43452
|
-
"kind": "function",
|
|
43453
|
-
"parameters": [],
|
|
43454
|
-
"members": [],
|
|
43455
|
-
"returnType": {
|
|
43456
|
-
"kind": "primitive",
|
|
43457
|
-
"value": "void"
|
|
43458
|
-
}
|
|
43459
|
-
},
|
|
43460
|
-
"required": true,
|
|
43461
|
-
"description": "",
|
|
43462
|
-
"declarations": [
|
|
43463
|
-
{
|
|
43464
|
-
"name": "goToNextPage",
|
|
43465
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43466
|
-
}
|
|
43467
|
-
],
|
|
43468
|
-
"tags": {}
|
|
43469
|
-
},
|
|
43470
|
-
{
|
|
43471
|
-
"kind": "property",
|
|
43472
|
-
"name": "goToPreviousPage",
|
|
43473
|
-
"type": {
|
|
43474
|
-
"kind": "function",
|
|
43475
|
-
"parameters": [],
|
|
43476
|
-
"members": [],
|
|
43477
|
-
"returnType": {
|
|
43478
|
-
"kind": "primitive",
|
|
43479
|
-
"value": "void"
|
|
43480
|
-
}
|
|
43481
|
-
},
|
|
43482
|
-
"required": true,
|
|
43483
|
-
"description": "",
|
|
43484
|
-
"declarations": [
|
|
43485
|
-
{
|
|
43486
|
-
"name": "goToPreviousPage",
|
|
43487
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43488
|
-
}
|
|
43489
|
-
],
|
|
43490
|
-
"tags": {}
|
|
43491
|
-
},
|
|
43492
|
-
{
|
|
43493
|
-
"kind": "property",
|
|
43494
|
-
"name": "unregisterItem",
|
|
43495
|
-
"type": {
|
|
43496
|
-
"kind": "function",
|
|
43497
|
-
"parameters": [
|
|
43498
|
-
{
|
|
43499
|
-
"kind": "parameter",
|
|
43500
|
-
"name": "data",
|
|
43501
|
-
"type": {
|
|
43502
|
-
"kind": "object",
|
|
43503
|
-
"properties": [
|
|
43504
|
-
{
|
|
43505
|
-
"kind": "property",
|
|
43506
|
-
"name": "id",
|
|
43507
|
-
"required": true,
|
|
43508
|
-
"type": {
|
|
43509
|
-
"kind": "primitive",
|
|
43510
|
-
"value": "string"
|
|
43511
|
-
},
|
|
43512
|
-
"description": "",
|
|
43513
|
-
"declarations": [
|
|
43514
|
-
{
|
|
43515
|
-
"name": "id",
|
|
43516
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43517
|
-
}
|
|
43518
|
-
],
|
|
43519
|
-
"tags": {}
|
|
43520
|
-
}
|
|
43521
|
-
]
|
|
43522
|
-
},
|
|
43523
|
-
"required": true,
|
|
43524
|
-
"rest": false,
|
|
43525
|
-
"description": "",
|
|
43526
|
-
"declarations": [
|
|
43527
|
-
{
|
|
43528
|
-
"name": "data",
|
|
43529
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43530
|
-
}
|
|
43531
|
-
],
|
|
43532
|
-
"tags": {}
|
|
43533
|
-
}
|
|
43534
|
-
],
|
|
43535
|
-
"members": [],
|
|
43536
|
-
"returnType": {
|
|
43537
|
-
"kind": "primitive",
|
|
43538
|
-
"value": "void"
|
|
43539
|
-
}
|
|
43540
|
-
},
|
|
43541
|
-
"required": true,
|
|
43542
|
-
"description": "Unregister an item by its identifier. This should be called when the component is unmounted.\nThis event is only called for static rendering.",
|
|
43543
|
-
"declarations": [
|
|
43544
|
-
{
|
|
43545
|
-
"name": "unregisterItem",
|
|
43546
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43547
|
-
}
|
|
43548
|
-
],
|
|
43549
|
-
"tags": {}
|
|
43550
|
-
},
|
|
43551
|
-
{
|
|
43552
|
-
"kind": "property",
|
|
43553
|
-
"name": "updateItemHeight",
|
|
43554
|
-
"type": {
|
|
43555
|
-
"kind": "function",
|
|
43556
|
-
"parameters": [
|
|
43557
|
-
{
|
|
43558
|
-
"kind": "parameter",
|
|
43559
|
-
"name": "data",
|
|
43560
|
-
"type": {
|
|
43561
|
-
"kind": "object",
|
|
43562
|
-
"properties": [
|
|
43563
|
-
{
|
|
43564
|
-
"kind": "property",
|
|
43565
|
-
"name": "value",
|
|
43566
|
-
"required": true,
|
|
43567
|
-
"type": {
|
|
43568
|
-
"kind": "primitive",
|
|
43569
|
-
"value": "number"
|
|
43570
|
-
},
|
|
43571
|
-
"description": "",
|
|
43572
|
-
"declarations": [
|
|
43573
|
-
{
|
|
43574
|
-
"name": "value",
|
|
43575
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43576
|
-
}
|
|
43577
|
-
],
|
|
43578
|
-
"tags": {}
|
|
43579
|
-
}
|
|
43580
|
-
]
|
|
43581
|
-
},
|
|
43582
|
-
"required": true,
|
|
43583
|
-
"rest": false,
|
|
43584
|
-
"description": "",
|
|
43585
|
-
"declarations": [
|
|
43586
|
-
{
|
|
43587
|
-
"name": "data",
|
|
43588
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43589
|
-
}
|
|
43590
|
-
],
|
|
43591
|
-
"tags": {}
|
|
43592
|
-
}
|
|
43593
|
-
],
|
|
43594
|
-
"members": [],
|
|
43595
|
-
"returnType": {
|
|
43596
|
-
"kind": "primitive",
|
|
43597
|
-
"value": "void"
|
|
43598
|
-
}
|
|
43599
|
-
},
|
|
43600
|
-
"required": true,
|
|
43601
|
-
"description": "Updates the default item height. This should only be called when item height is measured.\nCalling this with a different default item height than previous will cause a virtual list to\nrecalculate the overall height of the list and invalidate any height caching. Doing this only\non the first item may save the user from experiencing odd scrolling behavior where the\nscrollbar updates while scrolling. If the user uses the mouse to drag the bar, it can become\n\"detached\" since the browser recalculates scroll bar position while the overflow container is\nupdated.",
|
|
43602
|
-
"declarations": [
|
|
43603
|
-
{
|
|
43604
|
-
"name": "updateItemHeight",
|
|
43605
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43606
|
-
}
|
|
43607
|
-
],
|
|
43608
|
-
"tags": {}
|
|
43609
|
-
},
|
|
43610
|
-
{
|
|
43611
|
-
"kind": "property",
|
|
43612
|
-
"name": "updatePlacement",
|
|
43613
|
-
"type": {
|
|
43614
|
-
"kind": "function",
|
|
43615
|
-
"parameters": [
|
|
43616
|
-
{
|
|
43617
|
-
"kind": "parameter",
|
|
43618
|
-
"name": "data",
|
|
43619
|
-
"type": {
|
|
43620
|
-
"kind": "object",
|
|
43621
|
-
"properties": [
|
|
43622
|
-
{
|
|
43623
|
-
"kind": "property",
|
|
43624
|
-
"name": "placement",
|
|
43625
|
-
"required": true,
|
|
43626
|
-
"type": {
|
|
43627
|
-
"kind": "symbol",
|
|
43628
|
-
"name": "Placement",
|
|
43629
|
-
"value": "Placement"
|
|
43630
|
-
},
|
|
43631
|
-
"description": "",
|
|
43632
|
-
"declarations": [
|
|
43633
|
-
{
|
|
43634
|
-
"name": "placement",
|
|
43635
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
43636
|
-
}
|
|
43637
|
-
],
|
|
43638
|
-
"tags": {}
|
|
43639
|
-
}
|
|
43640
|
-
]
|
|
43641
|
-
},
|
|
43642
|
-
"required": true,
|
|
43643
|
-
"rest": false,
|
|
43644
|
-
"description": "",
|
|
43645
|
-
"declarations": [
|
|
43646
|
-
{
|
|
43647
|
-
"name": "data",
|
|
43648
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
43649
|
-
}
|
|
43650
|
-
],
|
|
43651
|
-
"tags": {}
|
|
43652
|
-
}
|
|
43653
|
-
],
|
|
43654
|
-
"members": [],
|
|
43655
|
-
"returnType": {
|
|
43656
|
-
"kind": "primitive",
|
|
43657
|
-
"value": "void"
|
|
43658
|
-
}
|
|
43659
|
-
},
|
|
43660
|
-
"required": true,
|
|
43661
|
-
"description": "Called whenever a popup placement changes around a target. This is useful for animations that\ndepend on the placement chosen.",
|
|
43662
|
-
"declarations": [
|
|
43663
|
-
{
|
|
43664
|
-
"name": "updatePlacement",
|
|
43665
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
43666
|
-
}
|
|
43667
|
-
],
|
|
43668
|
-
"tags": {}
|
|
43669
|
-
},
|
|
43670
|
-
{
|
|
43671
|
-
"kind": "property",
|
|
43672
|
-
"name": "show",
|
|
43673
|
-
"type": {
|
|
43674
|
-
"kind": "function",
|
|
43675
|
-
"parameters": [
|
|
43676
|
-
{
|
|
43677
|
-
"kind": "parameter",
|
|
43678
|
-
"name": "event",
|
|
43679
|
-
"type": {
|
|
43680
|
-
"kind": "union",
|
|
43681
|
-
"value": [
|
|
43682
|
-
{
|
|
43683
|
-
"kind": "external",
|
|
43684
|
-
"name": "Event",
|
|
43685
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
43686
|
-
},
|
|
43687
|
-
{
|
|
43688
|
-
"kind": "external",
|
|
43689
|
-
"name": "SyntheticEvent",
|
|
43690
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
43691
|
-
}
|
|
43692
|
-
]
|
|
43693
|
-
},
|
|
43694
|
-
"required": false,
|
|
43695
|
-
"rest": false,
|
|
43696
|
-
"description": "",
|
|
43697
|
-
"declarations": [
|
|
43698
|
-
{
|
|
43699
|
-
"name": "event",
|
|
43700
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43701
|
-
}
|
|
43702
|
-
],
|
|
43703
|
-
"tags": {}
|
|
43704
|
-
}
|
|
43705
|
-
],
|
|
43706
|
-
"members": [],
|
|
43707
|
-
"returnType": {
|
|
43708
|
-
"kind": "primitive",
|
|
43709
|
-
"value": "void"
|
|
43710
|
-
}
|
|
43711
|
-
},
|
|
43712
|
-
"required": true,
|
|
43713
|
-
"description": "Start showing the disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
43714
|
-
"declarations": [
|
|
43715
|
-
{
|
|
43716
|
-
"name": "show",
|
|
43717
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43718
|
-
}
|
|
43719
|
-
],
|
|
43720
|
-
"tags": {}
|
|
43721
|
-
},
|
|
43722
|
-
{
|
|
43723
|
-
"kind": "property",
|
|
43724
|
-
"name": "hide",
|
|
43725
|
-
"type": {
|
|
43726
|
-
"kind": "function",
|
|
43727
|
-
"parameters": [
|
|
43728
|
-
{
|
|
43729
|
-
"kind": "parameter",
|
|
43730
|
-
"name": "event",
|
|
43731
|
-
"type": {
|
|
43732
|
-
"kind": "union",
|
|
43733
|
-
"value": [
|
|
43734
|
-
{
|
|
43735
|
-
"kind": "external",
|
|
43736
|
-
"name": "Event",
|
|
43737
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
43738
|
-
},
|
|
43739
|
-
{
|
|
43740
|
-
"kind": "external",
|
|
43741
|
-
"name": "SyntheticEvent",
|
|
43742
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
43743
|
-
}
|
|
43744
|
-
]
|
|
43745
|
-
},
|
|
43746
|
-
"required": false,
|
|
43747
|
-
"rest": false,
|
|
43748
|
-
"description": "",
|
|
43749
|
-
"declarations": [
|
|
43750
|
-
{
|
|
43751
|
-
"name": "event",
|
|
43752
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43753
|
-
}
|
|
43754
|
-
],
|
|
43755
|
-
"tags": {}
|
|
43756
|
-
}
|
|
43757
|
-
],
|
|
43758
|
-
"members": [],
|
|
43759
|
-
"returnType": {
|
|
43760
|
-
"kind": "primitive",
|
|
43761
|
-
"value": "void"
|
|
43762
|
-
}
|
|
43763
|
-
},
|
|
43764
|
-
"required": true,
|
|
43765
|
-
"description": "Start hiding this disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
43766
|
-
"declarations": [
|
|
43767
|
-
{
|
|
43768
|
-
"name": "hide",
|
|
43769
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
43770
|
-
}
|
|
43771
|
-
],
|
|
43772
|
-
"tags": {}
|
|
43773
|
-
},
|
|
43774
|
-
{
|
|
43775
|
-
"kind": "property",
|
|
43776
|
-
"name": "select",
|
|
43777
|
-
"type": {
|
|
43778
|
-
"kind": "function",
|
|
43779
|
-
"parameters": [
|
|
43780
|
-
{
|
|
43781
|
-
"kind": "parameter",
|
|
43782
|
-
"name": "data",
|
|
43783
|
-
"type": {
|
|
43784
|
-
"kind": "object",
|
|
43785
|
-
"properties": [
|
|
43786
|
-
{
|
|
43787
|
-
"kind": "property",
|
|
43788
|
-
"name": "id",
|
|
43789
|
-
"required": true,
|
|
43790
|
-
"type": {
|
|
43791
|
-
"kind": "primitive",
|
|
43792
|
-
"value": "string"
|
|
43793
|
-
},
|
|
43794
|
-
"description": "",
|
|
43795
|
-
"declarations": [
|
|
43796
|
-
{
|
|
43797
|
-
"name": "id",
|
|
43798
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43799
|
-
}
|
|
43800
|
-
],
|
|
43801
|
-
"tags": {}
|
|
43802
|
-
}
|
|
43803
|
-
]
|
|
43804
|
-
},
|
|
43805
|
-
"required": true,
|
|
43806
|
-
"rest": false,
|
|
43807
|
-
"description": "",
|
|
43808
|
-
"declarations": [
|
|
43809
|
-
{
|
|
43810
|
-
"name": "data",
|
|
43811
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43812
|
-
}
|
|
43813
|
-
],
|
|
43814
|
-
"tags": {}
|
|
43815
|
-
}
|
|
43816
|
-
],
|
|
43817
|
-
"members": [],
|
|
43818
|
-
"returnType": {
|
|
43819
|
-
"kind": "primitive",
|
|
43820
|
-
"value": "void"
|
|
43821
|
-
}
|
|
43822
|
-
},
|
|
43823
|
-
"required": true,
|
|
43824
|
-
"description": "Select a specific item by its identifier.",
|
|
43825
|
-
"declarations": [
|
|
43826
|
-
{
|
|
43827
|
-
"name": "select",
|
|
43828
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43829
|
-
}
|
|
43830
|
-
],
|
|
43831
|
-
"tags": {}
|
|
43832
|
-
},
|
|
43833
|
-
{
|
|
43834
|
-
"kind": "property",
|
|
43835
|
-
"name": "selectAll",
|
|
43836
|
-
"type": {
|
|
43837
|
-
"kind": "function",
|
|
43838
|
-
"parameters": [],
|
|
43839
|
-
"members": [],
|
|
43840
|
-
"returnType": {
|
|
43841
|
-
"kind": "primitive",
|
|
43842
|
-
"value": "void"
|
|
43843
|
-
}
|
|
43844
|
-
},
|
|
43845
|
-
"required": true,
|
|
43846
|
-
"description": "Select all items. This will set `selectedIds` to `'all'` and remove all `unselectedIds`.\nThis is especially useful for virtual lists where not all items are loaded in memory.",
|
|
43847
|
-
"declarations": [
|
|
43848
|
-
{
|
|
43849
|
-
"name": "selectAll",
|
|
43850
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43851
|
-
}
|
|
43852
|
-
],
|
|
43853
|
-
"tags": {}
|
|
43854
|
-
},
|
|
43855
|
-
{
|
|
43856
|
-
"kind": "property",
|
|
43857
|
-
"name": "unselectAll",
|
|
43858
|
-
"type": {
|
|
43859
|
-
"kind": "function",
|
|
43860
|
-
"parameters": [],
|
|
43861
|
-
"members": [],
|
|
43862
|
-
"returnType": {
|
|
43863
|
-
"kind": "primitive",
|
|
43864
|
-
"value": "void"
|
|
43865
|
-
}
|
|
43866
|
-
},
|
|
43867
|
-
"required": true,
|
|
43868
|
-
"description": "Unselect all items.",
|
|
43869
|
-
"declarations": [
|
|
43870
|
-
{
|
|
43871
|
-
"name": "unselectAll",
|
|
43872
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useSelectionListModel.tsx"
|
|
43873
|
-
}
|
|
43874
|
-
],
|
|
43875
|
-
"tags": {}
|
|
43876
|
-
},
|
|
43877
|
-
{
|
|
43878
|
-
"kind": "property",
|
|
43879
|
-
"name": "registerItem",
|
|
43880
|
-
"type": {
|
|
43881
|
-
"kind": "function",
|
|
43882
|
-
"parameters": [
|
|
43883
|
-
{
|
|
43884
|
-
"kind": "parameter",
|
|
43885
|
-
"name": "data",
|
|
43886
|
-
"type": {
|
|
43887
|
-
"kind": "object",
|
|
43888
|
-
"properties": [
|
|
43889
|
-
{
|
|
43890
|
-
"kind": "property",
|
|
43891
|
-
"name": "item",
|
|
43892
|
-
"required": true,
|
|
43893
|
-
"type": {
|
|
43894
|
-
"kind": "symbol",
|
|
43895
|
-
"name": "Generic",
|
|
43896
|
-
"value": "any"
|
|
43897
|
-
},
|
|
43898
|
-
"description": "",
|
|
43899
|
-
"declarations": [
|
|
43900
|
-
{
|
|
43901
|
-
"name": "item",
|
|
43902
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43903
|
-
}
|
|
43904
|
-
],
|
|
43905
|
-
"tags": {}
|
|
43906
|
-
},
|
|
43907
|
-
{
|
|
43908
|
-
"kind": "property",
|
|
43909
|
-
"name": "textValue",
|
|
43910
|
-
"required": true,
|
|
43911
|
-
"type": {
|
|
43912
|
-
"kind": "primitive",
|
|
43913
|
-
"value": "string"
|
|
43914
|
-
},
|
|
43915
|
-
"description": "",
|
|
43916
|
-
"declarations": [
|
|
43917
|
-
{
|
|
43918
|
-
"name": "textValue",
|
|
43919
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
43920
|
-
}
|
|
43921
|
-
],
|
|
43922
|
-
"tags": {}
|
|
43923
|
-
}
|
|
43924
|
-
]
|
|
43925
|
-
},
|
|
43926
|
-
"required": true,
|
|
43927
|
-
"rest": false,
|
|
43928
|
-
"description": "",
|
|
43929
|
-
"declarations": [
|
|
43930
|
-
{
|
|
43931
|
-
"name": "data",
|
|
43932
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43933
|
-
}
|
|
43934
|
-
],
|
|
43935
|
-
"tags": {}
|
|
43936
|
-
}
|
|
43937
|
-
],
|
|
43938
|
-
"members": [],
|
|
43939
|
-
"returnType": {
|
|
43940
|
-
"kind": "primitive",
|
|
43941
|
-
"value": "void"
|
|
43942
|
-
}
|
|
43943
|
-
},
|
|
43944
|
-
"required": true,
|
|
43945
|
-
"description": "Register an item to the list. Takes in an identifier, a React.Ref and an optional index. This\nshould be called on component mount",
|
|
43946
|
-
"declarations": [
|
|
43947
|
-
{
|
|
43948
|
-
"name": "registerItem",
|
|
43949
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43950
|
-
}
|
|
43951
|
-
],
|
|
43952
|
-
"tags": {}
|
|
43953
|
-
},
|
|
43954
|
-
{
|
|
43955
|
-
"kind": "property",
|
|
43956
|
-
"name": "goTo",
|
|
43957
|
-
"type": {
|
|
43958
|
-
"kind": "function",
|
|
43959
|
-
"parameters": [
|
|
43960
|
-
{
|
|
43961
|
-
"kind": "parameter",
|
|
43962
|
-
"name": "data",
|
|
43963
|
-
"type": {
|
|
43964
|
-
"kind": "object",
|
|
43965
|
-
"properties": [
|
|
43966
|
-
{
|
|
43967
|
-
"kind": "property",
|
|
43968
|
-
"name": "id",
|
|
43969
|
-
"required": true,
|
|
43970
|
-
"type": {
|
|
43971
|
-
"kind": "primitive",
|
|
43972
|
-
"value": "string"
|
|
43973
|
-
},
|
|
43974
|
-
"description": "",
|
|
43975
|
-
"declarations": [
|
|
43976
|
-
{
|
|
43977
|
-
"name": "id",
|
|
43978
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43979
|
-
}
|
|
43980
|
-
],
|
|
43981
|
-
"tags": {}
|
|
43982
|
-
}
|
|
43983
|
-
]
|
|
43984
|
-
},
|
|
43985
|
-
"required": true,
|
|
43986
|
-
"rest": false,
|
|
43987
|
-
"description": "",
|
|
43988
|
-
"declarations": [
|
|
43989
|
-
{
|
|
43990
|
-
"name": "data",
|
|
43991
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
43992
|
-
}
|
|
43993
|
-
],
|
|
43994
|
-
"tags": {}
|
|
43995
|
-
}
|
|
43996
|
-
],
|
|
43997
|
-
"members": [],
|
|
43998
|
-
"returnType": {
|
|
43999
|
-
"kind": "primitive",
|
|
44000
|
-
"value": "void"
|
|
44001
|
-
}
|
|
44002
|
-
},
|
|
44003
|
-
"required": true,
|
|
44004
|
-
"description": "Directly sets the cursor to the list item by its identifier.",
|
|
44005
|
-
"declarations": [
|
|
44006
|
-
{
|
|
44007
|
-
"name": "goTo",
|
|
44008
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44009
|
-
}
|
|
44010
|
-
],
|
|
44011
|
-
"tags": {}
|
|
44012
|
-
},
|
|
44013
|
-
{
|
|
44014
|
-
"kind": "property",
|
|
44015
|
-
"name": "goToNext",
|
|
44016
|
-
"type": {
|
|
44017
|
-
"kind": "function",
|
|
44018
|
-
"parameters": [],
|
|
44019
|
-
"members": [],
|
|
44020
|
-
"returnType": {
|
|
44021
|
-
"kind": "primitive",
|
|
44022
|
-
"value": "void"
|
|
44023
|
-
}
|
|
44024
|
-
},
|
|
44025
|
-
"required": true,
|
|
44026
|
-
"description": "Set the cursor to the \"next\" item in the list. This event delegates to the `getNext` method of\nthe navigation manager. For a list, the default navigation manager will wrap if cursor is\ncurrently on the last item. For a grid, the default navigation manager will stay on the last\nitem in a row.",
|
|
44027
|
-
"declarations": [
|
|
44028
|
-
{
|
|
44029
|
-
"name": "goToNext",
|
|
44030
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44031
|
-
}
|
|
44032
|
-
],
|
|
44033
|
-
"tags": {}
|
|
44034
|
-
},
|
|
44035
|
-
{
|
|
44036
|
-
"kind": "property",
|
|
44037
|
-
"name": "goToPrevious",
|
|
44038
|
-
"type": {
|
|
44039
|
-
"kind": "function",
|
|
44040
|
-
"parameters": [],
|
|
44041
|
-
"members": [],
|
|
44042
|
-
"returnType": {
|
|
44043
|
-
"kind": "primitive",
|
|
44044
|
-
"value": "void"
|
|
44045
|
-
}
|
|
44046
|
-
},
|
|
44047
|
-
"required": true,
|
|
44048
|
-
"description": "Set the cursor to the \"previous\" item in the list. If the beginning of the list is detected,\nit will wrap to the last item",
|
|
44049
|
-
"declarations": [
|
|
44050
|
-
{
|
|
44051
|
-
"name": "goToPrevious",
|
|
44052
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44053
|
-
}
|
|
44054
|
-
],
|
|
44055
|
-
"tags": {}
|
|
44056
|
-
},
|
|
44057
|
-
{
|
|
44058
|
-
"kind": "property",
|
|
44059
|
-
"name": "goToPreviousRow",
|
|
44060
|
-
"type": {
|
|
44061
|
-
"kind": "function",
|
|
44062
|
-
"parameters": [],
|
|
44063
|
-
"members": [],
|
|
44064
|
-
"returnType": {
|
|
44065
|
-
"kind": "primitive",
|
|
44066
|
-
"value": "void"
|
|
44067
|
-
}
|
|
44068
|
-
},
|
|
44069
|
-
"required": true,
|
|
44070
|
-
"description": "Previous item perpendicular to the orientation of a list, or the previous row in a grid. For\nexample, if a list is horizontal, the previous row would describe an up direction. This could\nbe ignored by the navigation manager, or return the same result as `previous()`. In a grid,\nthis would be the previous row (current position - column count).",
|
|
44071
|
-
"declarations": [
|
|
44072
|
-
{
|
|
44073
|
-
"name": "goToPreviousRow",
|
|
44074
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44075
|
-
}
|
|
44076
|
-
],
|
|
44077
|
-
"tags": {}
|
|
44078
|
-
},
|
|
44079
|
-
{
|
|
44080
|
-
"kind": "property",
|
|
44081
|
-
"name": "goToNextRow",
|
|
44082
|
-
"type": {
|
|
44083
|
-
"kind": "function",
|
|
44084
|
-
"parameters": [],
|
|
44085
|
-
"members": [],
|
|
44086
|
-
"returnType": {
|
|
44087
|
-
"kind": "primitive",
|
|
44088
|
-
"value": "void"
|
|
44089
|
-
}
|
|
44090
|
-
},
|
|
44091
|
-
"required": true,
|
|
44092
|
-
"description": "Next item perpendicular to the orientation of a list, or the next row in a grid. For example,\nif a list is horizontal, the next row would describe a down direction. This could be ignored by\nthe navigation manager, or return the same result as `next()`. In a grid, this would be the\nnext row (current position + column count).",
|
|
44093
|
-
"declarations": [
|
|
44094
|
-
{
|
|
44095
|
-
"name": "goToNextRow",
|
|
44096
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44097
|
-
}
|
|
44098
|
-
],
|
|
44099
|
-
"tags": {}
|
|
44100
|
-
},
|
|
44101
|
-
{
|
|
44102
|
-
"kind": "property",
|
|
44103
|
-
"name": "goToFirst",
|
|
44104
|
-
"type": {
|
|
44105
|
-
"kind": "function",
|
|
44106
|
-
"parameters": [],
|
|
44107
|
-
"members": [],
|
|
44108
|
-
"returnType": {
|
|
44109
|
-
"kind": "primitive",
|
|
44110
|
-
"value": "void"
|
|
44111
|
-
}
|
|
44112
|
-
},
|
|
44113
|
-
"required": true,
|
|
44114
|
-
"description": "Set the cursor to the first item in the list",
|
|
44115
|
-
"declarations": [
|
|
44116
|
-
{
|
|
44117
|
-
"name": "goToFirst",
|
|
44118
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44119
|
-
}
|
|
44120
|
-
],
|
|
44121
|
-
"tags": {}
|
|
44122
|
-
},
|
|
44123
|
-
{
|
|
44124
|
-
"kind": "property",
|
|
44125
|
-
"name": "goToLast",
|
|
44126
|
-
"type": {
|
|
44127
|
-
"kind": "function",
|
|
44128
|
-
"parameters": [],
|
|
44129
|
-
"members": [],
|
|
44130
|
-
"returnType": {
|
|
44131
|
-
"kind": "primitive",
|
|
44132
|
-
"value": "void"
|
|
44133
|
-
}
|
|
44134
|
-
},
|
|
44135
|
-
"required": true,
|
|
44136
|
-
"description": "Set the cursor to the last item in the list",
|
|
44137
|
-
"declarations": [
|
|
44138
|
-
{
|
|
44139
|
-
"name": "goToLast",
|
|
44140
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44141
|
-
}
|
|
44142
|
-
],
|
|
44143
|
-
"tags": {}
|
|
44144
|
-
},
|
|
44145
|
-
{
|
|
44146
|
-
"kind": "property",
|
|
44147
|
-
"name": "goToFirstOfRow",
|
|
44148
|
-
"type": {
|
|
44149
|
-
"kind": "function",
|
|
44150
|
-
"parameters": [],
|
|
44151
|
-
"members": [],
|
|
44152
|
-
"returnType": {
|
|
44153
|
-
"kind": "primitive",
|
|
44154
|
-
"value": "void"
|
|
44155
|
-
}
|
|
44156
|
-
},
|
|
44157
|
-
"required": true,
|
|
44158
|
-
"description": "",
|
|
44159
|
-
"declarations": [
|
|
44160
|
-
{
|
|
44161
|
-
"name": "goToFirstOfRow",
|
|
44162
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44163
|
-
}
|
|
44164
|
-
],
|
|
44165
|
-
"tags": {}
|
|
44166
|
-
},
|
|
44167
|
-
{
|
|
44168
|
-
"kind": "property",
|
|
44169
|
-
"name": "goToLastOfRow",
|
|
44170
|
-
"type": {
|
|
44171
|
-
"kind": "function",
|
|
44172
|
-
"parameters": [],
|
|
44173
|
-
"members": [],
|
|
44174
|
-
"returnType": {
|
|
44175
|
-
"kind": "primitive",
|
|
44176
|
-
"value": "void"
|
|
44177
|
-
}
|
|
44178
|
-
},
|
|
44179
|
-
"required": true,
|
|
44180
|
-
"description": "",
|
|
44181
|
-
"declarations": [
|
|
44182
|
-
{
|
|
44183
|
-
"name": "goToLastOfRow",
|
|
44184
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44185
|
-
}
|
|
44186
|
-
],
|
|
44187
|
-
"tags": {}
|
|
44188
|
-
},
|
|
44189
|
-
{
|
|
44190
|
-
"kind": "property",
|
|
44191
|
-
"name": "goToNextPage",
|
|
44192
|
-
"type": {
|
|
44193
|
-
"kind": "function",
|
|
44194
|
-
"parameters": [],
|
|
44195
|
-
"members": [],
|
|
44196
|
-
"returnType": {
|
|
44197
|
-
"kind": "primitive",
|
|
44198
|
-
"value": "void"
|
|
44199
|
-
}
|
|
44200
|
-
},
|
|
44201
|
-
"required": true,
|
|
44202
|
-
"description": "",
|
|
44203
|
-
"declarations": [
|
|
44204
|
-
{
|
|
44205
|
-
"name": "goToNextPage",
|
|
44206
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44207
|
-
}
|
|
44208
|
-
],
|
|
44209
|
-
"tags": {}
|
|
44210
|
-
},
|
|
44211
|
-
{
|
|
44212
|
-
"kind": "property",
|
|
44213
|
-
"name": "goToPreviousPage",
|
|
44214
|
-
"type": {
|
|
44215
|
-
"kind": "function",
|
|
44216
|
-
"parameters": [],
|
|
44217
|
-
"members": [],
|
|
44218
|
-
"returnType": {
|
|
44219
|
-
"kind": "primitive",
|
|
44220
|
-
"value": "void"
|
|
44221
|
-
}
|
|
44222
|
-
},
|
|
44223
|
-
"required": true,
|
|
44224
|
-
"description": "",
|
|
44225
|
-
"declarations": [
|
|
44226
|
-
{
|
|
44227
|
-
"name": "goToPreviousPage",
|
|
44228
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
|
|
44229
|
-
}
|
|
44230
|
-
],
|
|
44231
|
-
"tags": {}
|
|
44232
|
-
},
|
|
44233
|
-
{
|
|
44234
|
-
"kind": "property",
|
|
44235
|
-
"name": "unregisterItem",
|
|
44236
|
-
"type": {
|
|
44237
|
-
"kind": "function",
|
|
44238
|
-
"parameters": [
|
|
44239
|
-
{
|
|
44240
|
-
"kind": "parameter",
|
|
44241
|
-
"name": "data",
|
|
44242
|
-
"type": {
|
|
44243
|
-
"kind": "object",
|
|
44244
|
-
"properties": [
|
|
44245
|
-
{
|
|
44246
|
-
"kind": "property",
|
|
44247
|
-
"name": "id",
|
|
44248
|
-
"required": true,
|
|
44249
|
-
"type": {
|
|
44250
|
-
"kind": "primitive",
|
|
44251
|
-
"value": "string"
|
|
44252
|
-
},
|
|
44253
|
-
"description": "",
|
|
44254
|
-
"declarations": [
|
|
44255
|
-
{
|
|
44256
|
-
"name": "id",
|
|
44257
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44258
|
-
}
|
|
44259
|
-
],
|
|
44260
|
-
"tags": {}
|
|
44261
|
-
}
|
|
44262
|
-
]
|
|
44263
|
-
},
|
|
44264
|
-
"required": true,
|
|
44265
|
-
"rest": false,
|
|
44266
|
-
"description": "",
|
|
44267
|
-
"declarations": [
|
|
44268
|
-
{
|
|
44269
|
-
"name": "data",
|
|
44270
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44271
|
-
}
|
|
44272
|
-
],
|
|
44273
|
-
"tags": {}
|
|
44274
|
-
}
|
|
44275
|
-
],
|
|
44276
|
-
"members": [],
|
|
44277
|
-
"returnType": {
|
|
44278
|
-
"kind": "primitive",
|
|
44279
|
-
"value": "void"
|
|
44280
|
-
}
|
|
44281
|
-
},
|
|
44282
|
-
"required": true,
|
|
44283
|
-
"description": "Unregister an item by its identifier. This should be called when the component is unmounted.\nThis event is only called for static rendering.",
|
|
44284
|
-
"declarations": [
|
|
44285
|
-
{
|
|
44286
|
-
"name": "unregisterItem",
|
|
44287
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44288
|
-
}
|
|
44289
|
-
],
|
|
44290
|
-
"tags": {}
|
|
44291
|
-
},
|
|
44292
|
-
{
|
|
44293
|
-
"kind": "property",
|
|
44294
|
-
"name": "updateItemHeight",
|
|
44295
|
-
"type": {
|
|
44296
|
-
"kind": "function",
|
|
44297
|
-
"parameters": [
|
|
44298
|
-
{
|
|
44299
|
-
"kind": "parameter",
|
|
44300
|
-
"name": "data",
|
|
44301
|
-
"type": {
|
|
44302
|
-
"kind": "object",
|
|
44303
|
-
"properties": [
|
|
44304
|
-
{
|
|
44305
|
-
"kind": "property",
|
|
44306
|
-
"name": "value",
|
|
44307
|
-
"required": true,
|
|
44308
|
-
"type": {
|
|
44309
|
-
"kind": "primitive",
|
|
44310
|
-
"value": "number"
|
|
44311
|
-
},
|
|
44312
|
-
"description": "",
|
|
44313
|
-
"declarations": [
|
|
44314
|
-
{
|
|
44315
|
-
"name": "value",
|
|
44316
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44317
|
-
}
|
|
44318
|
-
],
|
|
44319
|
-
"tags": {}
|
|
44320
|
-
}
|
|
44321
|
-
]
|
|
44322
|
-
},
|
|
44323
|
-
"required": true,
|
|
44324
|
-
"rest": false,
|
|
44325
|
-
"description": "",
|
|
44326
|
-
"declarations": [
|
|
44327
|
-
{
|
|
44328
|
-
"name": "data",
|
|
44329
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44330
|
-
}
|
|
44331
|
-
],
|
|
44332
|
-
"tags": {}
|
|
44333
|
-
}
|
|
44334
|
-
],
|
|
44335
|
-
"members": [],
|
|
44336
|
-
"returnType": {
|
|
44337
|
-
"kind": "primitive",
|
|
44338
|
-
"value": "void"
|
|
44339
|
-
}
|
|
44340
|
-
},
|
|
44341
|
-
"required": true,
|
|
44342
|
-
"description": "Updates the default item height. This should only be called when item height is measured.\nCalling this with a different default item height than previous will cause a virtual list to\nrecalculate the overall height of the list and invalidate any height caching. Doing this only\non the first item may save the user from experiencing odd scrolling behavior where the\nscrollbar updates while scrolling. If the user uses the mouse to drag the bar, it can become\n\"detached\" since the browser recalculates scroll bar position while the overflow container is\nupdated.",
|
|
44343
|
-
"declarations": [
|
|
44344
|
-
{
|
|
44345
|
-
"name": "updateItemHeight",
|
|
44346
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useBaseListModel.tsx"
|
|
44347
|
-
}
|
|
44348
|
-
],
|
|
44349
|
-
"tags": {}
|
|
44350
|
-
},
|
|
44351
42317
|
{
|
|
44352
42318
|
"kind": "property",
|
|
44353
42319
|
"name": "model",
|
|
@@ -151348,441 +149314,6 @@ export var docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
151348
149314
|
],
|
|
151349
149315
|
"tags": {}
|
|
151350
149316
|
},
|
|
151351
|
-
{
|
|
151352
|
-
"kind": "property",
|
|
151353
|
-
"name": "returnFocusRef",
|
|
151354
|
-
"type": {
|
|
151355
|
-
"kind": "union",
|
|
151356
|
-
"value": [
|
|
151357
|
-
{
|
|
151358
|
-
"kind": "symbol",
|
|
151359
|
-
"name": "RefObject",
|
|
151360
|
-
"typeParameters": [
|
|
151361
|
-
{
|
|
151362
|
-
"kind": "primitive",
|
|
151363
|
-
"value": "any"
|
|
151364
|
-
}
|
|
151365
|
-
],
|
|
151366
|
-
"value": "any"
|
|
151367
|
-
},
|
|
151368
|
-
{
|
|
151369
|
-
"kind": "primitive",
|
|
151370
|
-
"value": "undefined"
|
|
151371
|
-
}
|
|
151372
|
-
]
|
|
151373
|
-
},
|
|
151374
|
-
"required": false,
|
|
151375
|
-
"description": "Optional reference to an element that should receive focus when a popup is hidden. If left\nblank, focus will return to the `targetRef`",
|
|
151376
|
-
"declarations": [
|
|
151377
|
-
{
|
|
151378
|
-
"name": "returnFocusRef",
|
|
151379
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151380
|
-
}
|
|
151381
|
-
],
|
|
151382
|
-
"tags": {}
|
|
151383
|
-
},
|
|
151384
|
-
{
|
|
151385
|
-
"kind": "property",
|
|
151386
|
-
"name": "initialFocusRef",
|
|
151387
|
-
"type": {
|
|
151388
|
-
"kind": "union",
|
|
151389
|
-
"value": [
|
|
151390
|
-
{
|
|
151391
|
-
"kind": "symbol",
|
|
151392
|
-
"name": "RefObject",
|
|
151393
|
-
"typeParameters": [
|
|
151394
|
-
{
|
|
151395
|
-
"kind": "primitive",
|
|
151396
|
-
"value": "any"
|
|
151397
|
-
}
|
|
151398
|
-
],
|
|
151399
|
-
"value": "any"
|
|
151400
|
-
},
|
|
151401
|
-
{
|
|
151402
|
-
"kind": "primitive",
|
|
151403
|
-
"value": "undefined"
|
|
151404
|
-
}
|
|
151405
|
-
]
|
|
151406
|
-
},
|
|
151407
|
-
"required": false,
|
|
151408
|
-
"description": "Optional reference to an element that should receive focus when a popup is shown. If left blank,\nfocus will be moved to the first focusable element inside the popup.",
|
|
151409
|
-
"declarations": [
|
|
151410
|
-
{
|
|
151411
|
-
"name": "initialFocusRef",
|
|
151412
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151413
|
-
}
|
|
151414
|
-
],
|
|
151415
|
-
"tags": {}
|
|
151416
|
-
},
|
|
151417
|
-
{
|
|
151418
|
-
"kind": "property",
|
|
151419
|
-
"name": "id",
|
|
151420
|
-
"type": {
|
|
151421
|
-
"kind": "primitive",
|
|
151422
|
-
"value": "string"
|
|
151423
|
-
},
|
|
151424
|
-
"required": true,
|
|
151425
|
-
"description": "ID reference of the list. Children ids can be derived from this id",
|
|
151426
|
-
"declarations": [
|
|
151427
|
-
{
|
|
151428
|
-
"name": "id",
|
|
151429
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151430
|
-
}
|
|
151431
|
-
],
|
|
151432
|
-
"tags": {}
|
|
151433
|
-
},
|
|
151434
|
-
{
|
|
151435
|
-
"kind": "property",
|
|
151436
|
-
"name": "initialVisibility",
|
|
151437
|
-
"defaultValue": {
|
|
151438
|
-
"kind": "string",
|
|
151439
|
-
"value": "hidden"
|
|
151440
|
-
},
|
|
151441
|
-
"type": {
|
|
151442
|
-
"kind": "symbol",
|
|
151443
|
-
"name": "Visibility",
|
|
151444
|
-
"value": "Visibility"
|
|
151445
|
-
},
|
|
151446
|
-
"required": true,
|
|
151447
|
-
"description": "The initial visibility of the disclosed content",
|
|
151448
|
-
"declarations": [
|
|
151449
|
-
{
|
|
151450
|
-
"name": "initialVisibility",
|
|
151451
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151452
|
-
}
|
|
151453
|
-
],
|
|
151454
|
-
"tags": {
|
|
151455
|
-
"default": "'hidden'"
|
|
151456
|
-
}
|
|
151457
|
-
},
|
|
151458
|
-
{
|
|
151459
|
-
"kind": "property",
|
|
151460
|
-
"name": "updatePlacement",
|
|
151461
|
-
"type": {
|
|
151462
|
-
"kind": "function",
|
|
151463
|
-
"parameters": [
|
|
151464
|
-
{
|
|
151465
|
-
"kind": "parameter",
|
|
151466
|
-
"name": "data",
|
|
151467
|
-
"type": {
|
|
151468
|
-
"kind": "object",
|
|
151469
|
-
"properties": [
|
|
151470
|
-
{
|
|
151471
|
-
"kind": "property",
|
|
151472
|
-
"name": "placement",
|
|
151473
|
-
"required": true,
|
|
151474
|
-
"type": {
|
|
151475
|
-
"kind": "symbol",
|
|
151476
|
-
"name": "Placement",
|
|
151477
|
-
"value": "Placement"
|
|
151478
|
-
},
|
|
151479
|
-
"description": "",
|
|
151480
|
-
"declarations": [
|
|
151481
|
-
{
|
|
151482
|
-
"name": "placement",
|
|
151483
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151484
|
-
}
|
|
151485
|
-
],
|
|
151486
|
-
"tags": {}
|
|
151487
|
-
}
|
|
151488
|
-
]
|
|
151489
|
-
},
|
|
151490
|
-
"required": true,
|
|
151491
|
-
"rest": false,
|
|
151492
|
-
"description": "",
|
|
151493
|
-
"declarations": [
|
|
151494
|
-
{
|
|
151495
|
-
"name": "data",
|
|
151496
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151497
|
-
}
|
|
151498
|
-
],
|
|
151499
|
-
"tags": {}
|
|
151500
|
-
}
|
|
151501
|
-
],
|
|
151502
|
-
"members": [],
|
|
151503
|
-
"returnType": {
|
|
151504
|
-
"kind": "primitive",
|
|
151505
|
-
"value": "void"
|
|
151506
|
-
}
|
|
151507
|
-
},
|
|
151508
|
-
"required": true,
|
|
151509
|
-
"description": "Called whenever a popup placement changes around a target. This is useful for animations that\ndepend on the placement chosen.",
|
|
151510
|
-
"declarations": [
|
|
151511
|
-
{
|
|
151512
|
-
"name": "updatePlacement",
|
|
151513
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151514
|
-
}
|
|
151515
|
-
],
|
|
151516
|
-
"tags": {}
|
|
151517
|
-
},
|
|
151518
|
-
{
|
|
151519
|
-
"kind": "property",
|
|
151520
|
-
"name": "show",
|
|
151521
|
-
"type": {
|
|
151522
|
-
"kind": "function",
|
|
151523
|
-
"parameters": [
|
|
151524
|
-
{
|
|
151525
|
-
"kind": "parameter",
|
|
151526
|
-
"name": "event",
|
|
151527
|
-
"type": {
|
|
151528
|
-
"kind": "union",
|
|
151529
|
-
"value": [
|
|
151530
|
-
{
|
|
151531
|
-
"kind": "external",
|
|
151532
|
-
"name": "Event",
|
|
151533
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
151534
|
-
},
|
|
151535
|
-
{
|
|
151536
|
-
"kind": "external",
|
|
151537
|
-
"name": "SyntheticEvent",
|
|
151538
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
151539
|
-
}
|
|
151540
|
-
]
|
|
151541
|
-
},
|
|
151542
|
-
"required": false,
|
|
151543
|
-
"rest": false,
|
|
151544
|
-
"description": "",
|
|
151545
|
-
"declarations": [
|
|
151546
|
-
{
|
|
151547
|
-
"name": "event",
|
|
151548
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151549
|
-
}
|
|
151550
|
-
],
|
|
151551
|
-
"tags": {}
|
|
151552
|
-
}
|
|
151553
|
-
],
|
|
151554
|
-
"members": [],
|
|
151555
|
-
"returnType": {
|
|
151556
|
-
"kind": "primitive",
|
|
151557
|
-
"value": "void"
|
|
151558
|
-
}
|
|
151559
|
-
},
|
|
151560
|
-
"required": true,
|
|
151561
|
-
"description": "Start showing the disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
151562
|
-
"declarations": [
|
|
151563
|
-
{
|
|
151564
|
-
"name": "show",
|
|
151565
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151566
|
-
}
|
|
151567
|
-
],
|
|
151568
|
-
"tags": {}
|
|
151569
|
-
},
|
|
151570
|
-
{
|
|
151571
|
-
"kind": "property",
|
|
151572
|
-
"name": "hide",
|
|
151573
|
-
"type": {
|
|
151574
|
-
"kind": "function",
|
|
151575
|
-
"parameters": [
|
|
151576
|
-
{
|
|
151577
|
-
"kind": "parameter",
|
|
151578
|
-
"name": "event",
|
|
151579
|
-
"type": {
|
|
151580
|
-
"kind": "union",
|
|
151581
|
-
"value": [
|
|
151582
|
-
{
|
|
151583
|
-
"kind": "external",
|
|
151584
|
-
"name": "Event",
|
|
151585
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
151586
|
-
},
|
|
151587
|
-
{
|
|
151588
|
-
"kind": "external",
|
|
151589
|
-
"name": "SyntheticEvent",
|
|
151590
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
151591
|
-
}
|
|
151592
|
-
]
|
|
151593
|
-
},
|
|
151594
|
-
"required": false,
|
|
151595
|
-
"rest": false,
|
|
151596
|
-
"description": "",
|
|
151597
|
-
"declarations": [
|
|
151598
|
-
{
|
|
151599
|
-
"name": "event",
|
|
151600
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151601
|
-
}
|
|
151602
|
-
],
|
|
151603
|
-
"tags": {}
|
|
151604
|
-
}
|
|
151605
|
-
],
|
|
151606
|
-
"members": [],
|
|
151607
|
-
"returnType": {
|
|
151608
|
-
"kind": "primitive",
|
|
151609
|
-
"value": "void"
|
|
151610
|
-
}
|
|
151611
|
-
},
|
|
151612
|
-
"required": true,
|
|
151613
|
-
"description": "Start hiding this disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
151614
|
-
"declarations": [
|
|
151615
|
-
{
|
|
151616
|
-
"name": "hide",
|
|
151617
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151618
|
-
}
|
|
151619
|
-
],
|
|
151620
|
-
"tags": {}
|
|
151621
|
-
},
|
|
151622
|
-
{
|
|
151623
|
-
"kind": "property",
|
|
151624
|
-
"name": "updatePlacement",
|
|
151625
|
-
"type": {
|
|
151626
|
-
"kind": "function",
|
|
151627
|
-
"parameters": [
|
|
151628
|
-
{
|
|
151629
|
-
"kind": "parameter",
|
|
151630
|
-
"name": "data",
|
|
151631
|
-
"type": {
|
|
151632
|
-
"kind": "object",
|
|
151633
|
-
"properties": [
|
|
151634
|
-
{
|
|
151635
|
-
"kind": "property",
|
|
151636
|
-
"name": "placement",
|
|
151637
|
-
"required": true,
|
|
151638
|
-
"type": {
|
|
151639
|
-
"kind": "symbol",
|
|
151640
|
-
"name": "Placement",
|
|
151641
|
-
"value": "Placement"
|
|
151642
|
-
},
|
|
151643
|
-
"description": "",
|
|
151644
|
-
"declarations": [
|
|
151645
|
-
{
|
|
151646
|
-
"name": "placement",
|
|
151647
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151648
|
-
}
|
|
151649
|
-
],
|
|
151650
|
-
"tags": {}
|
|
151651
|
-
}
|
|
151652
|
-
]
|
|
151653
|
-
},
|
|
151654
|
-
"required": true,
|
|
151655
|
-
"rest": false,
|
|
151656
|
-
"description": "",
|
|
151657
|
-
"declarations": [
|
|
151658
|
-
{
|
|
151659
|
-
"name": "data",
|
|
151660
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151661
|
-
}
|
|
151662
|
-
],
|
|
151663
|
-
"tags": {}
|
|
151664
|
-
}
|
|
151665
|
-
],
|
|
151666
|
-
"members": [],
|
|
151667
|
-
"returnType": {
|
|
151668
|
-
"kind": "primitive",
|
|
151669
|
-
"value": "void"
|
|
151670
|
-
}
|
|
151671
|
-
},
|
|
151672
|
-
"required": true,
|
|
151673
|
-
"description": "Called whenever a popup placement changes around a target. This is useful for animations that\ndepend on the placement chosen.",
|
|
151674
|
-
"declarations": [
|
|
151675
|
-
{
|
|
151676
|
-
"name": "updatePlacement",
|
|
151677
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/popup/lib/hooks/usePopupModel.ts"
|
|
151678
|
-
}
|
|
151679
|
-
],
|
|
151680
|
-
"tags": {}
|
|
151681
|
-
},
|
|
151682
|
-
{
|
|
151683
|
-
"kind": "property",
|
|
151684
|
-
"name": "show",
|
|
151685
|
-
"type": {
|
|
151686
|
-
"kind": "function",
|
|
151687
|
-
"parameters": [
|
|
151688
|
-
{
|
|
151689
|
-
"kind": "parameter",
|
|
151690
|
-
"name": "event",
|
|
151691
|
-
"type": {
|
|
151692
|
-
"kind": "union",
|
|
151693
|
-
"value": [
|
|
151694
|
-
{
|
|
151695
|
-
"kind": "external",
|
|
151696
|
-
"name": "Event",
|
|
151697
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
151698
|
-
},
|
|
151699
|
-
{
|
|
151700
|
-
"kind": "external",
|
|
151701
|
-
"name": "SyntheticEvent",
|
|
151702
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
151703
|
-
}
|
|
151704
|
-
]
|
|
151705
|
-
},
|
|
151706
|
-
"required": false,
|
|
151707
|
-
"rest": false,
|
|
151708
|
-
"description": "",
|
|
151709
|
-
"declarations": [
|
|
151710
|
-
{
|
|
151711
|
-
"name": "event",
|
|
151712
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151713
|
-
}
|
|
151714
|
-
],
|
|
151715
|
-
"tags": {}
|
|
151716
|
-
}
|
|
151717
|
-
],
|
|
151718
|
-
"members": [],
|
|
151719
|
-
"returnType": {
|
|
151720
|
-
"kind": "primitive",
|
|
151721
|
-
"value": "void"
|
|
151722
|
-
}
|
|
151723
|
-
},
|
|
151724
|
-
"required": true,
|
|
151725
|
-
"description": "Start showing the disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
151726
|
-
"declarations": [
|
|
151727
|
-
{
|
|
151728
|
-
"name": "show",
|
|
151729
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151730
|
-
}
|
|
151731
|
-
],
|
|
151732
|
-
"tags": {}
|
|
151733
|
-
},
|
|
151734
|
-
{
|
|
151735
|
-
"kind": "property",
|
|
151736
|
-
"name": "hide",
|
|
151737
|
-
"type": {
|
|
151738
|
-
"kind": "function",
|
|
151739
|
-
"parameters": [
|
|
151740
|
-
{
|
|
151741
|
-
"kind": "parameter",
|
|
151742
|
-
"name": "event",
|
|
151743
|
-
"type": {
|
|
151744
|
-
"kind": "union",
|
|
151745
|
-
"value": [
|
|
151746
|
-
{
|
|
151747
|
-
"kind": "external",
|
|
151748
|
-
"name": "Event",
|
|
151749
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
|
|
151750
|
-
},
|
|
151751
|
-
{
|
|
151752
|
-
"kind": "external",
|
|
151753
|
-
"name": "SyntheticEvent",
|
|
151754
|
-
"url": "https://reactjs.org/docs/events.html"
|
|
151755
|
-
}
|
|
151756
|
-
]
|
|
151757
|
-
},
|
|
151758
|
-
"required": false,
|
|
151759
|
-
"rest": false,
|
|
151760
|
-
"description": "",
|
|
151761
|
-
"declarations": [
|
|
151762
|
-
{
|
|
151763
|
-
"name": "event",
|
|
151764
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151765
|
-
}
|
|
151766
|
-
],
|
|
151767
|
-
"tags": {}
|
|
151768
|
-
}
|
|
151769
|
-
],
|
|
151770
|
-
"members": [],
|
|
151771
|
-
"returnType": {
|
|
151772
|
-
"kind": "primitive",
|
|
151773
|
-
"value": "void"
|
|
151774
|
-
}
|
|
151775
|
-
},
|
|
151776
|
-
"required": true,
|
|
151777
|
-
"description": "Start hiding this disclosed content. If a DOM event triggered this event, the event data will\nbe passed along. This data can be used by guards and callbacks.",
|
|
151778
|
-
"declarations": [
|
|
151779
|
-
{
|
|
151780
|
-
"name": "hide",
|
|
151781
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/disclosure/lib/useDisclosureModel.tsx"
|
|
151782
|
-
}
|
|
151783
|
-
],
|
|
151784
|
-
"tags": {}
|
|
151785
|
-
},
|
|
151786
149317
|
{
|
|
151787
149318
|
"kind": "property",
|
|
151788
149319
|
"name": "model",
|