@workday/canvas-kit-docs 9.0.0-alpha.411-next.13 → 9.0.0-alpha.413-next.15

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.
@@ -10128,6 +10128,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
10128
10128
  ],
10129
10129
  "tags": {}
10130
10130
  },
10131
+ {
10132
+ "kind": "property",
10133
+ "name": "pageSize",
10134
+ "defaultValue": {
10135
+ "kind": "number",
10136
+ "value": 0
10137
+ },
10138
+ "type": {
10139
+ "kind": "primitive",
10140
+ "value": "number"
10141
+ },
10142
+ "required": false,
10143
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
10144
+ "declarations": [
10145
+ {
10146
+ "name": "pageSize",
10147
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
10148
+ }
10149
+ ],
10150
+ "tags": {}
10151
+ },
10131
10152
  {
10132
10153
  "kind": "property",
10133
10154
  "name": "getId",
@@ -10190,7 +10211,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
10190
10211
  }
10191
10212
  },
10192
10213
  "required": false,
10193
- "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.",
10214
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
10194
10215
  "declarations": [
10195
10216
  {
10196
10217
  "name": "getId",
@@ -10261,7 +10282,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
10261
10282
  }
10262
10283
  },
10263
10284
  "required": false,
10264
- "description": "",
10285
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
10265
10286
  "declarations": [
10266
10287
  {
10267
10288
  "name": "getTextValue",
@@ -10506,6 +10527,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
10506
10527
  "private": "Use useGridModel instead to make a grid instead of a list"
10507
10528
  }
10508
10529
  },
10530
+ {
10531
+ "kind": "property",
10532
+ "name": "pageSizeRef",
10533
+ "type": {
10534
+ "kind": "symbol",
10535
+ "name": "MutableRefObject",
10536
+ "value": "MutableRefObject<number>"
10537
+ },
10538
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
10539
+ "declarations": [
10540
+ {
10541
+ "name": "pageSizeRef",
10542
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
10543
+ }
10544
+ ],
10545
+ "tags": {}
10546
+ },
10509
10547
  {
10510
10548
  "kind": "property",
10511
10549
  "name": "UNSTABLE_virtual",
@@ -11796,6 +11834,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
11796
11834
  ],
11797
11835
  "tags": {}
11798
11836
  },
11837
+ {
11838
+ "kind": "property",
11839
+ "name": "pageSize",
11840
+ "defaultValue": {
11841
+ "kind": "number",
11842
+ "value": 0
11843
+ },
11844
+ "type": {
11845
+ "kind": "primitive",
11846
+ "value": "number"
11847
+ },
11848
+ "required": false,
11849
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
11850
+ "declarations": [
11851
+ {
11852
+ "name": "pageSize",
11853
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
11854
+ }
11855
+ ],
11856
+ "tags": {}
11857
+ },
11799
11858
  {
11800
11859
  "kind": "property",
11801
11860
  "name": "getId",
@@ -11858,7 +11917,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
11858
11917
  }
11859
11918
  },
11860
11919
  "required": false,
11861
- "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.",
11920
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
11862
11921
  "declarations": [
11863
11922
  {
11864
11923
  "name": "getId",
@@ -11929,7 +11988,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
11929
11988
  }
11930
11989
  },
11931
11990
  "required": false,
11932
- "description": "",
11991
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
11933
11992
  "declarations": [
11934
11993
  {
11935
11994
  "name": "getTextValue",
@@ -13788,6 +13847,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
13788
13847
  "private": "Use useGridModel instead to make a grid instead of a list"
13789
13848
  }
13790
13849
  },
13850
+ {
13851
+ "kind": "property",
13852
+ "name": "pageSizeRef",
13853
+ "type": {
13854
+ "kind": "symbol",
13855
+ "name": "MutableRefObject",
13856
+ "value": "MutableRefObject<number>"
13857
+ },
13858
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
13859
+ "declarations": [
13860
+ {
13861
+ "name": "pageSizeRef",
13862
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
13863
+ }
13864
+ ],
13865
+ "tags": {}
13866
+ },
13791
13867
  {
13792
13868
  "kind": "property",
13793
13869
  "name": "UNSTABLE_virtual",
@@ -31101,7 +31177,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31101
31177
  "type": {
31102
31178
  "kind": "symbol",
31103
31179
  "name": "Partial",
31104
- "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 12 more ...; items: any[]; }>"
31180
+ "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 13 more ...; items: any[]; }>"
31105
31181
  },
31106
31182
  "required": false,
31107
31183
  "description": "",
@@ -31319,6 +31395,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31319
31395
  ],
31320
31396
  "tags": {}
31321
31397
  },
31398
+ {
31399
+ "kind": "property",
31400
+ "name": "pageSize",
31401
+ "defaultValue": {
31402
+ "kind": "number",
31403
+ "value": 0
31404
+ },
31405
+ "type": {
31406
+ "kind": "primitive",
31407
+ "value": "number"
31408
+ },
31409
+ "required": false,
31410
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
31411
+ "declarations": [
31412
+ {
31413
+ "name": "pageSize",
31414
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
31415
+ }
31416
+ ],
31417
+ "tags": {}
31418
+ },
31322
31419
  {
31323
31420
  "kind": "property",
31324
31421
  "name": "getId",
@@ -31381,7 +31478,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31381
31478
  }
31382
31479
  },
31383
31480
  "required": false,
31384
- "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.",
31481
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
31385
31482
  "declarations": [
31386
31483
  {
31387
31484
  "name": "getId",
@@ -31452,7 +31549,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31452
31549
  }
31453
31550
  },
31454
31551
  "required": false,
31455
- "description": "",
31552
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
31456
31553
  "declarations": [
31457
31554
  {
31458
31555
  "name": "getTextValue",
@@ -31755,6 +31852,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
31755
31852
  "private": "Use useGridModel instead to make a grid instead of a list"
31756
31853
  }
31757
31854
  },
31855
+ {
31856
+ "kind": "property",
31857
+ "name": "pageSizeRef",
31858
+ "type": {
31859
+ "kind": "symbol",
31860
+ "name": "MutableRefObject",
31861
+ "value": "MutableRefObject<number>"
31862
+ },
31863
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
31864
+ "declarations": [
31865
+ {
31866
+ "name": "pageSizeRef",
31867
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
31868
+ }
31869
+ ],
31870
+ "tags": {}
31871
+ },
31758
31872
  {
31759
31873
  "kind": "property",
31760
31874
  "name": "UNSTABLE_virtual",
@@ -33180,7 +33294,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33180
33294
  "type": {
33181
33295
  "kind": "symbol",
33182
33296
  "name": "Partial",
33183
- "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 12 more ...; items: any[]; }>"
33297
+ "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 13 more ...; items: any[]; }>"
33184
33298
  },
33185
33299
  "required": false,
33186
33300
  "description": "",
@@ -33398,6 +33512,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33398
33512
  ],
33399
33513
  "tags": {}
33400
33514
  },
33515
+ {
33516
+ "kind": "property",
33517
+ "name": "pageSize",
33518
+ "defaultValue": {
33519
+ "kind": "number",
33520
+ "value": 0
33521
+ },
33522
+ "type": {
33523
+ "kind": "primitive",
33524
+ "value": "number"
33525
+ },
33526
+ "required": false,
33527
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
33528
+ "declarations": [
33529
+ {
33530
+ "name": "pageSize",
33531
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
33532
+ }
33533
+ ],
33534
+ "tags": {}
33535
+ },
33401
33536
  {
33402
33537
  "kind": "property",
33403
33538
  "name": "getId",
@@ -33460,7 +33595,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33460
33595
  }
33461
33596
  },
33462
33597
  "required": false,
33463
- "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.",
33598
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
33464
33599
  "declarations": [
33465
33600
  {
33466
33601
  "name": "getId",
@@ -33531,7 +33666,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
33531
33666
  }
33532
33667
  },
33533
33668
  "required": false,
33534
- "description": "",
33669
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
33535
33670
  "declarations": [
33536
33671
  {
33537
33672
  "name": "getTextValue",
@@ -36346,6 +36481,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
36346
36481
  "private": "Use useGridModel instead to make a grid instead of a list"
36347
36482
  }
36348
36483
  },
36484
+ {
36485
+ "kind": "property",
36486
+ "name": "pageSizeRef",
36487
+ "type": {
36488
+ "kind": "symbol",
36489
+ "name": "MutableRefObject",
36490
+ "value": "MutableRefObject<number>"
36491
+ },
36492
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
36493
+ "declarations": [
36494
+ {
36495
+ "name": "pageSizeRef",
36496
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
36497
+ }
36498
+ ],
36499
+ "tags": {}
36500
+ },
36349
36501
  {
36350
36502
  "kind": "property",
36351
36503
  "name": "UNSTABLE_virtual",
@@ -41676,7 +41828,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
41676
41828
  {
41677
41829
  "kind": "symbol",
41678
41830
  "name": "BehaviorHook",
41679
- "value": "BehaviorHook<{ state: { hiddenIds: string[]; nonInteractiveIds: string[]; orientation: Orientation; itemWidthCache: Record<string, number>; containerWidth: number; overflowTargetWidth: number; ... 10 more ...; items: Item<...>[]; }; ... 4 more ...; getId: (item: any) => string; }, { ...; } & { ...; }>"
41831
+ "value": "BehaviorHook<{ state: { hiddenIds: string[]; nonInteractiveIds: string[]; orientation: Orientation; itemWidthCache: Record<string, number>; containerWidth: number; overflowTargetWidth: number; ... 11 more ...; items: Item<...>[]; }; ... 4 more ...; getId: (item: any) => string; }, { ...; } & { ...; }>"
41680
41832
  }
41681
41833
  ]
41682
41834
  }
@@ -42334,7 +42486,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42334
42486
  "type": {
42335
42487
  "kind": "symbol",
42336
42488
  "name": "Partial",
42337
- "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 12 more ...; items: any[]; }>"
42489
+ "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 13 more ...; items: any[]; }>"
42338
42490
  },
42339
42491
  "required": false,
42340
42492
  "description": "",
@@ -42552,6 +42704,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42552
42704
  ],
42553
42705
  "tags": {}
42554
42706
  },
42707
+ {
42708
+ "kind": "property",
42709
+ "name": "pageSize",
42710
+ "defaultValue": {
42711
+ "kind": "number",
42712
+ "value": 0
42713
+ },
42714
+ "type": {
42715
+ "kind": "primitive",
42716
+ "value": "number"
42717
+ },
42718
+ "required": false,
42719
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
42720
+ "declarations": [
42721
+ {
42722
+ "name": "pageSize",
42723
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
42724
+ }
42725
+ ],
42726
+ "tags": {}
42727
+ },
42555
42728
  {
42556
42729
  "kind": "property",
42557
42730
  "name": "getId",
@@ -42614,7 +42787,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42614
42787
  }
42615
42788
  },
42616
42789
  "required": false,
42617
- "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.",
42790
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
42618
42791
  "declarations": [
42619
42792
  {
42620
42793
  "name": "getId",
@@ -42685,7 +42858,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42685
42858
  }
42686
42859
  },
42687
42860
  "required": false,
42688
- "description": "",
42861
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
42689
42862
  "declarations": [
42690
42863
  {
42691
42864
  "name": "getTextValue",
@@ -42988,6 +43161,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42988
43161
  "private": "Use useGridModel instead to make a grid instead of a list"
42989
43162
  }
42990
43163
  },
43164
+ {
43165
+ "kind": "property",
43166
+ "name": "pageSizeRef",
43167
+ "type": {
43168
+ "kind": "symbol",
43169
+ "name": "MutableRefObject",
43170
+ "value": "MutableRefObject<number>"
43171
+ },
43172
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
43173
+ "declarations": [
43174
+ {
43175
+ "name": "pageSizeRef",
43176
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
43177
+ }
43178
+ ],
43179
+ "tags": {}
43180
+ },
42991
43181
  {
42992
43182
  "kind": "property",
42993
43183
  "name": "UNSTABLE_virtual",
@@ -44413,7 +44603,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44413
44603
  "type": {
44414
44604
  "kind": "symbol",
44415
44605
  "name": "Partial",
44416
- "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 12 more ...; items: any[]; }>"
44606
+ "value": "Partial<{ mode: \"multiple\" | \"single\"; returnFocusRef: RefObject<any> | undefined; initialFocusRef: RefObject<any> | undefined; id: string; initialVisibility: Visibility; ... 13 more ...; items: any[]; }>"
44417
44607
  },
44418
44608
  "required": false,
44419
44609
  "description": "",
@@ -44631,6 +44821,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44631
44821
  ],
44632
44822
  "tags": {}
44633
44823
  },
44824
+ {
44825
+ "kind": "property",
44826
+ "name": "pageSize",
44827
+ "defaultValue": {
44828
+ "kind": "number",
44829
+ "value": 0
44830
+ },
44831
+ "type": {
44832
+ "kind": "primitive",
44833
+ "value": "number"
44834
+ },
44835
+ "required": false,
44836
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
44837
+ "declarations": [
44838
+ {
44839
+ "name": "pageSize",
44840
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
44841
+ }
44842
+ ],
44843
+ "tags": {}
44844
+ },
44634
44845
  {
44635
44846
  "kind": "property",
44636
44847
  "name": "getId",
@@ -44693,7 +44904,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44693
44904
  }
44694
44905
  },
44695
44906
  "required": false,
44696
- "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.",
44907
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
44697
44908
  "declarations": [
44698
44909
  {
44699
44910
  "name": "getId",
@@ -44764,7 +44975,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
44764
44975
  }
44765
44976
  },
44766
44977
  "required": false,
44767
- "description": "",
44978
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
44768
44979
  "declarations": [
44769
44980
  {
44770
44981
  "name": "getTextValue",
@@ -47579,6 +47790,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
47579
47790
  "private": "Use useGridModel instead to make a grid instead of a list"
47580
47791
  }
47581
47792
  },
47793
+ {
47794
+ "kind": "property",
47795
+ "name": "pageSizeRef",
47796
+ "type": {
47797
+ "kind": "symbol",
47798
+ "name": "MutableRefObject",
47799
+ "value": "MutableRefObject<number>"
47800
+ },
47801
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
47802
+ "declarations": [
47803
+ {
47804
+ "name": "pageSizeRef",
47805
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
47806
+ }
47807
+ ],
47808
+ "tags": {}
47809
+ },
47582
47810
  {
47583
47811
  "kind": "property",
47584
47812
  "name": "UNSTABLE_virtual",
@@ -61728,7 +61956,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
61728
61956
  }
61729
61957
  },
61730
61958
  "required": false,
61731
- "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.",
61959
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
61732
61960
  "declarations": [
61733
61961
  {
61734
61962
  "name": "getId",
@@ -61799,7 +62027,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
61799
62027
  }
61800
62028
  },
61801
62029
  "required": false,
61802
- "description": "",
62030
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
61803
62031
  "declarations": [
61804
62032
  {
61805
62033
  "name": "getTextValue",
@@ -62631,7 +62859,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
62631
62859
  }
62632
62860
  },
62633
62861
  "required": false,
62634
- "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.",
62862
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
62635
62863
  "declarations": [
62636
62864
  {
62637
62865
  "name": "getId",
@@ -62702,7 +62930,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
62702
62930
  }
62703
62931
  },
62704
62932
  "required": false,
62705
- "description": "",
62933
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
62706
62934
  "declarations": [
62707
62935
  {
62708
62936
  "name": "getTextValue",
@@ -63922,9 +64150,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63922
64150
  "name": "getItem",
63923
64151
  "required": true,
63924
64152
  "type": {
63925
- "kind": "symbol",
63926
- "name": "NavigationRequestor",
63927
- "value": "NavigationRequestor"
64153
+ "kind": "function",
64154
+ "parameters": [
64155
+ {
64156
+ "kind": "parameter",
64157
+ "name": "id",
64158
+ "type": {
64159
+ "kind": "primitive",
64160
+ "value": "string"
64161
+ },
64162
+ "required": true,
64163
+ "rest": false,
64164
+ "description": "",
64165
+ "declarations": [
64166
+ {
64167
+ "name": "id",
64168
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64169
+ }
64170
+ ],
64171
+ "tags": {}
64172
+ },
64173
+ {
64174
+ "kind": "parameter",
64175
+ "name": "model",
64176
+ "type": {
64177
+ "kind": "type",
64178
+ "typeParameters": [],
64179
+ "value": {
64180
+ "kind": "symbol",
64181
+ "name": "Pick",
64182
+ "typeParameters": [
64183
+ {
64184
+ "kind": "symbol",
64185
+ "name": "useCursorListModel"
64186
+ },
64187
+ {
64188
+ "kind": "string",
64189
+ "value": "state"
64190
+ }
64191
+ ],
64192
+ "value": "Pick<T, K>"
64193
+ }
64194
+ },
64195
+ "required": true,
64196
+ "rest": false,
64197
+ "description": "",
64198
+ "declarations": [
64199
+ {
64200
+ "name": "model",
64201
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64202
+ }
64203
+ ],
64204
+ "tags": {}
64205
+ }
64206
+ ],
64207
+ "members": [],
64208
+ "returnType": {
64209
+ "kind": "symbol",
64210
+ "name": "Item",
64211
+ "typeParameters": [
64212
+ {
64213
+ "kind": "symbol",
64214
+ "name": "Generic",
64215
+ "value": "any"
64216
+ }
64217
+ ],
64218
+ "value": "Item<T>"
64219
+ }
63928
64220
  },
63929
64221
  "description": "Get an item with the provided `id`.",
63930
64222
  "declarations": [
@@ -64143,17 +64435,17 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64143
64435
  "parameters": [
64144
64436
  {
64145
64437
  "kind": "parameter",
64146
- "name": "id",
64438
+ "name": "index",
64147
64439
  "type": {
64148
64440
  "kind": "primitive",
64149
- "value": "string"
64441
+ "value": "number"
64150
64442
  },
64151
64443
  "required": true,
64152
64444
  "rest": false,
64153
64445
  "description": "",
64154
64446
  "declarations": [
64155
64447
  {
64156
- "name": "id",
64448
+ "name": "index",
64157
64449
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64158
64450
  }
64159
64451
  ],
@@ -64195,16 +64487,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64195
64487
  ],
64196
64488
  "members": [],
64197
64489
  "returnType": {
64198
- "kind": "symbol",
64199
- "name": "Item",
64200
- "typeParameters": [
64201
- {
64202
- "kind": "symbol",
64203
- "name": "Generic",
64204
- "value": "any"
64205
- }
64206
- ],
64207
- "value": "Item<T>"
64490
+ "kind": "primitive",
64491
+ "value": "number"
64208
64492
  }
64209
64493
  }
64210
64494
  }
@@ -64350,17 +64634,17 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64350
64634
  "parameters": [
64351
64635
  {
64352
64636
  "kind": "parameter",
64353
- "name": "id",
64637
+ "name": "index",
64354
64638
  "type": {
64355
64639
  "kind": "primitive",
64356
- "value": "string"
64640
+ "value": "number"
64357
64641
  },
64358
64642
  "required": true,
64359
64643
  "rest": false,
64360
64644
  "description": "",
64361
64645
  "declarations": [
64362
64646
  {
64363
- "name": "id",
64647
+ "name": "index",
64364
64648
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64365
64649
  }
64366
64650
  ],
@@ -64428,16 +64712,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64428
64712
  ],
64429
64713
  "members": [],
64430
64714
  "returnType": {
64431
- "kind": "symbol",
64432
- "name": "Item",
64433
- "typeParameters": [
64434
- {
64435
- "kind": "symbol",
64436
- "name": "Generic",
64437
- "value": "any"
64438
- }
64439
- ],
64440
- "value": "Item<T>"
64715
+ "kind": "primitive",
64716
+ "value": "number"
64441
64717
  }
64442
64718
  }
64443
64719
  }
@@ -64481,17 +64757,17 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64481
64757
  "parameters": [
64482
64758
  {
64483
64759
  "kind": "parameter",
64484
- "name": "id",
64760
+ "name": "index",
64485
64761
  "type": {
64486
64762
  "kind": "primitive",
64487
- "value": "string"
64763
+ "value": "number"
64488
64764
  },
64489
64765
  "required": true,
64490
64766
  "rest": false,
64491
64767
  "description": "",
64492
64768
  "declarations": [
64493
64769
  {
64494
- "name": "id",
64770
+ "name": "index",
64495
64771
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64496
64772
  }
64497
64773
  ],
@@ -64559,16 +64835,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64559
64835
  ],
64560
64836
  "members": [],
64561
64837
  "returnType": {
64562
- "kind": "symbol",
64563
- "name": "Item",
64564
- "typeParameters": [
64565
- {
64566
- "kind": "symbol",
64567
- "name": "Generic",
64568
- "value": "any"
64569
- }
64570
- ],
64571
- "value": "Item<T>"
64838
+ "kind": "primitive",
64839
+ "value": "number"
64572
64840
  }
64573
64841
  }
64574
64842
  }
@@ -64628,9 +64896,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64628
64896
  "name": "getItem",
64629
64897
  "required": true,
64630
64898
  "type": {
64631
- "kind": "symbol",
64632
- "name": "NavigationRequestor",
64633
- "value": "NavigationRequestor"
64899
+ "kind": "function",
64900
+ "parameters": [
64901
+ {
64902
+ "kind": "parameter",
64903
+ "name": "id",
64904
+ "type": {
64905
+ "kind": "primitive",
64906
+ "value": "string"
64907
+ },
64908
+ "required": true,
64909
+ "rest": false,
64910
+ "description": "",
64911
+ "declarations": [
64912
+ {
64913
+ "name": "id",
64914
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64915
+ }
64916
+ ],
64917
+ "tags": {}
64918
+ },
64919
+ {
64920
+ "kind": "parameter",
64921
+ "name": "model",
64922
+ "type": {
64923
+ "kind": "type",
64924
+ "typeParameters": [],
64925
+ "value": {
64926
+ "kind": "symbol",
64927
+ "name": "Pick",
64928
+ "typeParameters": [
64929
+ {
64930
+ "kind": "symbol",
64931
+ "name": "useCursorListModel"
64932
+ },
64933
+ {
64934
+ "kind": "string",
64935
+ "value": "state"
64936
+ }
64937
+ ],
64938
+ "value": "Pick<T, K>"
64939
+ }
64940
+ },
64941
+ "required": true,
64942
+ "rest": false,
64943
+ "description": "",
64944
+ "declarations": [
64945
+ {
64946
+ "name": "model",
64947
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
64948
+ }
64949
+ ],
64950
+ "tags": {}
64951
+ }
64952
+ ],
64953
+ "members": [],
64954
+ "returnType": {
64955
+ "kind": "symbol",
64956
+ "name": "Item",
64957
+ "typeParameters": [
64958
+ {
64959
+ "kind": "symbol",
64960
+ "name": "Generic",
64961
+ "value": "any"
64962
+ }
64963
+ ],
64964
+ "value": "Item<T>"
64965
+ }
64634
64966
  },
64635
64967
  "description": "Get an item with the provided `id`.",
64636
64968
  "declarations": [
@@ -64843,9 +65175,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64843
65175
  "name": "getItem",
64844
65176
  "required": true,
64845
65177
  "type": {
64846
- "kind": "symbol",
64847
- "name": "NavigationRequestor",
64848
- "value": "NavigationRequestor"
65178
+ "kind": "function",
65179
+ "parameters": [
65180
+ {
65181
+ "kind": "parameter",
65182
+ "name": "id",
65183
+ "type": {
65184
+ "kind": "primitive",
65185
+ "value": "string"
65186
+ },
65187
+ "required": true,
65188
+ "rest": false,
65189
+ "description": "",
65190
+ "declarations": [
65191
+ {
65192
+ "name": "id",
65193
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
65194
+ }
65195
+ ],
65196
+ "tags": {}
65197
+ },
65198
+ {
65199
+ "kind": "parameter",
65200
+ "name": "model",
65201
+ "type": {
65202
+ "kind": "type",
65203
+ "typeParameters": [],
65204
+ "value": {
65205
+ "kind": "symbol",
65206
+ "name": "Pick",
65207
+ "typeParameters": [
65208
+ {
65209
+ "kind": "symbol",
65210
+ "name": "useCursorListModel"
65211
+ },
65212
+ {
65213
+ "kind": "string",
65214
+ "value": "state"
65215
+ }
65216
+ ],
65217
+ "value": "Pick<T, K>"
65218
+ }
65219
+ },
65220
+ "required": true,
65221
+ "rest": false,
65222
+ "description": "",
65223
+ "declarations": [
65224
+ {
65225
+ "name": "model",
65226
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
65227
+ }
65228
+ ],
65229
+ "tags": {}
65230
+ }
65231
+ ],
65232
+ "members": [],
65233
+ "returnType": {
65234
+ "kind": "symbol",
65235
+ "name": "Item",
65236
+ "typeParameters": [
65237
+ {
65238
+ "kind": "symbol",
65239
+ "name": "Generic",
65240
+ "value": "any"
65241
+ }
65242
+ ],
65243
+ "value": "Item<T>"
65244
+ }
64849
65245
  },
64850
65246
  "description": "Get an item with the provided `id`.",
64851
65247
  "declarations": [
@@ -65086,6 +65482,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
65086
65482
  ],
65087
65483
  "tags": {}
65088
65484
  },
65485
+ {
65486
+ "kind": "property",
65487
+ "name": "pageSize",
65488
+ "defaultValue": {
65489
+ "kind": "number",
65490
+ "value": 0
65491
+ },
65492
+ "type": {
65493
+ "kind": "primitive",
65494
+ "value": "number"
65495
+ },
65496
+ "required": false,
65497
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
65498
+ "declarations": [
65499
+ {
65500
+ "name": "pageSize",
65501
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
65502
+ }
65503
+ ],
65504
+ "tags": {}
65505
+ },
65089
65506
  {
65090
65507
  "kind": "property",
65091
65508
  "name": "id",
@@ -65169,7 +65586,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
65169
65586
  }
65170
65587
  },
65171
65588
  "required": false,
65172
- "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.",
65589
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
65173
65590
  "declarations": [
65174
65591
  {
65175
65592
  "name": "getId",
@@ -65240,7 +65657,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
65240
65657
  }
65241
65658
  },
65242
65659
  "required": false,
65243
- "description": "",
65660
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
65244
65661
  "declarations": [
65245
65662
  {
65246
65663
  "name": "getTextValue",
@@ -65415,6 +65832,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
65415
65832
  "private": "Use useGridModel instead to make a grid instead of a list"
65416
65833
  }
65417
65834
  },
65835
+ {
65836
+ "kind": "property",
65837
+ "name": "pageSizeRef",
65838
+ "type": {
65839
+ "kind": "symbol",
65840
+ "name": "MutableRefObject",
65841
+ "value": "MutableRefObject<number>"
65842
+ },
65843
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
65844
+ "declarations": [
65845
+ {
65846
+ "name": "pageSizeRef",
65847
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
65848
+ }
65849
+ ],
65850
+ "tags": {}
65851
+ },
65418
65852
  {
65419
65853
  "kind": "property",
65420
65854
  "name": "UNSTABLE_virtual",
@@ -66388,6 +66822,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
66388
66822
  ],
66389
66823
  "tags": {}
66390
66824
  },
66825
+ {
66826
+ "kind": "property",
66827
+ "name": "pageSize",
66828
+ "defaultValue": {
66829
+ "kind": "number",
66830
+ "value": 0
66831
+ },
66832
+ "type": {
66833
+ "kind": "primitive",
66834
+ "value": "number"
66835
+ },
66836
+ "required": false,
66837
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
66838
+ "declarations": [
66839
+ {
66840
+ "name": "pageSize",
66841
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
66842
+ }
66843
+ ],
66844
+ "tags": {}
66845
+ },
66391
66846
  {
66392
66847
  "kind": "property",
66393
66848
  "name": "id",
@@ -66471,7 +66926,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
66471
66926
  }
66472
66927
  },
66473
66928
  "required": false,
66474
- "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.",
66929
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
66475
66930
  "declarations": [
66476
66931
  {
66477
66932
  "name": "getId",
@@ -66542,7 +66997,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
66542
66997
  }
66543
66998
  },
66544
66999
  "required": false,
66545
- "description": "",
67000
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
66546
67001
  "declarations": [
66547
67002
  {
66548
67003
  "name": "getTextValue",
@@ -68043,6 +68498,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
68043
68498
  "private": "Use useGridModel instead to make a grid instead of a list"
68044
68499
  }
68045
68500
  },
68501
+ {
68502
+ "kind": "property",
68503
+ "name": "pageSizeRef",
68504
+ "type": {
68505
+ "kind": "symbol",
68506
+ "name": "MutableRefObject",
68507
+ "value": "MutableRefObject<number>"
68508
+ },
68509
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
68510
+ "declarations": [
68511
+ {
68512
+ "name": "pageSizeRef",
68513
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68514
+ }
68515
+ ],
68516
+ "tags": {}
68517
+ },
68046
68518
  {
68047
68519
  "kind": "property",
68048
68520
  "name": "UNSTABLE_virtual",
@@ -69014,6 +69486,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
69014
69486
  ],
69015
69487
  "tags": {}
69016
69488
  },
69489
+ {
69490
+ "kind": "property",
69491
+ "name": "pageSize",
69492
+ "defaultValue": {
69493
+ "kind": "number",
69494
+ "value": 0
69495
+ },
69496
+ "type": {
69497
+ "kind": "primitive",
69498
+ "value": "number"
69499
+ },
69500
+ "required": false,
69501
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
69502
+ "declarations": [
69503
+ {
69504
+ "name": "pageSize",
69505
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
69506
+ }
69507
+ ],
69508
+ "tags": {}
69509
+ },
69017
69510
  {
69018
69511
  "kind": "property",
69019
69512
  "name": "id",
@@ -69097,7 +69590,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
69097
69590
  }
69098
69591
  },
69099
69592
  "required": false,
69100
- "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.",
69593
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
69101
69594
  "declarations": [
69102
69595
  {
69103
69596
  "name": "getId",
@@ -69168,7 +69661,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
69168
69661
  }
69169
69662
  },
69170
69663
  "required": false,
69171
- "description": "",
69664
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
69172
69665
  "declarations": [
69173
69666
  {
69174
69667
  "name": "getTextValue",
@@ -69388,6 +69881,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
69388
69881
  "private": "Use useGridModel instead to make a grid instead of a list"
69389
69882
  }
69390
69883
  },
69884
+ {
69885
+ "kind": "property",
69886
+ "name": "pageSizeRef",
69887
+ "type": {
69888
+ "kind": "symbol",
69889
+ "name": "MutableRefObject",
69890
+ "value": "MutableRefObject<number>"
69891
+ },
69892
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
69893
+ "declarations": [
69894
+ {
69895
+ "name": "pageSizeRef",
69896
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
69897
+ }
69898
+ ],
69899
+ "tags": {}
69900
+ },
69391
69901
  {
69392
69902
  "kind": "property",
69393
69903
  "name": "UNSTABLE_virtual",
@@ -70528,6 +71038,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
70528
71038
  ],
70529
71039
  "tags": {}
70530
71040
  },
71041
+ {
71042
+ "kind": "property",
71043
+ "name": "pageSize",
71044
+ "defaultValue": {
71045
+ "kind": "number",
71046
+ "value": 0
71047
+ },
71048
+ "type": {
71049
+ "kind": "primitive",
71050
+ "value": "number"
71051
+ },
71052
+ "required": false,
71053
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
71054
+ "declarations": [
71055
+ {
71056
+ "name": "pageSize",
71057
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
71058
+ }
71059
+ ],
71060
+ "tags": {}
71061
+ },
70531
71062
  {
70532
71063
  "kind": "property",
70533
71064
  "name": "id",
@@ -70611,7 +71142,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
70611
71142
  }
70612
71143
  },
70613
71144
  "required": false,
70614
- "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.",
71145
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
70615
71146
  "declarations": [
70616
71147
  {
70617
71148
  "name": "getId",
@@ -70682,7 +71213,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
70682
71213
  }
70683
71214
  },
70684
71215
  "required": false,
70685
- "description": "",
71216
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
70686
71217
  "declarations": [
70687
71218
  {
70688
71219
  "name": "getTextValue",
@@ -72515,6 +73046,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
72515
73046
  "private": "Use useGridModel instead to make a grid instead of a list"
72516
73047
  }
72517
73048
  },
73049
+ {
73050
+ "kind": "property",
73051
+ "name": "pageSizeRef",
73052
+ "type": {
73053
+ "kind": "symbol",
73054
+ "name": "MutableRefObject",
73055
+ "value": "MutableRefObject<number>"
73056
+ },
73057
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
73058
+ "declarations": [
73059
+ {
73060
+ "name": "pageSizeRef",
73061
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
73062
+ }
73063
+ ],
73064
+ "tags": {}
73065
+ },
72518
73066
  {
72519
73067
  "kind": "property",
72520
73068
  "name": "UNSTABLE_virtual",
@@ -74390,6 +74938,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
74390
74938
  ],
74391
74939
  "tags": {}
74392
74940
  },
74941
+ {
74942
+ "kind": "property",
74943
+ "name": "pageSize",
74944
+ "defaultValue": {
74945
+ "kind": "number",
74946
+ "value": 0
74947
+ },
74948
+ "type": {
74949
+ "kind": "primitive",
74950
+ "value": "number"
74951
+ },
74952
+ "required": false,
74953
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
74954
+ "declarations": [
74955
+ {
74956
+ "name": "pageSize",
74957
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
74958
+ }
74959
+ ],
74960
+ "tags": {}
74961
+ },
74393
74962
  {
74394
74963
  "kind": "property",
74395
74964
  "name": "id",
@@ -74473,7 +75042,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
74473
75042
  }
74474
75043
  },
74475
75044
  "required": false,
74476
- "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.",
75045
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
74477
75046
  "declarations": [
74478
75047
  {
74479
75048
  "name": "getId",
@@ -74544,7 +75113,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
74544
75113
  }
74545
75114
  },
74546
75115
  "required": false,
74547
- "description": "",
75116
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
74548
75117
  "declarations": [
74549
75118
  {
74550
75119
  "name": "getTextValue",
@@ -74766,6 +75335,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
74766
75335
  "private": "Use useGridModel instead to make a grid instead of a list"
74767
75336
  }
74768
75337
  },
75338
+ {
75339
+ "kind": "property",
75340
+ "name": "pageSizeRef",
75341
+ "type": {
75342
+ "kind": "symbol",
75343
+ "name": "MutableRefObject",
75344
+ "value": "MutableRefObject<number>"
75345
+ },
75346
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
75347
+ "declarations": [
75348
+ {
75349
+ "name": "pageSizeRef",
75350
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
75351
+ }
75352
+ ],
75353
+ "tags": {}
75354
+ },
74769
75355
  {
74770
75356
  "kind": "property",
74771
75357
  "name": "UNSTABLE_virtual",
@@ -75929,6 +76515,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
75929
76515
  ],
75930
76516
  "tags": {}
75931
76517
  },
76518
+ {
76519
+ "kind": "property",
76520
+ "name": "pageSize",
76521
+ "defaultValue": {
76522
+ "kind": "number",
76523
+ "value": 0
76524
+ },
76525
+ "type": {
76526
+ "kind": "primitive",
76527
+ "value": "number"
76528
+ },
76529
+ "required": false,
76530
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
76531
+ "declarations": [
76532
+ {
76533
+ "name": "pageSize",
76534
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
76535
+ }
76536
+ ],
76537
+ "tags": {}
76538
+ },
75932
76539
  {
75933
76540
  "kind": "property",
75934
76541
  "name": "id",
@@ -76012,7 +76619,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
76012
76619
  }
76013
76620
  },
76014
76621
  "required": false,
76015
- "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.",
76622
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
76016
76623
  "declarations": [
76017
76624
  {
76018
76625
  "name": "getId",
@@ -76083,7 +76690,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
76083
76690
  }
76084
76691
  },
76085
76692
  "required": false,
76086
- "description": "",
76693
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
76087
76694
  "declarations": [
76088
76695
  {
76089
76696
  "name": "getTextValue",
@@ -77919,6 +78526,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
77919
78526
  "private": "Use useGridModel instead to make a grid instead of a list"
77920
78527
  }
77921
78528
  },
78529
+ {
78530
+ "kind": "property",
78531
+ "name": "pageSizeRef",
78532
+ "type": {
78533
+ "kind": "symbol",
78534
+ "name": "MutableRefObject",
78535
+ "value": "MutableRefObject<number>"
78536
+ },
78537
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
78538
+ "declarations": [
78539
+ {
78540
+ "name": "pageSizeRef",
78541
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
78542
+ }
78543
+ ],
78544
+ "tags": {}
78545
+ },
77922
78546
  {
77923
78547
  "kind": "property",
77924
78548
  "name": "UNSTABLE_virtual",
@@ -80248,6 +80872,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
80248
80872
  ],
80249
80873
  "tags": {}
80250
80874
  },
80875
+ {
80876
+ "kind": "property",
80877
+ "name": "pageSize",
80878
+ "defaultValue": {
80879
+ "kind": "number",
80880
+ "value": 0
80881
+ },
80882
+ "type": {
80883
+ "kind": "primitive",
80884
+ "value": "number"
80885
+ },
80886
+ "required": false,
80887
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
80888
+ "declarations": [
80889
+ {
80890
+ "name": "pageSize",
80891
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
80892
+ }
80893
+ ],
80894
+ "tags": {}
80895
+ },
80251
80896
  {
80252
80897
  "kind": "property",
80253
80898
  "name": "id",
@@ -80331,7 +80976,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
80331
80976
  }
80332
80977
  },
80333
80978
  "required": false,
80334
- "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.",
80979
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
80335
80980
  "declarations": [
80336
80981
  {
80337
80982
  "name": "getId",
@@ -80402,7 +81047,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
80402
81047
  }
80403
81048
  },
80404
81049
  "required": false,
80405
- "description": "",
81050
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
80406
81051
  "declarations": [
80407
81052
  {
80408
81053
  "name": "getTextValue",
@@ -80693,6 +81338,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
80693
81338
  "private": "Use useGridModel instead to make a grid instead of a list"
80694
81339
  }
80695
81340
  },
81341
+ {
81342
+ "kind": "property",
81343
+ "name": "pageSizeRef",
81344
+ "type": {
81345
+ "kind": "symbol",
81346
+ "name": "MutableRefObject",
81347
+ "value": "MutableRefObject<number>"
81348
+ },
81349
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
81350
+ "declarations": [
81351
+ {
81352
+ "name": "pageSizeRef",
81353
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
81354
+ }
81355
+ ],
81356
+ "tags": {}
81357
+ },
80696
81358
  {
80697
81359
  "kind": "property",
80698
81360
  "name": "UNSTABLE_virtual",
@@ -82295,6 +82957,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
82295
82957
  ],
82296
82958
  "tags": {}
82297
82959
  },
82960
+ {
82961
+ "kind": "property",
82962
+ "name": "pageSize",
82963
+ "defaultValue": {
82964
+ "kind": "number",
82965
+ "value": 0
82966
+ },
82967
+ "type": {
82968
+ "kind": "primitive",
82969
+ "value": "number"
82970
+ },
82971
+ "required": false,
82972
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
82973
+ "declarations": [
82974
+ {
82975
+ "name": "pageSize",
82976
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
82977
+ }
82978
+ ],
82979
+ "tags": {}
82980
+ },
82298
82981
  {
82299
82982
  "kind": "property",
82300
82983
  "name": "id",
@@ -82378,7 +83061,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
82378
83061
  }
82379
83062
  },
82380
83063
  "required": false,
82381
- "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.",
83064
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
82382
83065
  "declarations": [
82383
83066
  {
82384
83067
  "name": "getId",
@@ -82449,7 +83132,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
82449
83132
  }
82450
83133
  },
82451
83134
  "required": false,
82452
- "description": "",
83135
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
82453
83136
  "declarations": [
82454
83137
  {
82455
83138
  "name": "getTextValue",
@@ -85252,6 +85935,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
85252
85935
  "private": "Use useGridModel instead to make a grid instead of a list"
85253
85936
  }
85254
85937
  },
85938
+ {
85939
+ "kind": "property",
85940
+ "name": "pageSizeRef",
85941
+ "type": {
85942
+ "kind": "symbol",
85943
+ "name": "MutableRefObject",
85944
+ "value": "MutableRefObject<number>"
85945
+ },
85946
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
85947
+ "declarations": [
85948
+ {
85949
+ "name": "pageSizeRef",
85950
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
85951
+ }
85952
+ ],
85953
+ "tags": {}
85954
+ },
85255
85955
  {
85256
85956
  "kind": "property",
85257
85957
  "name": "UNSTABLE_virtual",
@@ -87122,6 +87822,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
87122
87822
  ],
87123
87823
  "tags": {}
87124
87824
  },
87825
+ {
87826
+ "kind": "property",
87827
+ "name": "pageSize",
87828
+ "defaultValue": {
87829
+ "kind": "number",
87830
+ "value": 0
87831
+ },
87832
+ "type": {
87833
+ "kind": "primitive",
87834
+ "value": "number"
87835
+ },
87836
+ "required": false,
87837
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
87838
+ "declarations": [
87839
+ {
87840
+ "name": "pageSize",
87841
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
87842
+ }
87843
+ ],
87844
+ "tags": {}
87845
+ },
87125
87846
  {
87126
87847
  "kind": "property",
87127
87848
  "name": "id",
@@ -87205,7 +87926,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
87205
87926
  }
87206
87927
  },
87207
87928
  "required": false,
87208
- "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.",
87929
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
87209
87930
  "declarations": [
87210
87931
  {
87211
87932
  "name": "getId",
@@ -87276,7 +87997,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
87276
87997
  }
87277
87998
  },
87278
87999
  "required": false,
87279
- "description": "",
88000
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
87280
88001
  "declarations": [
87281
88002
  {
87282
88003
  "name": "getTextValue",
@@ -87498,6 +88219,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
87498
88219
  "private": "Use useGridModel instead to make a grid instead of a list"
87499
88220
  }
87500
88221
  },
88222
+ {
88223
+ "kind": "property",
88224
+ "name": "pageSizeRef",
88225
+ "type": {
88226
+ "kind": "symbol",
88227
+ "name": "MutableRefObject",
88228
+ "value": "MutableRefObject<number>"
88229
+ },
88230
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
88231
+ "declarations": [
88232
+ {
88233
+ "name": "pageSizeRef",
88234
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
88235
+ }
88236
+ ],
88237
+ "tags": {}
88238
+ },
87501
88239
  {
87502
88240
  "kind": "property",
87503
88241
  "name": "UNSTABLE_virtual",
@@ -88661,6 +89399,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
88661
89399
  ],
88662
89400
  "tags": {}
88663
89401
  },
89402
+ {
89403
+ "kind": "property",
89404
+ "name": "pageSize",
89405
+ "defaultValue": {
89406
+ "kind": "number",
89407
+ "value": 0
89408
+ },
89409
+ "type": {
89410
+ "kind": "primitive",
89411
+ "value": "number"
89412
+ },
89413
+ "required": false,
89414
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
89415
+ "declarations": [
89416
+ {
89417
+ "name": "pageSize",
89418
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
89419
+ }
89420
+ ],
89421
+ "tags": {}
89422
+ },
88664
89423
  {
88665
89424
  "kind": "property",
88666
89425
  "name": "id",
@@ -88744,7 +89503,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
88744
89503
  }
88745
89504
  },
88746
89505
  "required": false,
88747
- "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.",
89506
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
88748
89507
  "declarations": [
88749
89508
  {
88750
89509
  "name": "getId",
@@ -88815,7 +89574,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
88815
89574
  }
88816
89575
  },
88817
89576
  "required": false,
88818
- "description": "",
89577
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
88819
89578
  "declarations": [
88820
89579
  {
88821
89580
  "name": "getTextValue",
@@ -90651,6 +91410,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
90651
91410
  "private": "Use useGridModel instead to make a grid instead of a list"
90652
91411
  }
90653
91412
  },
91413
+ {
91414
+ "kind": "property",
91415
+ "name": "pageSizeRef",
91416
+ "type": {
91417
+ "kind": "symbol",
91418
+ "name": "MutableRefObject",
91419
+ "value": "MutableRefObject<number>"
91420
+ },
91421
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
91422
+ "declarations": [
91423
+ {
91424
+ "name": "pageSizeRef",
91425
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
91426
+ }
91427
+ ],
91428
+ "tags": {}
91429
+ },
90654
91430
  {
90655
91431
  "kind": "property",
90656
91432
  "name": "UNSTABLE_virtual",
@@ -105866,7 +106642,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
105866
106642
  {
105867
106643
  "name": "Dialog",
105868
106644
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/dialog/lib/Dialog.tsx",
105869
- "description": "",
106645
+ "description": "This component is the container component and does not render any semantic elements. It provides\na React Context model for the `Dialog` subcomponents. If you manually pass a `model` to all\nsubcomponents, this container component isn't needed. If you do not pass a `model`, the `Dialog`\ncontainer component will build a default one using `useDialogModel`. `Dialog` is a composition of a\n{@link Popup} component and has a similar structure to `Popup`.",
105870
106646
  "declarations": [
105871
106647
  {
105872
106648
  "name": "Dialog",
@@ -105936,7 +106712,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
105936
106712
  {
105937
106713
  "name": "Card",
105938
106714
  "symbol": "DialogCard",
105939
- "description": "",
106715
+ "description": "A `Dialog.Card` is a wrapper around the {@link Card} component, but hooked up to a\n{@link DialogModel}. By default, this element has a `role=dialog`, `aria-labelledby` and an `id`.\nThe behavior hook used is called {@link useDialogCard}.",
105940
106716
  "declarations": [
105941
106717
  {
105942
106718
  "name": "Card",
@@ -105948,7 +106724,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
105948
106724
  {
105949
106725
  "name": "Popper",
105950
106726
  "symbol": "DialogPopper",
105951
- "description": "",
106727
+ "description": "A `Dialog.Popper` is a wrapper around {@link PopupPopper Popup.Popper}. The behavior\nhook used is called {@link useDialogPopper}.",
105952
106728
  "declarations": [
105953
106729
  {
105954
106730
  "name": "Popper",
@@ -136931,6 +137707,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
136931
137707
  ],
136932
137708
  "tags": {}
136933
137709
  },
137710
+ {
137711
+ "kind": "property",
137712
+ "name": "pageSize",
137713
+ "defaultValue": {
137714
+ "kind": "number",
137715
+ "value": 0
137716
+ },
137717
+ "type": {
137718
+ "kind": "primitive",
137719
+ "value": "number"
137720
+ },
137721
+ "required": false,
137722
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
137723
+ "declarations": [
137724
+ {
137725
+ "name": "pageSize",
137726
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
137727
+ }
137728
+ ],
137729
+ "tags": {}
137730
+ },
136934
137731
  {
136935
137732
  "kind": "property",
136936
137733
  "name": "getId",
@@ -136993,7 +137790,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
136993
137790
  }
136994
137791
  },
136995
137792
  "required": false,
136996
- "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.",
137793
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
136997
137794
  "declarations": [
136998
137795
  {
136999
137796
  "name": "getId",
@@ -137064,7 +137861,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
137064
137861
  }
137065
137862
  },
137066
137863
  "required": false,
137067
- "description": "",
137864
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
137068
137865
  "declarations": [
137069
137866
  {
137070
137867
  "name": "getTextValue",
@@ -137446,6 +138243,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
137446
138243
  "private": "Use useGridModel instead to make a grid instead of a list"
137447
138244
  }
137448
138245
  },
138246
+ {
138247
+ "kind": "property",
138248
+ "name": "pageSizeRef",
138249
+ "type": {
138250
+ "kind": "symbol",
138251
+ "name": "MutableRefObject",
138252
+ "value": "MutableRefObject<number>"
138253
+ },
138254
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
138255
+ "declarations": [
138256
+ {
138257
+ "name": "pageSizeRef",
138258
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
138259
+ }
138260
+ ],
138261
+ "tags": {}
138262
+ },
137449
138263
  {
137450
138264
  "kind": "property",
137451
138265
  "name": "UNSTABLE_virtual",
@@ -138932,6 +139746,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
138932
139746
  ],
138933
139747
  "tags": {}
138934
139748
  },
139749
+ {
139750
+ "kind": "property",
139751
+ "name": "pageSize",
139752
+ "defaultValue": {
139753
+ "kind": "number",
139754
+ "value": 0
139755
+ },
139756
+ "type": {
139757
+ "kind": "primitive",
139758
+ "value": "number"
139759
+ },
139760
+ "required": false,
139761
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
139762
+ "declarations": [
139763
+ {
139764
+ "name": "pageSize",
139765
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
139766
+ }
139767
+ ],
139768
+ "tags": {}
139769
+ },
138935
139770
  {
138936
139771
  "kind": "property",
138937
139772
  "name": "getId",
@@ -138994,7 +139829,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
138994
139829
  }
138995
139830
  },
138996
139831
  "required": false,
138997
- "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.",
139832
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
138998
139833
  "declarations": [
138999
139834
  {
139000
139835
  "name": "getId",
@@ -139065,7 +139900,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
139065
139900
  }
139066
139901
  },
139067
139902
  "required": false,
139068
- "description": "",
139903
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
139069
139904
  "declarations": [
139070
139905
  {
139071
139906
  "name": "getTextValue",
@@ -141467,6 +142302,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
141467
142302
  "private": "Use useGridModel instead to make a grid instead of a list"
141468
142303
  }
141469
142304
  },
142305
+ {
142306
+ "kind": "property",
142307
+ "name": "pageSizeRef",
142308
+ "type": {
142309
+ "kind": "symbol",
142310
+ "name": "MutableRefObject",
142311
+ "value": "MutableRefObject<number>"
142312
+ },
142313
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
142314
+ "declarations": [
142315
+ {
142316
+ "name": "pageSizeRef",
142317
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
142318
+ }
142319
+ ],
142320
+ "tags": {}
142321
+ },
141470
142322
  {
141471
142323
  "kind": "property",
141472
142324
  "name": "UNSTABLE_virtual",
@@ -168523,7 +169375,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
168523
169375
  {
168524
169376
  "name": "Target",
168525
169377
  "symbol": "PopupTarget",
168526
- "description": "A `Popup.Target` is any element that is meant to show the Popup. The default component\nrendered by this component is a {@link SecondaryButton} element. You can override this by\npassing the desired component via `as`. Many examples above use `as={DeleteButton}`. If you\nwant to render a {@link TertiaryButton} instead, use `as={TertiaryButton}`. The behavior hook\nused is called {@link usePopupTarget}.\n\n```tsx\nconst model = usePopupModel();\n\n// using this component\n<Popup.Target>Show Popup</PopupTarget>\n\n// using props instead\nconst popupTargetButtonProps = usePopupTarget(model);\n<SecondaryButton {...popupTargetButtonProps}>Show Popup</SecondaryButton>\n```\n\n`Popup.Target` doesn't provide any styling by default. All styling comes from the default\ncomponent used, which is {@link SecondaryButton}. If you don't want any styling, you can do\nthe following:\n\n```tsx\n<Popup.Target as=\"button\">Open</Popup.Target>\n```\n\nTo add your own styling, you could either add a `css` prop, or make a styled button and pass\nthat styled component via the `as` prop.",
169378
+ "description": "A `Popup.Target` is any element that is meant to show the Popup. The default component\nrendered by this component is a {@link SecondaryButton} element. You can override this by\npassing the desired component via `as`. Many examples above use `as={DeleteButton}`. If you\nwant to render a {@link TertiaryButton} instead, use `as={TertiaryButton}`. The behavior hook\nused is called {@link usePopupTarget}.\n\n```tsx\nconst model = usePopupModel();\n\n// using this component\n<Popup.Target>Show Popup</Popup.Target>\n\n// using props instead\nconst popupTargetButtonProps = usePopupTarget(model);\n<SecondaryButton {...popupTargetButtonProps}>Show Popup</SecondaryButton>\n```\n\n`Popup.Target` doesn't provide any styling by default. All styling comes from the default\ncomponent used, which is {@link SecondaryButton}. If you don't want any styling, you can do\nthe following:\n\n```tsx\n<Popup.Target as=\"button\">Open</Popup.Target>\n```\n\nTo add your own styling, you could either add a `css` prop, or make a styled button and pass\nthat styled component via the `as` prop.",
168527
169379
  "declarations": [
168528
169380
  {
168529
169381
  "name": "Target",
@@ -185944,6 +186796,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
185944
186796
  ],
185945
186797
  "tags": {}
185946
186798
  },
186799
+ {
186800
+ "kind": "property",
186801
+ "name": "pageSize",
186802
+ "defaultValue": {
186803
+ "kind": "number",
186804
+ "value": 0
186805
+ },
186806
+ "type": {
186807
+ "kind": "primitive",
186808
+ "value": "number"
186809
+ },
186810
+ "required": false,
186811
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
186812
+ "declarations": [
186813
+ {
186814
+ "name": "pageSize",
186815
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
186816
+ }
186817
+ ],
186818
+ "tags": {}
186819
+ },
185947
186820
  {
185948
186821
  "kind": "property",
185949
186822
  "name": "getId",
@@ -186006,7 +186879,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
186006
186879
  }
186007
186880
  },
186008
186881
  "required": false,
186009
- "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.",
186882
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
186010
186883
  "declarations": [
186011
186884
  {
186012
186885
  "name": "getId",
@@ -186077,7 +186950,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
186077
186950
  }
186078
186951
  },
186079
186952
  "required": false,
186080
- "description": "",
186953
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
186081
186954
  "declarations": [
186082
186955
  {
186083
186956
  "name": "getTextValue",
@@ -186448,6 +187321,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
186448
187321
  "private": "Use useGridModel instead to make a grid instead of a list"
186449
187322
  }
186450
187323
  },
187324
+ {
187325
+ "kind": "property",
187326
+ "name": "pageSizeRef",
187327
+ "type": {
187328
+ "kind": "symbol",
187329
+ "name": "MutableRefObject",
187330
+ "value": "MutableRefObject<number>"
187331
+ },
187332
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
187333
+ "declarations": [
187334
+ {
187335
+ "name": "pageSizeRef",
187336
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
187337
+ }
187338
+ ],
187339
+ "tags": {}
187340
+ },
186451
187341
  {
186452
187342
  "kind": "property",
186453
187343
  "name": "UNSTABLE_virtual",
@@ -188267,6 +189157,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
188267
189157
  ],
188268
189158
  "tags": {}
188269
189159
  },
189160
+ {
189161
+ "kind": "property",
189162
+ "name": "pageSize",
189163
+ "defaultValue": {
189164
+ "kind": "number",
189165
+ "value": 0
189166
+ },
189167
+ "type": {
189168
+ "kind": "primitive",
189169
+ "value": "number"
189170
+ },
189171
+ "required": false,
189172
+ "description": "Controls how much a pageUp/pageDown navigation request will jump. If not provided, the size\nof the list and number of items rendered will determine this value.",
189173
+ "declarations": [
189174
+ {
189175
+ "name": "pageSize",
189176
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
189177
+ }
189178
+ ],
189179
+ "tags": {}
189180
+ },
188270
189181
  {
188271
189182
  "kind": "property",
188272
189183
  "name": "getId",
@@ -188329,7 +189240,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
188329
189240
  }
188330
189241
  },
188331
189242
  "required": false,
188332
- "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.",
189243
+ "description": "Optional function to return an id of an item. If not provided, the default function will\nreturn the `id` property from the object of each item. If you did not provide `items`, do not\noverride this function. If you don't provided `items` and instead provide static items via\nJSX, the list will create an internal array of items where `id` is the only property and the\ndefault `getId` will return the desired result.",
188333
189244
  "declarations": [
188334
189245
  {
188335
189246
  "name": "getId",
@@ -188400,7 +189311,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
188400
189311
  }
188401
189312
  },
188402
189313
  "required": false,
188403
- "description": "",
189314
+ "description": "Optional function to return the text representation of an item. If not provided, the default\nfunction will return the `text` property of the object of each item or an empty string if\nthere is no `text` property. If you did not provide `items`, do not override this function.",
188404
189315
  "declarations": [
188405
189316
  {
188406
189317
  "name": "getTextValue",
@@ -191607,6 +192518,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
191607
192518
  "private": "Use useGridModel instead to make a grid instead of a list"
191608
192519
  }
191609
192520
  },
192521
+ {
192522
+ "kind": "property",
192523
+ "name": "pageSizeRef",
192524
+ "type": {
192525
+ "kind": "symbol",
192526
+ "name": "MutableRefObject",
192527
+ "value": "MutableRefObject<number>"
192528
+ },
192529
+ "description": "A React.Ref of the current page size. Either provided as config, or determined at runtime\nbased on the size of the list container and the number of items fitting within the container.",
192530
+ "declarations": [
192531
+ {
192532
+ "name": "pageSizeRef",
192533
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
192534
+ }
192535
+ ],
192536
+ "tags": {}
192537
+ },
191610
192538
  {
191611
192539
  "kind": "property",
191612
192540
  "name": "UNSTABLE_virtual",