@workday/canvas-kit-docs 9.2.0-521-next.0 → 9.2.0-526-next.0

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.
@@ -1441,6 +1441,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1441
1441
  "value": "SystemIconCircleSize.m"
1442
1442
  }
1443
1443
  },
1444
+ {
1445
+ "kind": "property",
1446
+ "name": "objectFit",
1447
+ "required": false,
1448
+ "type": {
1449
+ "kind": "external",
1450
+ "name": "Property.ObjectFit",
1451
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
1452
+ },
1453
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
1454
+ "declarations": [
1455
+ {
1456
+ "name": "objectFit",
1457
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
1458
+ }
1459
+ ],
1460
+ "tags": {}
1461
+ },
1444
1462
  {
1445
1463
  "kind": "property",
1446
1464
  "name": "altText",
@@ -8103,6 +8121,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
8103
8121
  "value": "div"
8104
8122
  }
8105
8123
  },
8124
+ {
8125
+ "kind": "property",
8126
+ "name": "objectFit",
8127
+ "required": false,
8128
+ "type": {
8129
+ "kind": "external",
8130
+ "name": "Property.ObjectFit",
8131
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
8132
+ },
8133
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
8134
+ "declarations": [
8135
+ {
8136
+ "name": "objectFit",
8137
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
8138
+ }
8139
+ ],
8140
+ "tags": {}
8141
+ },
8106
8142
  {
8107
8143
  "kind": "property",
8108
8144
  "name": "children",
@@ -40335,6 +40371,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
40335
40371
  }
40336
40372
  ],
40337
40373
  "tags": {}
40374
+ },
40375
+ {
40376
+ "kind": "property",
40377
+ "name": "objectFit",
40378
+ "required": false,
40379
+ "type": {
40380
+ "kind": "external",
40381
+ "name": "Property.ObjectFit",
40382
+ "url": "https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit"
40383
+ },
40384
+ "description": "The object-fit CSS property sets how the content of a replaced element,\nsuch as an <img> or <video>, should be resized to fit its container.\nSee [object-fit](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\nIf your image is not a square, you can use this property to ensure the image is rendered properly.",
40385
+ "declarations": [
40386
+ {
40387
+ "name": "objectFit",
40388
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/avatar/lib/Avatar.tsx"
40389
+ }
40390
+ ],
40391
+ "tags": {}
40338
40392
  }
40339
40393
  ]
40340
40394
  }
@@ -42128,48 +42182,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42128
42182
  "kind": "parameter",
42129
42183
  "name": "type",
42130
42184
  "type": {
42131
- "kind": "type",
42132
- "typeParameters": [],
42133
- "value": {
42134
- "kind": "symbol",
42135
- "name": "Exclude",
42136
- "typeParameters": [
42137
- {
42138
- "kind": "union",
42139
- "value": [
42140
- {
42141
- "kind": "string",
42142
- "value": "alert"
42143
- },
42144
- {
42145
- "kind": "string",
42146
- "value": "error"
42147
- },
42148
- {
42149
- "kind": "string",
42150
- "value": "common"
42151
- },
42152
- {
42153
- "kind": "string",
42154
- "value": "primary"
42155
- },
42156
- {
42157
- "kind": "string",
42158
- "value": "success"
42159
- },
42160
- {
42161
- "kind": "string",
42162
- "value": "neutral"
42163
- }
42164
- ]
42165
- },
42166
- {
42167
- "kind": "string",
42168
- "value": "common"
42169
- }
42170
- ],
42171
- "value": "Exclude<T, U>"
42172
- }
42185
+ "kind": "symbol",
42186
+ "name": "paletteSelection",
42187
+ "value": "paletteSelection"
42173
42188
  },
42174
42189
  "required": true,
42175
42190
  "rest": false,
@@ -42279,48 +42294,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
42279
42294
  "kind": "parameter",
42280
42295
  "name": "type",
42281
42296
  "type": {
42282
- "kind": "type",
42283
- "typeParameters": [],
42284
- "value": {
42285
- "kind": "symbol",
42286
- "name": "Exclude",
42287
- "typeParameters": [
42288
- {
42289
- "kind": "union",
42290
- "value": [
42291
- {
42292
- "kind": "string",
42293
- "value": "alert"
42294
- },
42295
- {
42296
- "kind": "string",
42297
- "value": "error"
42298
- },
42299
- {
42300
- "kind": "string",
42301
- "value": "common"
42302
- },
42303
- {
42304
- "kind": "string",
42305
- "value": "primary"
42306
- },
42307
- {
42308
- "kind": "string",
42309
- "value": "success"
42310
- },
42311
- {
42312
- "kind": "string",
42313
- "value": "neutral"
42314
- }
42315
- ]
42316
- },
42317
- {
42318
- "kind": "string",
42319
- "value": "common"
42320
- }
42321
- ],
42322
- "value": "Exclude<T, U>"
42323
- }
42297
+ "kind": "symbol",
42298
+ "name": "paletteSelection",
42299
+ "value": "paletteSelection"
42324
42300
  },
42325
42301
  "required": true,
42326
42302
  "rest": false,
@@ -63446,29 +63422,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63446
63422
  "name": "align",
63447
63423
  "required": true,
63448
63424
  "type": {
63449
- "kind": "type",
63450
- "typeParameters": [],
63451
- "value": {
63452
- "kind": "union",
63453
- "value": [
63454
- {
63455
- "kind": "string",
63456
- "value": "start"
63457
- },
63458
- {
63459
- "kind": "string",
63460
- "value": "center"
63461
- },
63462
- {
63463
- "kind": "string",
63464
- "value": "end"
63465
- },
63466
- {
63467
- "kind": "string",
63468
- "value": "auto"
63469
- }
63470
- ]
63471
- }
63425
+ "kind": "symbol",
63426
+ "name": "ScrollAlignment",
63427
+ "value": "ScrollAlignment"
63472
63428
  },
63473
63429
  "description": "",
63474
63430
  "declarations": [
@@ -63501,29 +63457,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63501
63457
  "name": "align",
63502
63458
  "required": true,
63503
63459
  "type": {
63504
- "kind": "type",
63505
- "typeParameters": [],
63506
- "value": {
63507
- "kind": "union",
63508
- "value": [
63509
- {
63510
- "kind": "string",
63511
- "value": "start"
63512
- },
63513
- {
63514
- "kind": "string",
63515
- "value": "center"
63516
- },
63517
- {
63518
- "kind": "string",
63519
- "value": "end"
63520
- },
63521
- {
63522
- "kind": "string",
63523
- "value": "auto"
63524
- }
63525
- ]
63526
- }
63460
+ "kind": "symbol",
63461
+ "name": "ScrollAlignment",
63462
+ "value": "ScrollAlignment"
63527
63463
  },
63528
63464
  "description": "",
63529
63465
  "declarations": [
@@ -63556,29 +63492,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63556
63492
  "name": "align",
63557
63493
  "required": true,
63558
63494
  "type": {
63559
- "kind": "type",
63560
- "typeParameters": [],
63561
- "value": {
63562
- "kind": "union",
63563
- "value": [
63564
- {
63565
- "kind": "string",
63566
- "value": "start"
63567
- },
63568
- {
63569
- "kind": "string",
63570
- "value": "center"
63571
- },
63572
- {
63573
- "kind": "string",
63574
- "value": "end"
63575
- },
63576
- {
63577
- "kind": "string",
63578
- "value": "auto"
63579
- }
63580
- ]
63581
- }
63495
+ "kind": "symbol",
63496
+ "name": "ScrollAlignment",
63497
+ "value": "ScrollAlignment"
63582
63498
  },
63583
63499
  "description": "",
63584
63500
  "declarations": [
@@ -63611,21 +63527,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
63611
63527
  "name": "key",
63612
63528
  "required": true,
63613
63529
  "type": {
63614
- "kind": "type",
63615
- "typeParameters": [],
63616
- "value": {
63617
- "kind": "union",
63618
- "value": [
63619
- {
63620
- "kind": "primitive",
63621
- "value": "number"
63622
- },
63623
- {
63624
- "kind": "primitive",
63625
- "value": "string"
63626
- }
63627
- ]
63628
- }
63530
+ "kind": "symbol",
63531
+ "name": "Key",
63532
+ "value": "Key"
63629
63533
  },
63630
63534
  "description": "",
63631
63535
  "declarations": [
@@ -64178,43 +64082,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64178
64082
  ],
64179
64083
  "members": [],
64180
64084
  "returnType": {
64181
- "kind": "object",
64182
- "properties": [
64183
- {
64184
- "kind": "property",
64185
- "name": "width",
64186
- "required": true,
64187
- "type": {
64188
- "kind": "primitive",
64189
- "value": "number"
64190
- },
64191
- "description": "",
64192
- "declarations": [
64193
- {
64194
- "name": "width",
64195
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64196
- }
64197
- ],
64198
- "tags": {}
64199
- },
64200
- {
64201
- "kind": "property",
64202
- "name": "height",
64203
- "required": true,
64204
- "type": {
64205
- "kind": "primitive",
64206
- "value": "number"
64207
- },
64208
- "description": "",
64209
- "declarations": [
64210
- {
64211
- "name": "height",
64212
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64213
- }
64214
- ],
64215
- "tags": {}
64216
- }
64217
- ]
64085
+ "kind": "symbol",
64086
+ "name": "Rect",
64087
+ "value": "Rect"
64218
64088
  }
64219
64089
  },
64220
64090
  "description": "",
@@ -64231,43 +64101,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64231
64101
  "name": "initialRect",
64232
64102
  "required": false,
64233
64103
  "type": {
64234
- "kind": "object",
64235
- "properties": [
64236
- {
64237
- "kind": "property",
64238
- "name": "width",
64239
- "required": true,
64240
- "type": {
64241
- "kind": "primitive",
64242
- "value": "number"
64243
- },
64244
- "description": "",
64245
- "declarations": [
64246
- {
64247
- "name": "width",
64248
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64249
- }
64250
- ],
64251
- "tags": {}
64252
- },
64253
- {
64254
- "kind": "property",
64255
- "name": "height",
64256
- "required": true,
64257
- "type": {
64258
- "kind": "primitive",
64259
- "value": "number"
64260
- },
64261
- "description": "",
64262
- "declarations": [
64263
- {
64264
- "name": "height",
64265
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/react-virtual.ts"
64266
- }
64267
- ],
64268
- "tags": {}
64269
- }
64270
- ]
64104
+ "kind": "symbol",
64105
+ "name": "Rect",
64106
+ "value": "Rect"
64271
64107
  },
64272
64108
  "description": "",
64273
64109
  "declarations": [
@@ -64306,21 +64142,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
64306
64142
  ],
64307
64143
  "members": [],
64308
64144
  "returnType": {
64309
- "kind": "type",
64310
- "typeParameters": [],
64311
- "value": {
64312
- "kind": "union",
64313
- "value": [
64314
- {
64315
- "kind": "primitive",
64316
- "value": "number"
64317
- },
64318
- {
64319
- "kind": "primitive",
64320
- "value": "string"
64321
- }
64322
- ]
64323
- }
64145
+ "kind": "symbol",
64146
+ "name": "Key",
64147
+ "value": "Key"
64324
64148
  }
64325
64149
  },
64326
64150
  "description": "",
@@ -66971,23 +66795,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
66971
66795
  "kind": "parameter",
66972
66796
  "name": "model",
66973
66797
  "type": {
66974
- "kind": "type",
66975
- "typeParameters": [],
66976
- "value": {
66977
- "kind": "symbol",
66978
- "name": "Pick",
66979
- "typeParameters": [
66980
- {
66981
- "kind": "symbol",
66982
- "name": "useCursorListModel"
66983
- },
66984
- {
66985
- "kind": "string",
66986
- "value": "state"
66987
- }
66988
- ],
66989
- "value": "Pick<T, K>"
66990
- }
66798
+ "kind": "symbol",
66799
+ "name": "NavigationInput",
66800
+ "value": "NavigationInput"
66991
66801
  },
66992
66802
  "required": true,
66993
66803
  "rest": false,
@@ -67252,23 +67062,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67252
67062
  "kind": "parameter",
67253
67063
  "name": "model",
67254
67064
  "type": {
67255
- "kind": "type",
67256
- "typeParameters": [],
67257
- "value": {
67258
- "kind": "symbol",
67259
- "name": "Pick",
67260
- "typeParameters": [
67261
- {
67262
- "kind": "symbol",
67263
- "name": "useCursorListModel"
67264
- },
67265
- {
67266
- "kind": "string",
67267
- "value": "state"
67268
- }
67269
- ],
67270
- "value": "Pick<T, K>"
67271
- }
67065
+ "kind": "symbol",
67066
+ "name": "NavigationInput",
67067
+ "value": "NavigationInput"
67272
67068
  },
67273
67069
  "required": true,
67274
67070
  "rest": false,
@@ -67451,23 +67247,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67451
67247
  "kind": "parameter",
67452
67248
  "name": "__1",
67453
67249
  "type": {
67454
- "kind": "type",
67455
- "typeParameters": [],
67456
- "value": {
67457
- "kind": "symbol",
67458
- "name": "Pick",
67459
- "typeParameters": [
67460
- {
67461
- "kind": "symbol",
67462
- "name": "useCursorListModel"
67463
- },
67464
- {
67465
- "kind": "string",
67466
- "value": "state"
67467
- }
67468
- ],
67469
- "value": "Pick<T, K>"
67470
- }
67250
+ "kind": "symbol",
67251
+ "name": "NavigationInput",
67252
+ "value": "NavigationInput"
67471
67253
  },
67472
67254
  "required": true,
67473
67255
  "rest": false,
@@ -67574,23 +67356,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67574
67356
  "kind": "parameter",
67575
67357
  "name": "__1",
67576
67358
  "type": {
67577
- "kind": "type",
67578
- "typeParameters": [],
67579
- "value": {
67580
- "kind": "symbol",
67581
- "name": "Pick",
67582
- "typeParameters": [
67583
- {
67584
- "kind": "symbol",
67585
- "name": "useCursorListModel"
67586
- },
67587
- {
67588
- "kind": "string",
67589
- "value": "state"
67590
- }
67591
- ],
67592
- "value": "Pick<T, K>"
67593
- }
67359
+ "kind": "symbol",
67360
+ "name": "NavigationInput",
67361
+ "value": "NavigationInput"
67594
67362
  },
67595
67363
  "required": true,
67596
67364
  "rest": false,
@@ -67717,302 +67485,274 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
67717
67485
  "kind": "parameter",
67718
67486
  "name": "model",
67719
67487
  "type": {
67720
- "kind": "type",
67721
- "typeParameters": [],
67722
- "value": {
67723
- "kind": "symbol",
67724
- "name": "Pick",
67725
- "typeParameters": [
67726
- {
67727
- "kind": "symbol",
67728
- "name": "useCursorListModel"
67729
- },
67730
- {
67731
- "kind": "string",
67732
- "value": "state"
67733
- }
67734
- ],
67735
- "value": "Pick<T, K>"
67736
- }
67737
- },
67738
- "required": true,
67739
- "rest": false,
67740
- "description": "",
67741
- "declarations": [
67742
- {
67743
- "name": "model",
67744
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67745
- }
67746
- ],
67747
- "tags": {}
67748
- }
67749
- ],
67750
- "members": [],
67751
- "returnType": {
67752
- "kind": "symbol",
67753
- "name": "Item",
67754
- "typeParameters": [
67755
- {
67756
- "kind": "symbol",
67757
- "name": "Generic",
67758
- "value": "any"
67759
- }
67760
- ],
67761
- "value": "Item<T>"
67762
- }
67763
- },
67764
- "description": "Get an item with the provided `id`.",
67765
- "declarations": [
67766
- {
67767
- "name": "getItem",
67768
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67769
- }
67770
- ],
67771
- "tags": {}
67772
- },
67773
- {
67774
- "kind": "property",
67775
- "name": "getNext",
67776
- "required": true,
67777
- "type": {
67778
- "kind": "symbol",
67779
- "name": "NavigationRequestor",
67780
- "value": "NavigationRequestor"
67781
- },
67782
- "description": "Get the next item after the provided `id`. This will be called when the `Right` arrow key is\npressed for RTL languages and when the `Left` arrow is pressed for LTR languages.",
67783
- "declarations": [
67784
- {
67785
- "name": "getNext",
67786
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67787
- }
67788
- ],
67789
- "tags": {}
67790
- },
67791
- {
67792
- "kind": "property",
67793
- "name": "getNextRow",
67794
- "required": true,
67795
- "type": {
67796
- "kind": "symbol",
67797
- "name": "NavigationRequestor",
67798
- "value": "NavigationRequestor"
67799
- },
67800
- "description": "**For Grids:** Get the cell in the next row from the provided `id`. This will be called when\nthe `Down` arrow is pressed.",
67801
- "declarations": [
67802
- {
67803
- "name": "getNextRow",
67804
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67805
- }
67806
- ],
67807
- "tags": {}
67808
- },
67809
- {
67810
- "kind": "property",
67811
- "name": "getPrevious",
67812
- "required": true,
67813
- "type": {
67814
- "kind": "symbol",
67815
- "name": "NavigationRequestor",
67816
- "value": "NavigationRequestor"
67817
- },
67818
- "description": "Get the previous item before the provided `id`. This will be called when the `Left` arrow key\nis pressed for RTL languages and when the `Right` arrow is pressed for LTR languages.",
67819
- "declarations": [
67820
- {
67821
- "name": "getPrevious",
67822
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67823
- }
67824
- ],
67825
- "tags": {}
67826
- },
67827
- {
67828
- "kind": "property",
67829
- "name": "getPreviousRow",
67830
- "required": true,
67831
- "type": {
67832
- "kind": "symbol",
67833
- "name": "NavigationRequestor",
67834
- "value": "NavigationRequestor"
67835
- },
67836
- "description": "**For Grids:** Get the cell in the previous row from the provided `id`. This will be called\nwhen the `Up` arrow is pressed.",
67837
- "declarations": [
67838
- {
67839
- "name": "getPreviousRow",
67840
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67841
- }
67842
- ],
67843
- "tags": {}
67844
- },
67845
- {
67846
- "kind": "property",
67847
- "name": "getFirstOfRow",
67848
- "required": true,
67849
- "type": {
67850
- "kind": "symbol",
67851
- "name": "NavigationRequestor",
67852
- "value": "NavigationRequestor"
67853
- },
67854
- "description": "**For Grids:** Get the first item in a row. This will be called when the `Home` key is\npressed.",
67855
- "declarations": [
67856
- {
67857
- "name": "getFirstOfRow",
67858
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67859
- }
67860
- ],
67861
- "tags": {}
67862
- },
67863
- {
67864
- "kind": "property",
67865
- "name": "getLastOfRow",
67866
- "required": true,
67867
- "type": {
67868
- "kind": "symbol",
67869
- "name": "NavigationRequestor",
67870
- "value": "NavigationRequestor"
67871
- },
67872
- "description": "**For Grids:** Get the last item in a row. This will be called when the `End` key is\npressed.",
67873
- "declarations": [
67874
- {
67875
- "name": "getLastOfRow",
67876
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67877
- }
67878
- ],
67879
- "tags": {}
67880
- },
67881
- {
67882
- "kind": "property",
67883
- "name": "getNextPage",
67884
- "required": true,
67885
- "type": {
67886
- "kind": "symbol",
67887
- "name": "NavigationRequestor",
67888
- "value": "NavigationRequestor"
67889
- },
67890
- "description": "Get the next \"page\". A \"page\" is application specific and usually means next visible screen.\nIf the viewport is scrollable, it would scroll so that the last item visible is now the first\nitem visible. This is called when the `PageDown` key is pressed",
67891
- "declarations": [
67892
- {
67893
- "name": "getNextPage",
67894
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67895
- }
67896
- ],
67897
- "tags": {}
67898
- },
67899
- {
67900
- "kind": "property",
67901
- "name": "getPreviousPage",
67902
- "required": true,
67903
- "type": {
67904
- "kind": "symbol",
67905
- "name": "NavigationRequestor",
67906
- "value": "NavigationRequestor"
67907
- },
67908
- "description": "Get the next \"page\". A \"page\" is application specific and usually means previous visible\nscreen. If the viewport is scrollable, it would scroll so that the first item visible is now\nthe last item visible. This is called when the `PageUp` key is pressed",
67909
- "declarations": [
67910
- {
67911
- "name": "getPreviousPage",
67912
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67913
- }
67914
- ],
67915
- "tags": {}
67916
- }
67917
- ]
67918
- }
67919
- },
67920
- {
67921
- "name": "navigationManager",
67922
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx",
67923
- "description": "The default navigation of grids. This navigation manager will not wrap, but will stop when an\nedge is detected. This could be the last item in a list or the last item of a row in a grid.",
67924
- "declarations": [
67925
- {
67926
- "name": "navigationManager",
67927
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67928
- }
67929
- ],
67930
- "tags": {},
67931
- "type": {
67932
- "kind": "object",
67933
- "properties": [
67934
- {
67935
- "kind": "property",
67936
- "name": "getFirst",
67937
- "required": true,
67938
- "type": {
67939
- "kind": "symbol",
67940
- "name": "NavigationRequestor",
67941
- "value": "NavigationRequestor"
67942
- },
67943
- "description": "Get the first item in a collection. This will be called when the `Home` key is pressed for\nLists and `Ctrl+Home` for Grids.",
67944
- "declarations": [
67945
- {
67946
- "name": "getFirst",
67947
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67948
- }
67949
- ],
67950
- "tags": {}
67951
- },
67952
- {
67953
- "kind": "property",
67954
- "name": "getLast",
67955
- "required": true,
67956
- "type": {
67957
- "kind": "symbol",
67958
- "name": "NavigationRequestor",
67959
- "value": "NavigationRequestor"
67960
- },
67961
- "description": "Get the last item in a collection. This will be called when the `End` key is pressed for Lists\nand `Ctrl+End` for Grids.",
67962
- "declarations": [
67963
- {
67964
- "name": "getLast",
67965
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67966
- }
67967
- ],
67968
- "tags": {}
67969
- },
67970
- {
67971
- "kind": "property",
67972
- "name": "getItem",
67973
- "required": true,
67974
- "type": {
67975
- "kind": "function",
67976
- "parameters": [
67977
- {
67978
- "kind": "parameter",
67979
- "name": "id",
67980
- "type": {
67981
- "kind": "primitive",
67982
- "value": "string"
67983
- },
67984
- "required": true,
67985
- "rest": false,
67986
- "description": "",
67987
- "declarations": [
67988
- {
67989
- "name": "id",
67990
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67991
- }
67992
- ],
67993
- "tags": {}
67994
- },
67995
- {
67996
- "kind": "parameter",
67997
- "name": "model",
67998
- "type": {
67999
- "kind": "type",
68000
- "typeParameters": [],
68001
- "value": {
68002
- "kind": "symbol",
68003
- "name": "Pick",
68004
- "typeParameters": [
68005
- {
68006
- "kind": "symbol",
68007
- "name": "useCursorListModel"
68008
- },
68009
- {
68010
- "kind": "string",
68011
- "value": "state"
68012
- }
68013
- ],
68014
- "value": "Pick<T, K>"
67488
+ "kind": "symbol",
67489
+ "name": "NavigationInput",
67490
+ "value": "NavigationInput"
67491
+ },
67492
+ "required": true,
67493
+ "rest": false,
67494
+ "description": "",
67495
+ "declarations": [
67496
+ {
67497
+ "name": "model",
67498
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
68015
67499
  }
67500
+ ],
67501
+ "tags": {}
67502
+ }
67503
+ ],
67504
+ "members": [],
67505
+ "returnType": {
67506
+ "kind": "symbol",
67507
+ "name": "Item",
67508
+ "typeParameters": [
67509
+ {
67510
+ "kind": "symbol",
67511
+ "name": "Generic",
67512
+ "value": "any"
67513
+ }
67514
+ ],
67515
+ "value": "Item<T>"
67516
+ }
67517
+ },
67518
+ "description": "Get an item with the provided `id`.",
67519
+ "declarations": [
67520
+ {
67521
+ "name": "getItem",
67522
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67523
+ }
67524
+ ],
67525
+ "tags": {}
67526
+ },
67527
+ {
67528
+ "kind": "property",
67529
+ "name": "getNext",
67530
+ "required": true,
67531
+ "type": {
67532
+ "kind": "symbol",
67533
+ "name": "NavigationRequestor",
67534
+ "value": "NavigationRequestor"
67535
+ },
67536
+ "description": "Get the next item after the provided `id`. This will be called when the `Right` arrow key is\npressed for RTL languages and when the `Left` arrow is pressed for LTR languages.",
67537
+ "declarations": [
67538
+ {
67539
+ "name": "getNext",
67540
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67541
+ }
67542
+ ],
67543
+ "tags": {}
67544
+ },
67545
+ {
67546
+ "kind": "property",
67547
+ "name": "getNextRow",
67548
+ "required": true,
67549
+ "type": {
67550
+ "kind": "symbol",
67551
+ "name": "NavigationRequestor",
67552
+ "value": "NavigationRequestor"
67553
+ },
67554
+ "description": "**For Grids:** Get the cell in the next row from the provided `id`. This will be called when\nthe `Down` arrow is pressed.",
67555
+ "declarations": [
67556
+ {
67557
+ "name": "getNextRow",
67558
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67559
+ }
67560
+ ],
67561
+ "tags": {}
67562
+ },
67563
+ {
67564
+ "kind": "property",
67565
+ "name": "getPrevious",
67566
+ "required": true,
67567
+ "type": {
67568
+ "kind": "symbol",
67569
+ "name": "NavigationRequestor",
67570
+ "value": "NavigationRequestor"
67571
+ },
67572
+ "description": "Get the previous item before the provided `id`. This will be called when the `Left` arrow key\nis pressed for RTL languages and when the `Right` arrow is pressed for LTR languages.",
67573
+ "declarations": [
67574
+ {
67575
+ "name": "getPrevious",
67576
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67577
+ }
67578
+ ],
67579
+ "tags": {}
67580
+ },
67581
+ {
67582
+ "kind": "property",
67583
+ "name": "getPreviousRow",
67584
+ "required": true,
67585
+ "type": {
67586
+ "kind": "symbol",
67587
+ "name": "NavigationRequestor",
67588
+ "value": "NavigationRequestor"
67589
+ },
67590
+ "description": "**For Grids:** Get the cell in the previous row from the provided `id`. This will be called\nwhen the `Up` arrow is pressed.",
67591
+ "declarations": [
67592
+ {
67593
+ "name": "getPreviousRow",
67594
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67595
+ }
67596
+ ],
67597
+ "tags": {}
67598
+ },
67599
+ {
67600
+ "kind": "property",
67601
+ "name": "getFirstOfRow",
67602
+ "required": true,
67603
+ "type": {
67604
+ "kind": "symbol",
67605
+ "name": "NavigationRequestor",
67606
+ "value": "NavigationRequestor"
67607
+ },
67608
+ "description": "**For Grids:** Get the first item in a row. This will be called when the `Home` key is\npressed.",
67609
+ "declarations": [
67610
+ {
67611
+ "name": "getFirstOfRow",
67612
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67613
+ }
67614
+ ],
67615
+ "tags": {}
67616
+ },
67617
+ {
67618
+ "kind": "property",
67619
+ "name": "getLastOfRow",
67620
+ "required": true,
67621
+ "type": {
67622
+ "kind": "symbol",
67623
+ "name": "NavigationRequestor",
67624
+ "value": "NavigationRequestor"
67625
+ },
67626
+ "description": "**For Grids:** Get the last item in a row. This will be called when the `End` key is\npressed.",
67627
+ "declarations": [
67628
+ {
67629
+ "name": "getLastOfRow",
67630
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67631
+ }
67632
+ ],
67633
+ "tags": {}
67634
+ },
67635
+ {
67636
+ "kind": "property",
67637
+ "name": "getNextPage",
67638
+ "required": true,
67639
+ "type": {
67640
+ "kind": "symbol",
67641
+ "name": "NavigationRequestor",
67642
+ "value": "NavigationRequestor"
67643
+ },
67644
+ "description": "Get the next \"page\". A \"page\" is application specific and usually means next visible screen.\nIf the viewport is scrollable, it would scroll so that the last item visible is now the first\nitem visible. This is called when the `PageDown` key is pressed",
67645
+ "declarations": [
67646
+ {
67647
+ "name": "getNextPage",
67648
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67649
+ }
67650
+ ],
67651
+ "tags": {}
67652
+ },
67653
+ {
67654
+ "kind": "property",
67655
+ "name": "getPreviousPage",
67656
+ "required": true,
67657
+ "type": {
67658
+ "kind": "symbol",
67659
+ "name": "NavigationRequestor",
67660
+ "value": "NavigationRequestor"
67661
+ },
67662
+ "description": "Get the next \"page\". A \"page\" is application specific and usually means previous visible\nscreen. If the viewport is scrollable, it would scroll so that the first item visible is now\nthe last item visible. This is called when the `PageUp` key is pressed",
67663
+ "declarations": [
67664
+ {
67665
+ "name": "getPreviousPage",
67666
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67667
+ }
67668
+ ],
67669
+ "tags": {}
67670
+ }
67671
+ ]
67672
+ }
67673
+ },
67674
+ {
67675
+ "name": "navigationManager",
67676
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx",
67677
+ "description": "The default navigation of grids. This navigation manager will not wrap, but will stop when an\nedge is detected. This could be the last item in a list or the last item of a row in a grid.",
67678
+ "declarations": [
67679
+ {
67680
+ "name": "navigationManager",
67681
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67682
+ }
67683
+ ],
67684
+ "tags": {},
67685
+ "type": {
67686
+ "kind": "object",
67687
+ "properties": [
67688
+ {
67689
+ "kind": "property",
67690
+ "name": "getFirst",
67691
+ "required": true,
67692
+ "type": {
67693
+ "kind": "symbol",
67694
+ "name": "NavigationRequestor",
67695
+ "value": "NavigationRequestor"
67696
+ },
67697
+ "description": "Get the first item in a collection. This will be called when the `Home` key is pressed for\nLists and `Ctrl+Home` for Grids.",
67698
+ "declarations": [
67699
+ {
67700
+ "name": "getFirst",
67701
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67702
+ }
67703
+ ],
67704
+ "tags": {}
67705
+ },
67706
+ {
67707
+ "kind": "property",
67708
+ "name": "getLast",
67709
+ "required": true,
67710
+ "type": {
67711
+ "kind": "symbol",
67712
+ "name": "NavigationRequestor",
67713
+ "value": "NavigationRequestor"
67714
+ },
67715
+ "description": "Get the last item in a collection. This will be called when the `End` key is pressed for Lists\nand `Ctrl+End` for Grids.",
67716
+ "declarations": [
67717
+ {
67718
+ "name": "getLast",
67719
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67720
+ }
67721
+ ],
67722
+ "tags": {}
67723
+ },
67724
+ {
67725
+ "kind": "property",
67726
+ "name": "getItem",
67727
+ "required": true,
67728
+ "type": {
67729
+ "kind": "function",
67730
+ "parameters": [
67731
+ {
67732
+ "kind": "parameter",
67733
+ "name": "id",
67734
+ "type": {
67735
+ "kind": "primitive",
67736
+ "value": "string"
67737
+ },
67738
+ "required": true,
67739
+ "rest": false,
67740
+ "description": "",
67741
+ "declarations": [
67742
+ {
67743
+ "name": "id",
67744
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/useCursorListModel.tsx"
67745
+ }
67746
+ ],
67747
+ "tags": {}
67748
+ },
67749
+ {
67750
+ "kind": "parameter",
67751
+ "name": "model",
67752
+ "type": {
67753
+ "kind": "symbol",
67754
+ "name": "NavigationInput",
67755
+ "value": "NavigationInput"
68016
67756
  },
68017
67757
  "required": true,
68018
67758
  "rest": false,
@@ -107445,19 +107185,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107445
107185
  "kind": "typeParameter",
107446
107186
  "name": "T",
107447
107187
  "constraint": {
107448
- "kind": "type",
107449
- "typeParameters": [
107450
- {
107451
- "kind": "typeParameter",
107452
- "name": "T",
107453
- "required": true
107454
- }
107455
- ],
107456
- "value": {
107457
- "kind": "unknown",
107458
- "value": "unknown",
107459
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107460
- }
107188
+ "kind": "symbol",
107189
+ "name": "ResponsiveCSSObject",
107190
+ "value": "ResponsiveCSSObject<T>"
107461
107191
  },
107462
107192
  "required": true
107463
107193
  }
@@ -107467,19 +107197,15 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
107467
107197
  "kind": "parameter",
107468
107198
  "name": "styles",
107469
107199
  "type": {
107470
- "kind": "type",
107200
+ "kind": "symbol",
107201
+ "name": "ResponsiveCSSObject",
107471
107202
  "typeParameters": [
107472
107203
  {
107473
- "kind": "typeParameter",
107474
- "name": "T",
107475
- "required": true
107204
+ "kind": "generic",
107205
+ "name": "T"
107476
107206
  }
107477
107207
  ],
107478
- "value": {
107479
- "kind": "unknown",
107480
- "value": "unknown",
107481
- "text": "{\n [P in keyof T]: Partial<Record<BreakpointKeys, AllStyleProps>> &\n AllStyleProps;\n}"
107482
- }
107208
+ "value": "ResponsiveCSSObject<T>"
107483
107209
  },
107484
107210
  "required": true,
107485
107211
  "rest": false,
@@ -109393,19 +109119,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109393
109119
  "kind": "type",
109394
109120
  "typeParameters": [],
109395
109121
  "value": {
109396
- "kind": "type",
109397
- "typeParameters": [
109398
- {
109399
- "kind": "typeParameter",
109400
- "name": "T",
109401
- "required": true
109402
- }
109403
- ],
109404
- "value": {
109405
- "kind": "unknown",
109406
- "value": "unknown",
109407
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109408
- }
109122
+ "kind": "symbol",
109123
+ "name": "RecursivePartial",
109124
+ "value": "RecursivePartial<CanvasTheme>"
109409
109125
  }
109410
109126
  }
109411
109127
  },
@@ -109424,19 +109140,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109424
109140
  "kind": "type",
109425
109141
  "typeParameters": [],
109426
109142
  "value": {
109427
- "kind": "type",
109428
- "typeParameters": [
109429
- {
109430
- "kind": "typeParameter",
109431
- "name": "T",
109432
- "required": true
109433
- }
109434
- ],
109435
- "value": {
109436
- "kind": "unknown",
109437
- "value": "unknown",
109438
- "text": "{\n [P in keyof T]?: RecursivePartial<T[P]>;\n}"
109439
- }
109143
+ "kind": "symbol",
109144
+ "name": "RecursivePartial",
109145
+ "value": "RecursivePartial<CanvasThemePalette>"
109440
109146
  }
109441
109147
  }
109442
109148
  },
@@ -109702,48 +109408,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109702
109408
  "kind": "parameter",
109703
109409
  "name": "type",
109704
109410
  "type": {
109705
- "kind": "type",
109706
- "typeParameters": [],
109707
- "value": {
109708
- "kind": "symbol",
109709
- "name": "Exclude",
109710
- "typeParameters": [
109711
- {
109712
- "kind": "union",
109713
- "value": [
109714
- {
109715
- "kind": "string",
109716
- "value": "alert"
109717
- },
109718
- {
109719
- "kind": "string",
109720
- "value": "error"
109721
- },
109722
- {
109723
- "kind": "string",
109724
- "value": "common"
109725
- },
109726
- {
109727
- "kind": "string",
109728
- "value": "primary"
109729
- },
109730
- {
109731
- "kind": "string",
109732
- "value": "success"
109733
- },
109734
- {
109735
- "kind": "string",
109736
- "value": "neutral"
109737
- }
109738
- ]
109739
- },
109740
- {
109741
- "kind": "string",
109742
- "value": "common"
109743
- }
109744
- ],
109745
- "value": "Exclude<T, U>"
109746
- }
109411
+ "kind": "symbol",
109412
+ "name": "paletteSelection",
109413
+ "value": "paletteSelection"
109747
109414
  },
109748
109415
  "required": true,
109749
109416
  "rest": false,
@@ -109836,48 +109503,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
109836
109503
  "kind": "parameter",
109837
109504
  "name": "type",
109838
109505
  "type": {
109839
- "kind": "type",
109840
- "typeParameters": [],
109841
- "value": {
109842
- "kind": "symbol",
109843
- "name": "Exclude",
109844
- "typeParameters": [
109845
- {
109846
- "kind": "union",
109847
- "value": [
109848
- {
109849
- "kind": "string",
109850
- "value": "alert"
109851
- },
109852
- {
109853
- "kind": "string",
109854
- "value": "error"
109855
- },
109856
- {
109857
- "kind": "string",
109858
- "value": "common"
109859
- },
109860
- {
109861
- "kind": "string",
109862
- "value": "primary"
109863
- },
109864
- {
109865
- "kind": "string",
109866
- "value": "success"
109867
- },
109868
- {
109869
- "kind": "string",
109870
- "value": "neutral"
109871
- }
109872
- ]
109873
- },
109874
- {
109875
- "kind": "string",
109876
- "value": "common"
109877
- }
109878
- ],
109879
- "value": "Exclude<T, U>"
109880
- }
109506
+ "kind": "symbol",
109507
+ "name": "paletteSelection",
109508
+ "value": "paletteSelection"
109881
109509
  },
109882
109510
  "required": true,
109883
109511
  "rest": false,
@@ -110665,8 +110293,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
110665
110293
  "name": "React.ComponentProps",
110666
110294
  "typeParameters": [
110667
110295
  {
110668
- "kind": "generic",
110669
- "name": "ElementType"
110296
+ "kind": "symbol",
110297
+ "name": "ElementType",
110298
+ "value": "ElementType"
110670
110299
  }
110671
110300
  ],
110672
110301
  "value": "ComponentProps<T>"
@@ -111811,306 +111440,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
111811
111440
  "kind": "parameter",
111812
111441
  "name": "Component",
111813
111442
  "type": {
111814
- "kind": "function",
111815
- "parameters": [
111816
- {
111817
- "kind": "parameter",
111818
- "name": "props",
111819
- "type": {
111820
- "kind": "type",
111821
- "typeParameters": [
111822
- {
111823
- "kind": "typeParameter",
111824
- "name": "Props",
111825
- "required": true
111826
- },
111827
- {
111828
- "kind": "typeParameter",
111829
- "name": "TElemPropsHook",
111830
- "required": true
111831
- },
111832
- {
111833
- "kind": "typeParameter",
111834
- "name": "E",
111835
- "required": true
111836
- }
111837
- ],
111838
- "value": {
111839
- "kind": "intersection",
111840
- "value": [
111841
- {
111842
- "kind": "generic",
111843
- "name": "Props"
111844
- },
111845
- {
111846
- "kind": "parenthesis",
111847
- "value": {
111848
- "kind": "conditional",
111849
- "check": {
111850
- "kind": "generic",
111851
- "name": "TElemPropsHook"
111852
- },
111853
- "extends": {
111854
- "kind": "function",
111855
- "parameters": [
111856
- {
111857
- "kind": "parameter",
111858
- "name": "args",
111859
- "type": {
111860
- "kind": "array",
111861
- "value": {
111862
- "kind": "primitive",
111863
- "value": "any"
111864
- }
111865
- },
111866
- "required": true,
111867
- "rest": true,
111868
- "description": "",
111869
- "declarations": [
111870
- {
111871
- "name": "args",
111872
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111873
- }
111874
- ],
111875
- "tags": {}
111876
- }
111877
- ],
111878
- "members": [],
111879
- "returnType": {
111880
- "kind": "infer",
111881
- "value": {
111882
- "kind": "typeParameter",
111883
- "name": "TProps",
111884
- "required": true
111885
- }
111886
- }
111887
- },
111888
- "trueType": {
111889
- "kind": "type",
111890
- "typeParameters": [
111891
- {
111892
- "kind": "typeParameter",
111893
- "name": "T",
111894
- "required": true
111895
- }
111896
- ],
111897
- "value": {
111898
- "kind": "unknown",
111899
- "value": "unknown",
111900
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
111901
- }
111902
- },
111903
- "falseType": {
111904
- "kind": "object",
111905
- "properties": [
111906
- {
111907
- "kind": "property",
111908
- "name": "ref",
111909
- "required": true,
111910
- "type": {
111911
- "kind": "generic",
111912
- "name": "ExtractRef"
111913
- },
111914
- "description": "",
111915
- "declarations": [
111916
- {
111917
- "name": "ref",
111918
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111919
- }
111920
- ],
111921
- "tags": {}
111922
- }
111923
- ]
111924
- }
111925
- }
111926
- },
111927
- {
111928
- "kind": "parenthesis",
111929
- "value": {
111930
- "kind": "conditional",
111931
- "check": {
111932
- "kind": "generic",
111933
- "name": "Props"
111934
- },
111935
- "extends": {
111936
- "kind": "object",
111937
- "properties": [
111938
- {
111939
- "kind": "property",
111940
- "name": "children",
111941
- "required": true,
111942
- "type": {
111943
- "kind": "primitive",
111944
- "value": "any"
111945
- },
111946
- "description": "",
111947
- "declarations": [
111948
- {
111949
- "name": "children",
111950
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111951
- }
111952
- ],
111953
- "tags": {}
111954
- }
111955
- ]
111956
- },
111957
- "trueType": {
111958
- "kind": "object",
111959
- "properties": []
111960
- },
111961
- "falseType": {
111962
- "kind": "object",
111963
- "properties": [
111964
- {
111965
- "kind": "property",
111966
- "name": "children",
111967
- "required": false,
111968
- "type": {
111969
- "kind": "external",
111970
- "name": "ReactNode",
111971
- "url": "https://reactjs.org/docs/rendering-elements.html"
111972
- },
111973
- "description": "",
111974
- "declarations": [
111975
- {
111976
- "name": "children",
111977
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111978
- }
111979
- ],
111980
- "tags": {}
111981
- }
111982
- ]
111983
- }
111984
- }
111985
- }
111986
- ]
111987
- }
111988
- },
111989
- "required": true,
111990
- "rest": false,
111991
- "description": "",
111992
- "declarations": [
111993
- {
111994
- "name": "props",
111995
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
111996
- }
111997
- ],
111998
- "tags": {}
111999
- },
111443
+ "kind": "component",
111444
+ "props": [
112000
111445
  {
112001
- "kind": "parameter",
112002
- "name": "Element",
112003
- "type": {
112004
- "kind": "conditional",
112005
- "check": {
112006
- "kind": "generic",
112007
- "name": "E"
112008
- },
112009
- "extends": {
112010
- "kind": "primitive",
112011
- "value": "undefined"
112012
- },
112013
- "trueType": {
112014
- "kind": "primitive",
112015
- "value": "never"
112016
- },
112017
- "falseType": {
112018
- "kind": "generic",
112019
- "name": "E"
112020
- }
112021
- },
111446
+ "kind": "property",
111447
+ "name": "ref",
112022
111448
  "required": true,
112023
- "rest": false,
112024
- "description": "",
112025
- "declarations": [
112026
- {
112027
- "name": "Element",
112028
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112029
- }
112030
- ],
112031
- "tags": {}
112032
- },
112033
- {
112034
- "kind": "parameter",
112035
- "name": "model",
112036
111449
  "type": {
112037
- "kind": "conditional",
112038
- "check": {
112039
- "kind": "generic",
112040
- "name": "TModelHook"
112041
- },
112042
- "extends": {
112043
- "kind": "function",
112044
- "parameters": [
112045
- {
112046
- "kind": "parameter",
112047
- "name": "config",
112048
- "type": {
112049
- "kind": "infer",
112050
- "value": {
112051
- "kind": "typeParameter",
112052
- "name": "TConfig",
112053
- "required": true
112054
- }
112055
- },
112056
- "required": true,
112057
- "rest": false,
112058
- "description": "",
112059
- "declarations": [
112060
- {
112061
- "name": "config",
112062
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112063
- }
112064
- ],
112065
- "tags": {}
112066
- }
112067
- ],
112068
- "members": [],
112069
- "returnType": {
112070
- "kind": "infer",
112071
- "value": {
112072
- "kind": "typeParameter",
112073
- "name": "TModel",
112074
- "required": true
112075
- }
112076
- }
112077
- },
112078
- "trueType": {
112079
- "kind": "generic",
112080
- "name": "TModel"
112081
- },
112082
- "falseType": {
112083
- "kind": "primitive",
112084
- "value": "never"
112085
- }
111450
+ "kind": "generic",
111451
+ "name": "ExtractRef"
112086
111452
  },
112087
- "required": true,
112088
- "rest": false,
112089
111453
  "description": "",
112090
111454
  "declarations": [
112091
111455
  {
112092
- "name": "model",
111456
+ "name": "ref",
112093
111457
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112094
111458
  }
112095
111459
  ],
112096
111460
  "tags": {}
112097
111461
  }
112098
- ],
112099
- "members": [],
112100
- "returnType": {
112101
- "kind": "union",
112102
- "value": [
112103
- {
112104
- "kind": "external",
112105
- "name": "Element",
112106
- "url": "https://reactjs.org/docs/rendering-elements.html"
112107
- },
112108
- {
112109
- "kind": "primitive",
112110
- "value": "null"
112111
- }
112112
- ]
112113
- }
111462
+ ]
112114
111463
  },
112115
111464
  "required": true,
112116
111465
  "rest": false,
@@ -112563,305 +111912,26 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
112563
111912
  "kind": "parameter",
112564
111913
  "name": "Component",
112565
111914
  "type": {
112566
- "kind": "function",
112567
- "parameters": [
112568
- {
112569
- "kind": "parameter",
112570
- "name": "props",
112571
- "type": {
112572
- "kind": "type",
112573
- "typeParameters": [
112574
- {
112575
- "kind": "typeParameter",
112576
- "name": "Props",
112577
- "required": true
112578
- },
112579
- {
112580
- "kind": "typeParameter",
112581
- "name": "TElemPropsHook",
112582
- "required": true
112583
- },
112584
- {
112585
- "kind": "typeParameter",
112586
- "name": "E",
112587
- "required": true
112588
- }
112589
- ],
112590
- "value": {
112591
- "kind": "intersection",
112592
- "value": [
112593
- {
112594
- "kind": "generic",
112595
- "name": "Props"
112596
- },
112597
- {
112598
- "kind": "parenthesis",
112599
- "value": {
112600
- "kind": "conditional",
112601
- "check": {
112602
- "kind": "generic",
112603
- "name": "TElemPropsHook"
112604
- },
112605
- "extends": {
112606
- "kind": "function",
112607
- "parameters": [
112608
- {
112609
- "kind": "parameter",
112610
- "name": "args",
112611
- "type": {
112612
- "kind": "array",
112613
- "value": {
112614
- "kind": "primitive",
112615
- "value": "any"
112616
- }
112617
- },
112618
- "required": true,
112619
- "rest": true,
112620
- "description": "",
112621
- "declarations": [
112622
- {
112623
- "name": "args",
112624
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112625
- }
112626
- ],
112627
- "tags": {}
112628
- }
112629
- ],
112630
- "members": [],
112631
- "returnType": {
112632
- "kind": "infer",
112633
- "value": {
112634
- "kind": "typeParameter",
112635
- "name": "TProps",
112636
- "required": true
112637
- }
112638
- }
112639
- },
112640
- "trueType": {
112641
- "kind": "type",
112642
- "typeParameters": [
112643
- {
112644
- "kind": "typeParameter",
112645
- "name": "T",
112646
- "required": true
112647
- }
112648
- ],
112649
- "value": {
112650
- "kind": "unknown",
112651
- "value": "unknown",
112652
- "text": "{[K in keyof T]: Exclude<T[K], null>}"
112653
- }
112654
- },
112655
- "falseType": {
112656
- "kind": "object",
112657
- "properties": [
112658
- {
112659
- "kind": "property",
112660
- "name": "ref",
112661
- "required": true,
112662
- "type": {
112663
- "kind": "generic",
112664
- "name": "ExtractRef"
112665
- },
112666
- "description": "",
112667
- "declarations": [
112668
- {
112669
- "name": "ref",
112670
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112671
- }
112672
- ],
112673
- "tags": {}
112674
- }
112675
- ]
112676
- }
112677
- }
112678
- },
112679
- {
112680
- "kind": "parenthesis",
112681
- "value": {
112682
- "kind": "conditional",
112683
- "check": {
112684
- "kind": "generic",
112685
- "name": "Props"
112686
- },
112687
- "extends": {
112688
- "kind": "object",
112689
- "properties": [
112690
- {
112691
- "kind": "property",
112692
- "name": "children",
112693
- "required": true,
112694
- "type": {
112695
- "kind": "primitive",
112696
- "value": "any"
112697
- },
112698
- "description": "",
112699
- "declarations": [
112700
- {
112701
- "name": "children",
112702
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112703
- }
112704
- ],
112705
- "tags": {}
112706
- }
112707
- ]
112708
- },
112709
- "trueType": {
112710
- "kind": "object",
112711
- "properties": []
112712
- },
112713
- "falseType": {
112714
- "kind": "object",
112715
- "properties": [
112716
- {
112717
- "kind": "property",
112718
- "name": "children",
112719
- "required": false,
112720
- "type": {
112721
- "kind": "external",
112722
- "name": "ReactNode",
112723
- "url": "https://reactjs.org/docs/rendering-elements.html"
112724
- },
112725
- "description": "",
112726
- "declarations": [
112727
- {
112728
- "name": "children",
112729
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112730
- }
112731
- ],
112732
- "tags": {}
112733
- }
112734
- ]
112735
- }
112736
- }
112737
- }
112738
- ]
112739
- }
112740
- },
112741
- "required": true,
112742
- "rest": false,
112743
- "description": "",
112744
- "declarations": [
112745
- {
112746
- "name": "props",
112747
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112748
- }
112749
- ],
112750
- "tags": {}
112751
- },
111915
+ "kind": "component",
111916
+ "props": [
112752
111917
  {
112753
- "kind": "parameter",
112754
- "name": "Element",
112755
- "type": {
112756
- "kind": "conditional",
112757
- "check": {
112758
- "kind": "generic",
112759
- "name": "E"
112760
- },
112761
- "extends": {
112762
- "kind": "primitive",
112763
- "value": "undefined"
112764
- },
112765
- "trueType": {
112766
- "kind": "primitive",
112767
- "value": "never"
112768
- },
112769
- "falseType": {
112770
- "kind": "generic",
112771
- "name": "E"
112772
- }
112773
- },
111918
+ "kind": "property",
111919
+ "name": "ref",
112774
111920
  "required": true,
112775
- "rest": false,
112776
- "description": "",
112777
- "declarations": [
112778
- {
112779
- "name": "Element",
112780
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112781
- }
112782
- ],
112783
- "tags": {}
112784
- },
112785
- {
112786
- "kind": "parameter",
112787
- "name": "model",
112788
111921
  "type": {
112789
- "kind": "conditional",
112790
- "check": {
112791
- "kind": "generic",
112792
- "name": "TModelHook"
112793
- },
112794
- "extends": {
112795
- "kind": "function",
112796
- "parameters": [
112797
- {
112798
- "kind": "parameter",
112799
- "name": "args",
112800
- "type": {
112801
- "kind": "array",
112802
- "value": {
112803
- "kind": "primitive",
112804
- "value": "any"
112805
- }
112806
- },
112807
- "required": true,
112808
- "rest": true,
112809
- "description": "",
112810
- "declarations": [
112811
- {
112812
- "name": "args",
112813
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112814
- }
112815
- ],
112816
- "tags": {}
112817
- }
112818
- ],
112819
- "members": [],
112820
- "returnType": {
112821
- "kind": "infer",
112822
- "value": {
112823
- "kind": "typeParameter",
112824
- "name": "TModel",
112825
- "required": true
112826
- }
112827
- }
112828
- },
112829
- "trueType": {
112830
- "kind": "generic",
112831
- "name": "TModel"
112832
- },
112833
- "falseType": {
112834
- "kind": "primitive",
112835
- "value": "never"
112836
- }
111922
+ "kind": "generic",
111923
+ "name": "ExtractRef"
112837
111924
  },
112838
- "required": true,
112839
- "rest": false,
112840
111925
  "description": "",
112841
111926
  "declarations": [
112842
111927
  {
112843
- "name": "model",
111928
+ "name": "ref",
112844
111929
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
112845
111930
  }
112846
111931
  ],
112847
111932
  "tags": {}
112848
111933
  }
112849
- ],
112850
- "members": [],
112851
- "returnType": {
112852
- "kind": "union",
112853
- "value": [
112854
- {
112855
- "kind": "external",
112856
- "name": "Element",
112857
- "url": "https://reactjs.org/docs/rendering-elements.html"
112858
- },
112859
- {
112860
- "kind": "primitive",
112861
- "value": "null"
112862
- }
112863
- ]
112864
- }
111934
+ ]
112865
111935
  },
112866
111936
  "required": true,
112867
111937
  "rest": false,
@@ -113103,9 +112173,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
113103
112173
  "name": "Component",
113104
112174
  "required": true,
113105
112175
  "type": {
113106
- "kind": "unknown",
113107
- "value": "unknown",
113108
- "text": "interface RefForwardingComponent<T, P = {}> {\n (\n props: React.PropsWithChildren<P>,\n /**\n * A ref to be forwarded. Pass it along to the root element. If no element was passed, this\n * will result in a `never`\n */\n ref: ExtractRef<T>,\n /**\n * An element - either a JSX element or a `ElementComponent`. This should be passed as an `as`\n * to a root element or be the root element. If no element was passed, this will result in a\n * `never`\n */\n Element: T extends undefined ? never : T\n ): JSX.Element | null;\n}"
112176
+ "kind": "symbol",
112177
+ "name": "RefForwardingComponent",
112178
+ "value": "RefForwardingComponent<E, P>"
113109
112179
  },
113110
112180
  "description": "The component function. The function looks like:",
113111
112181
  "declarations": [
@@ -114972,78 +114042,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
114972
114042
  "name": "H2"
114973
114043
  },
114974
114044
  "extends": {
114975
- "kind": "object",
114976
- "properties": [
114045
+ "kind": "symbol",
114046
+ "name": "BaseHook",
114047
+ "typeParameters": [
114977
114048
  {
114978
- "kind": "property",
114979
- "name": "__model",
114980
- "required": true,
114981
- "type": {
114982
- "kind": "generic",
114983
- "name": "M"
114984
- },
114985
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
114986
- "declarations": [
114987
- {
114988
- "name": "__model",
114989
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
114990
- }
114991
- ],
114992
- "tags": {
114993
- "private": ""
114994
- }
114049
+ "kind": "primitive",
114050
+ "value": "any"
114995
114051
  },
114996
114052
  {
114997
- "kind": "property",
114998
- "name": "__output",
114999
- "required": true,
115000
- "type": {
115001
- "kind": "generic",
115002
- "name": "O"
115003
- },
115004
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115005
- "declarations": [
115006
- {
115007
- "name": "__output",
115008
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115009
- }
115010
- ],
115011
- "tags": {
115012
- "private": ""
114053
+ "kind": "infer",
114054
+ "value": {
114055
+ "kind": "typeParameter",
114056
+ "name": "O2",
114057
+ "required": true
115013
114058
  }
115014
114059
  }
115015
114060
  ],
115016
- "typeParameters": [
115017
- {
115018
- "kind": "typeParameter",
115019
- "name": "M",
115020
- "constraint": {
115021
- "kind": "symbol",
115022
- "name": "Model",
115023
- "typeParameters": [
115024
- {
115025
- "kind": "primitive",
115026
- "value": "any"
115027
- },
115028
- {
115029
- "kind": "primitive",
115030
- "value": "any"
115031
- }
115032
- ],
115033
- "value": "Model<State, Events>"
115034
- },
115035
- "required": true
115036
- },
115037
- {
115038
- "kind": "typeParameter",
115039
- "name": "O",
115040
- "constraint": {
115041
- "kind": "object",
115042
- "properties": []
115043
- },
115044
- "required": true
115045
- }
115046
- ]
114061
+ "value": "BaseHook<M, O>"
115047
114062
  },
115048
114063
  "trueType": {
115049
114064
  "kind": "conditional",
@@ -115052,78 +114067,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115052
114067
  "name": "H3"
115053
114068
  },
115054
114069
  "extends": {
115055
- "kind": "object",
115056
- "properties": [
114070
+ "kind": "symbol",
114071
+ "name": "BaseHook",
114072
+ "typeParameters": [
115057
114073
  {
115058
- "kind": "property",
115059
- "name": "__model",
115060
- "required": true,
115061
- "type": {
115062
- "kind": "generic",
115063
- "name": "M"
115064
- },
115065
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115066
- "declarations": [
115067
- {
115068
- "name": "__model",
115069
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115070
- }
115071
- ],
115072
- "tags": {
115073
- "private": ""
115074
- }
114074
+ "kind": "primitive",
114075
+ "value": "any"
115075
114076
  },
115076
114077
  {
115077
- "kind": "property",
115078
- "name": "__output",
115079
- "required": true,
115080
- "type": {
115081
- "kind": "generic",
115082
- "name": "O"
115083
- },
115084
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115085
- "declarations": [
115086
- {
115087
- "name": "__output",
115088
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115089
- }
115090
- ],
115091
- "tags": {
115092
- "private": ""
114078
+ "kind": "infer",
114079
+ "value": {
114080
+ "kind": "typeParameter",
114081
+ "name": "O3",
114082
+ "required": true
115093
114083
  }
115094
114084
  }
115095
114085
  ],
115096
- "typeParameters": [
115097
- {
115098
- "kind": "typeParameter",
115099
- "name": "M",
115100
- "constraint": {
115101
- "kind": "symbol",
115102
- "name": "Model",
115103
- "typeParameters": [
115104
- {
115105
- "kind": "primitive",
115106
- "value": "any"
115107
- },
115108
- {
115109
- "kind": "primitive",
115110
- "value": "any"
115111
- }
115112
- ],
115113
- "value": "Model<State, Events>"
115114
- },
115115
- "required": true
115116
- },
115117
- {
115118
- "kind": "typeParameter",
115119
- "name": "O",
115120
- "constraint": {
115121
- "kind": "object",
115122
- "properties": []
115123
- },
115124
- "required": true
115125
- }
115126
- ]
114086
+ "value": "BaseHook<M, O>"
115127
114087
  },
115128
114088
  "trueType": {
115129
114089
  "kind": "conditional",
@@ -115132,78 +114092,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115132
114092
  "name": "H4"
115133
114093
  },
115134
114094
  "extends": {
115135
- "kind": "object",
115136
- "properties": [
114095
+ "kind": "symbol",
114096
+ "name": "BaseHook",
114097
+ "typeParameters": [
115137
114098
  {
115138
- "kind": "property",
115139
- "name": "__model",
115140
- "required": true,
115141
- "type": {
115142
- "kind": "generic",
115143
- "name": "M"
115144
- },
115145
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115146
- "declarations": [
115147
- {
115148
- "name": "__model",
115149
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115150
- }
115151
- ],
115152
- "tags": {
115153
- "private": ""
115154
- }
114099
+ "kind": "primitive",
114100
+ "value": "any"
115155
114101
  },
115156
114102
  {
115157
- "kind": "property",
115158
- "name": "__output",
115159
- "required": true,
115160
- "type": {
115161
- "kind": "generic",
115162
- "name": "O"
115163
- },
115164
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115165
- "declarations": [
115166
- {
115167
- "name": "__output",
115168
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115169
- }
115170
- ],
115171
- "tags": {
115172
- "private": ""
114103
+ "kind": "infer",
114104
+ "value": {
114105
+ "kind": "typeParameter",
114106
+ "name": "O4",
114107
+ "required": true
115173
114108
  }
115174
114109
  }
115175
114110
  ],
115176
- "typeParameters": [
115177
- {
115178
- "kind": "typeParameter",
115179
- "name": "M",
115180
- "constraint": {
115181
- "kind": "symbol",
115182
- "name": "Model",
115183
- "typeParameters": [
115184
- {
115185
- "kind": "primitive",
115186
- "value": "any"
115187
- },
115188
- {
115189
- "kind": "primitive",
115190
- "value": "any"
115191
- }
115192
- ],
115193
- "value": "Model<State, Events>"
115194
- },
115195
- "required": true
115196
- },
115197
- {
115198
- "kind": "typeParameter",
115199
- "name": "O",
115200
- "constraint": {
115201
- "kind": "object",
115202
- "properties": []
115203
- },
115204
- "required": true
115205
- }
115206
- ]
114111
+ "value": "BaseHook<M, O>"
115207
114112
  },
115208
114113
  "trueType": {
115209
114114
  "kind": "conditional",
@@ -115212,78 +114117,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115212
114117
  "name": "H5"
115213
114118
  },
115214
114119
  "extends": {
115215
- "kind": "object",
115216
- "properties": [
114120
+ "kind": "symbol",
114121
+ "name": "BaseHook",
114122
+ "typeParameters": [
115217
114123
  {
115218
- "kind": "property",
115219
- "name": "__model",
115220
- "required": true,
115221
- "type": {
115222
- "kind": "generic",
115223
- "name": "M"
115224
- },
115225
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115226
- "declarations": [
115227
- {
115228
- "name": "__model",
115229
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115230
- }
115231
- ],
115232
- "tags": {
115233
- "private": ""
115234
- }
114124
+ "kind": "primitive",
114125
+ "value": "any"
115235
114126
  },
115236
114127
  {
115237
- "kind": "property",
115238
- "name": "__output",
115239
- "required": true,
115240
- "type": {
115241
- "kind": "generic",
115242
- "name": "O"
115243
- },
115244
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115245
- "declarations": [
115246
- {
115247
- "name": "__output",
115248
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115249
- }
115250
- ],
115251
- "tags": {
115252
- "private": ""
114128
+ "kind": "infer",
114129
+ "value": {
114130
+ "kind": "typeParameter",
114131
+ "name": "O5",
114132
+ "required": true
115253
114133
  }
115254
114134
  }
115255
114135
  ],
115256
- "typeParameters": [
115257
- {
115258
- "kind": "typeParameter",
115259
- "name": "M",
115260
- "constraint": {
115261
- "kind": "symbol",
115262
- "name": "Model",
115263
- "typeParameters": [
115264
- {
115265
- "kind": "primitive",
115266
- "value": "any"
115267
- },
115268
- {
115269
- "kind": "primitive",
115270
- "value": "any"
115271
- }
115272
- ],
115273
- "value": "Model<State, Events>"
115274
- },
115275
- "required": true
115276
- },
115277
- {
115278
- "kind": "typeParameter",
115279
- "name": "O",
115280
- "constraint": {
115281
- "kind": "object",
115282
- "properties": []
115283
- },
115284
- "required": true
115285
- }
115286
- ]
114136
+ "value": "BaseHook<M, O>"
115287
114137
  },
115288
114138
  "trueType": {
115289
114139
  "kind": "conditional",
@@ -115292,78 +114142,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
115292
114142
  "name": "H6"
115293
114143
  },
115294
114144
  "extends": {
115295
- "kind": "object",
115296
- "properties": [
114145
+ "kind": "symbol",
114146
+ "name": "BaseHook",
114147
+ "typeParameters": [
115297
114148
  {
115298
- "kind": "property",
115299
- "name": "__model",
115300
- "required": true,
115301
- "type": {
115302
- "kind": "generic",
115303
- "name": "M"
115304
- },
115305
- "description": "Capture the model type in TypeScript only. Do not use in runtime!",
115306
- "declarations": [
115307
- {
115308
- "name": "__model",
115309
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115310
- }
115311
- ],
115312
- "tags": {
115313
- "private": ""
115314
- }
114149
+ "kind": "primitive",
114150
+ "value": "any"
115315
114151
  },
115316
114152
  {
115317
- "kind": "property",
115318
- "name": "__output",
115319
- "required": true,
115320
- "type": {
115321
- "kind": "generic",
115322
- "name": "O"
115323
- },
115324
- "description": "Capture the hook's output type in TypeScript only. Do not use in runtime! This is used to cache\nand speed up the output types during inference",
115325
- "declarations": [
115326
- {
115327
- "name": "__output",
115328
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
115329
- }
115330
- ],
115331
- "tags": {
115332
- "private": ""
114153
+ "kind": "infer",
114154
+ "value": {
114155
+ "kind": "typeParameter",
114156
+ "name": "O6",
114157
+ "required": true
115333
114158
  }
115334
114159
  }
115335
114160
  ],
115336
- "typeParameters": [
115337
- {
115338
- "kind": "typeParameter",
115339
- "name": "M",
115340
- "constraint": {
115341
- "kind": "symbol",
115342
- "name": "Model",
115343
- "typeParameters": [
115344
- {
115345
- "kind": "primitive",
115346
- "value": "any"
115347
- },
115348
- {
115349
- "kind": "primitive",
115350
- "value": "any"
115351
- }
115352
- ],
115353
- "value": "Model<State, Events>"
115354
- },
115355
- "required": true
115356
- },
115357
- {
115358
- "kind": "typeParameter",
115359
- "name": "O",
115360
- "constraint": {
115361
- "kind": "object",
115362
- "properties": []
115363
- },
115364
- "required": true
115365
- }
115366
- ]
114161
+ "value": "BaseHook<M, O>"
115367
114162
  },
115368
114163
  "trueType": {
115369
114164
  "kind": "symbol",
@@ -116785,45 +115580,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116785
115580
  "kind": "typeParameter",
116786
115581
  "name": "TEvents",
116787
115582
  "constraint": {
116788
- "kind": "object",
116789
- "properties": [],
116790
- "indexSignature": {
116791
- "kind": "indexSignature",
116792
- "name": "key",
116793
- "type": {
116794
- "kind": "primitive",
116795
- "value": "string"
116796
- },
116797
- "value": {
116798
- "kind": "function",
116799
- "parameters": [
116800
- {
116801
- "kind": "parameter",
116802
- "name": "data",
116803
- "type": {
116804
- "kind": "unknown",
116805
- "value": "unknown",
116806
- "text": "object"
116807
- },
116808
- "required": false,
116809
- "rest": false,
116810
- "description": "",
116811
- "declarations": [
116812
- {
116813
- "name": "data",
116814
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116815
- }
116816
- ],
116817
- "tags": {}
116818
- }
116819
- ],
116820
- "members": [],
116821
- "returnType": {
116822
- "kind": "primitive",
116823
- "value": "void"
116824
- }
116825
- }
116826
- }
115583
+ "kind": "symbol",
115584
+ "name": "IEvent",
115585
+ "value": "IEvent"
116827
115586
  },
116828
115587
  "required": true
116829
115588
  },
@@ -116878,198 +115637,14 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
116878
115637
  "kind": "intersection",
116879
115638
  "value": [
116880
115639
  {
116881
- "kind": "type",
116882
- "typeParameters": [
116883
- {
116884
- "kind": "typeParameter",
116885
- "name": "TState",
116886
- "constraint": {
116887
- "kind": "external",
116888
- "name": "Record",
116889
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116890
- "typeParameters": [
116891
- {
116892
- "kind": "primitive",
116893
- "value": "string"
116894
- },
116895
- {
116896
- "kind": "primitive",
116897
- "value": "any"
116898
- }
116899
- ]
116900
- },
116901
- "required": true
116902
- },
116903
- {
116904
- "kind": "typeParameter",
116905
- "name": "TEvents",
116906
- "constraint": {
116907
- "kind": "object",
116908
- "properties": [],
116909
- "indexSignature": {
116910
- "kind": "indexSignature",
116911
- "name": "key",
116912
- "type": {
116913
- "kind": "primitive",
116914
- "value": "string"
116915
- },
116916
- "value": {
116917
- "kind": "function",
116918
- "parameters": [
116919
- {
116920
- "kind": "parameter",
116921
- "name": "data",
116922
- "type": {
116923
- "kind": "unknown",
116924
- "value": "unknown",
116925
- "text": "object"
116926
- },
116927
- "required": false,
116928
- "rest": false,
116929
- "description": "",
116930
- "declarations": [
116931
- {
116932
- "name": "data",
116933
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
116934
- }
116935
- ],
116936
- "tags": {}
116937
- }
116938
- ],
116939
- "members": [],
116940
- "returnType": {
116941
- "kind": "primitive",
116942
- "value": "void"
116943
- }
116944
- }
116945
- }
116946
- },
116947
- "required": true
116948
- },
116949
- {
116950
- "kind": "typeParameter",
116951
- "name": "TGuardMap",
116952
- "constraint": {
116953
- "kind": "external",
116954
- "name": "Record",
116955
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116956
- "typeParameters": [
116957
- {
116958
- "kind": "primitive",
116959
- "value": "string"
116960
- },
116961
- {
116962
- "kind": "unknown",
116963
- "value": "unknown",
116964
- "text": "keyof TEvents"
116965
- }
116966
- ]
116967
- },
116968
- "required": true
116969
- }
116970
- ],
116971
- "value": {
116972
- "kind": "unknown",
116973
- "value": "unknown",
116974
- "text": "{\n [K in keyof TGuardMap]: (event: {\n data: Parameters<TEvents[TGuardMap[K]]>[0];\n state: TState;\n }) => boolean;\n}"
116975
- }
115640
+ "kind": "symbol",
115641
+ "name": "ToGuardConfig",
115642
+ "value": "ToGuardConfig<TState, TEvents, TEventMap[\"guards\"]>"
116976
115643
  },
116977
115644
  {
116978
- "kind": "type",
116979
- "typeParameters": [
116980
- {
116981
- "kind": "typeParameter",
116982
- "name": "TState",
116983
- "constraint": {
116984
- "kind": "external",
116985
- "name": "Record",
116986
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
116987
- "typeParameters": [
116988
- {
116989
- "kind": "primitive",
116990
- "value": "string"
116991
- },
116992
- {
116993
- "kind": "primitive",
116994
- "value": "any"
116995
- }
116996
- ]
116997
- },
116998
- "required": true
116999
- },
117000
- {
117001
- "kind": "typeParameter",
117002
- "name": "TEvents",
117003
- "constraint": {
117004
- "kind": "object",
117005
- "properties": [],
117006
- "indexSignature": {
117007
- "kind": "indexSignature",
117008
- "name": "key",
117009
- "type": {
117010
- "kind": "primitive",
117011
- "value": "string"
117012
- },
117013
- "value": {
117014
- "kind": "function",
117015
- "parameters": [
117016
- {
117017
- "kind": "parameter",
117018
- "name": "data",
117019
- "type": {
117020
- "kind": "unknown",
117021
- "value": "unknown",
117022
- "text": "object"
117023
- },
117024
- "required": false,
117025
- "rest": false,
117026
- "description": "",
117027
- "declarations": [
117028
- {
117029
- "name": "data",
117030
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117031
- }
117032
- ],
117033
- "tags": {}
117034
- }
117035
- ],
117036
- "members": [],
117037
- "returnType": {
117038
- "kind": "primitive",
117039
- "value": "void"
117040
- }
117041
- }
117042
- }
117043
- },
117044
- "required": true
117045
- },
117046
- {
117047
- "kind": "typeParameter",
117048
- "name": "TCallbackMap",
117049
- "constraint": {
117050
- "kind": "external",
117051
- "name": "Record",
117052
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117053
- "typeParameters": [
117054
- {
117055
- "kind": "primitive",
117056
- "value": "string"
117057
- },
117058
- {
117059
- "kind": "unknown",
117060
- "value": "unknown",
117061
- "text": "keyof TEvents"
117062
- }
117063
- ]
117064
- },
117065
- "required": true
117066
- }
117067
- ],
117068
- "value": {
117069
- "kind": "unknown",
117070
- "value": "unknown",
117071
- "text": "{\n [K in keyof TCallbackMap]: (event: {\n data: Parameters<TEvents[TCallbackMap[K]]>[0];\n /**\n * Callbacks are called during the `setState` phase in React. This means the state has not\n * resolved yet. This is a good time to add more `setState` calls which will be added to React's\n * state batch updates, but it also means the state provided here hasn't been updated yet.\n */\n prevState: TState;\n }) => void;\n}"
117072
- }
115645
+ "kind": "symbol",
115646
+ "name": "ToCallbackConfig",
115647
+ "value": "ToCallbackConfig<TState, TEvents, TEventMap[\"callbacks\"]>"
117073
115648
  }
117074
115649
  ]
117075
115650
  }
@@ -117238,45 +115813,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117238
115813
  "kind": "typeParameter",
117239
115814
  "name": "TEvents",
117240
115815
  "constraint": {
117241
- "kind": "object",
117242
- "properties": [],
117243
- "indexSignature": {
117244
- "kind": "indexSignature",
117245
- "name": "key",
117246
- "type": {
117247
- "kind": "primitive",
117248
- "value": "string"
117249
- },
117250
- "value": {
117251
- "kind": "function",
117252
- "parameters": [
117253
- {
117254
- "kind": "parameter",
117255
- "name": "data",
117256
- "type": {
117257
- "kind": "unknown",
117258
- "value": "unknown",
117259
- "text": "object"
117260
- },
117261
- "required": false,
117262
- "rest": false,
117263
- "description": "",
117264
- "declarations": [
117265
- {
117266
- "name": "data",
117267
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117268
- }
117269
- ],
117270
- "tags": {}
117271
- }
117272
- ],
117273
- "members": [],
117274
- "returnType": {
117275
- "kind": "primitive",
117276
- "value": "void"
117277
- }
117278
- }
117279
- }
115816
+ "kind": "symbol",
115817
+ "name": "IEvent",
115818
+ "value": "IEvent"
117280
115819
  },
117281
115820
  "required": true
117282
115821
  },
@@ -117341,133 +115880,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117341
115880
  ],
117342
115881
  "members": [],
117343
115882
  "returnType": {
117344
- "kind": "object",
117345
- "properties": [
117346
- {
117347
- "kind": "property",
117348
- "name": "guards",
117349
- "required": true,
117350
- "type": {
117351
- "kind": "generic",
117352
- "name": "TGuardMap"
117353
- },
117354
- "description": "",
117355
- "declarations": [
117356
- {
117357
- "name": "guards",
117358
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117359
- }
117360
- ],
117361
- "tags": {}
117362
- },
117363
- {
117364
- "kind": "property",
117365
- "name": "callbacks",
117366
- "required": true,
117367
- "type": {
117368
- "kind": "generic",
117369
- "name": "TCallbackMap"
117370
- },
117371
- "description": "",
117372
- "declarations": [
117373
- {
117374
- "name": "callbacks",
117375
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117376
- }
117377
- ],
117378
- "tags": {}
117379
- }
117380
- ],
115883
+ "kind": "symbol",
115884
+ "name": "EventMap",
117381
115885
  "typeParameters": [
117382
115886
  {
117383
- "kind": "typeParameter",
117384
- "name": "TEvents",
117385
- "constraint": {
117386
- "kind": "object",
117387
- "properties": [],
117388
- "indexSignature": {
117389
- "kind": "indexSignature",
117390
- "name": "key",
117391
- "type": {
117392
- "kind": "primitive",
117393
- "value": "string"
117394
- },
117395
- "value": {
117396
- "kind": "function",
117397
- "parameters": [
117398
- {
117399
- "kind": "parameter",
117400
- "name": "data",
117401
- "type": {
117402
- "kind": "unknown",
117403
- "value": "unknown",
117404
- "text": "object"
117405
- },
117406
- "required": false,
117407
- "rest": false,
117408
- "description": "",
117409
- "declarations": [
117410
- {
117411
- "name": "data",
117412
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117413
- }
117414
- ],
117415
- "tags": {}
117416
- }
117417
- ],
117418
- "members": [],
117419
- "returnType": {
117420
- "kind": "primitive",
117421
- "value": "void"
117422
- }
117423
- }
117424
- }
117425
- },
117426
- "required": true
115887
+ "kind": "generic",
115888
+ "name": "TEvents"
117427
115889
  },
117428
115890
  {
117429
- "kind": "typeParameter",
117430
- "name": "TGuardMap",
117431
- "constraint": {
117432
- "kind": "external",
117433
- "name": "Record",
117434
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117435
- "typeParameters": [
117436
- {
117437
- "kind": "primitive",
117438
- "value": "string"
117439
- },
117440
- {
117441
- "kind": "unknown",
117442
- "value": "unknown",
117443
- "text": "keyof TEvents"
117444
- }
117445
- ]
117446
- },
117447
- "required": true
115891
+ "kind": "generic",
115892
+ "name": "TGuardMap"
117448
115893
  },
117449
115894
  {
117450
- "kind": "typeParameter",
117451
- "name": "TCallbackMap",
117452
- "constraint": {
117453
- "kind": "external",
117454
- "name": "Record",
117455
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117456
- "typeParameters": [
117457
- {
117458
- "kind": "primitive",
117459
- "value": "string"
117460
- },
117461
- {
117462
- "kind": "unknown",
117463
- "value": "unknown",
117464
- "text": "keyof TEvents"
117465
- }
117466
- ]
117467
- },
117468
- "required": true
115895
+ "kind": "generic",
115896
+ "name": "TCallbackMap"
117469
115897
  }
117470
- ]
115898
+ ],
115899
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117471
115900
  }
117472
115901
  }
117473
115902
  }
@@ -117660,45 +116089,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117660
116089
  "kind": "typeParameter",
117661
116090
  "name": "TEvents",
117662
116091
  "constraint": {
117663
- "kind": "object",
117664
- "properties": [],
117665
- "indexSignature": {
117666
- "kind": "indexSignature",
117667
- "name": "key",
117668
- "type": {
117669
- "kind": "primitive",
117670
- "value": "string"
117671
- },
117672
- "value": {
117673
- "kind": "function",
117674
- "parameters": [
117675
- {
117676
- "kind": "parameter",
117677
- "name": "data",
117678
- "type": {
117679
- "kind": "unknown",
117680
- "value": "unknown",
117681
- "text": "object"
117682
- },
117683
- "required": false,
117684
- "rest": false,
117685
- "description": "",
117686
- "declarations": [
117687
- {
117688
- "name": "data",
117689
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117690
- }
117691
- ],
117692
- "tags": {}
117693
- }
117694
- ],
117695
- "members": [],
117696
- "returnType": {
117697
- "kind": "primitive",
117698
- "value": "void"
117699
- }
117700
- }
117701
- }
116092
+ "kind": "symbol",
116093
+ "name": "IEvent",
116094
+ "value": "IEvent"
117702
116095
  },
117703
116096
  "required": true
117704
116097
  },
@@ -117760,133 +116153,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
117760
116153
  "kind": "parameter",
117761
116154
  "name": "eventMap",
117762
116155
  "type": {
117763
- "kind": "object",
117764
- "properties": [
117765
- {
117766
- "kind": "property",
117767
- "name": "guards",
117768
- "required": true,
117769
- "type": {
117770
- "kind": "generic",
117771
- "name": "TGuardMap"
117772
- },
117773
- "description": "",
117774
- "declarations": [
117775
- {
117776
- "name": "guards",
117777
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117778
- }
117779
- ],
117780
- "tags": {}
117781
- },
117782
- {
117783
- "kind": "property",
117784
- "name": "callbacks",
117785
- "required": true,
117786
- "type": {
117787
- "kind": "generic",
117788
- "name": "TCallbackMap"
117789
- },
117790
- "description": "",
117791
- "declarations": [
117792
- {
117793
- "name": "callbacks",
117794
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117795
- }
117796
- ],
117797
- "tags": {}
117798
- }
117799
- ],
116156
+ "kind": "symbol",
116157
+ "name": "EventMap",
117800
116158
  "typeParameters": [
117801
116159
  {
117802
- "kind": "typeParameter",
117803
- "name": "TEvents",
117804
- "constraint": {
117805
- "kind": "object",
117806
- "properties": [],
117807
- "indexSignature": {
117808
- "kind": "indexSignature",
117809
- "name": "key",
117810
- "type": {
117811
- "kind": "primitive",
117812
- "value": "string"
117813
- },
117814
- "value": {
117815
- "kind": "function",
117816
- "parameters": [
117817
- {
117818
- "kind": "parameter",
117819
- "name": "data",
117820
- "type": {
117821
- "kind": "unknown",
117822
- "value": "unknown",
117823
- "text": "object"
117824
- },
117825
- "required": false,
117826
- "rest": false,
117827
- "description": "",
117828
- "declarations": [
117829
- {
117830
- "name": "data",
117831
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
117832
- }
117833
- ],
117834
- "tags": {}
117835
- }
117836
- ],
117837
- "members": [],
117838
- "returnType": {
117839
- "kind": "primitive",
117840
- "value": "void"
117841
- }
117842
- }
117843
- }
117844
- },
117845
- "required": true
116160
+ "kind": "generic",
116161
+ "name": "TEvents"
117846
116162
  },
117847
116163
  {
117848
- "kind": "typeParameter",
117849
- "name": "TGuardMap",
117850
- "constraint": {
117851
- "kind": "external",
117852
- "name": "Record",
117853
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117854
- "typeParameters": [
117855
- {
117856
- "kind": "primitive",
117857
- "value": "string"
117858
- },
117859
- {
117860
- "kind": "unknown",
117861
- "value": "unknown",
117862
- "text": "keyof TEvents"
117863
- }
117864
- ]
117865
- },
117866
- "required": true
116164
+ "kind": "generic",
116165
+ "name": "TGuardMap"
117867
116166
  },
117868
116167
  {
117869
- "kind": "typeParameter",
117870
- "name": "TCallbackMap",
117871
- "constraint": {
117872
- "kind": "external",
117873
- "name": "Record",
117874
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
117875
- "typeParameters": [
117876
- {
117877
- "kind": "primitive",
117878
- "value": "string"
117879
- },
117880
- {
117881
- "kind": "unknown",
117882
- "value": "unknown",
117883
- "text": "keyof TEvents"
117884
- }
117885
- ]
117886
- },
117887
- "required": true
116168
+ "kind": "generic",
116169
+ "name": "TCallbackMap"
117888
116170
  }
117889
- ]
116171
+ ],
116172
+ "value": "EventMap<TEvents, TGuardMap, TCallbackMap>"
117890
116173
  },
117891
116174
  "required": true,
117892
116175
  "rest": false,
@@ -118263,48 +116546,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118263
116546
  "kind": "typeParameter",
118264
116547
  "name": "TEvents",
118265
116548
  "constraint": {
118266
- "kind": "object",
118267
- "properties": [],
118268
- "indexSignature": {
118269
- "kind": "indexSignature",
118270
- "name": "key",
118271
- "type": {
118272
- "kind": "primitive",
118273
- "value": "string"
118274
- },
118275
- "value": {
118276
- "kind": "function",
118277
- "parameters": [
118278
- {
118279
- "kind": "parameter",
118280
- "name": "args",
118281
- "type": {
118282
- "kind": "array",
118283
- "value": {
118284
- "kind": "primitive",
118285
- "value": "any"
118286
- }
118287
- },
118288
- "required": true,
118289
- "rest": true,
118290
- "description": "",
118291
- "declarations": [
118292
- {
118293
- "name": "args",
118294
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118295
- }
118296
- ],
118297
- "tags": {}
118298
- }
118299
- ],
118300
- "members": [],
118301
- "returnType": {
118302
- "kind": "unknown",
118303
- "value": "unknown",
118304
- "text": "object"
118305
- }
118306
- }
118307
- }
116549
+ "kind": "symbol",
116550
+ "name": "EventCreator",
116551
+ "value": "EventCreator"
118308
116552
  },
118309
116553
  "required": true
118310
116554
  },
@@ -118326,133 +116570,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
118326
116570
  "text": "config"
118327
116571
  },
118328
116572
  "type": {
118329
- "kind": "object",
118330
- "properties": [
118331
- {
118332
- "kind": "property",
118333
- "name": "guards",
118334
- "required": true,
118335
- "type": {
118336
- "kind": "generic",
118337
- "name": "TGuardMap"
118338
- },
118339
- "description": "",
118340
- "declarations": [
118341
- {
118342
- "name": "guards",
118343
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118344
- }
118345
- ],
118346
- "tags": {}
118347
- },
118348
- {
118349
- "kind": "property",
118350
- "name": "callbacks",
118351
- "required": true,
118352
- "type": {
118353
- "kind": "generic",
118354
- "name": "TCallbackMap"
118355
- },
118356
- "description": "",
118357
- "declarations": [
118358
- {
118359
- "name": "callbacks",
118360
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118361
- }
118362
- ],
118363
- "tags": {}
118364
- }
118365
- ],
118366
- "typeParameters": [
118367
- {
118368
- "kind": "typeParameter",
118369
- "name": "TEvents",
118370
- "constraint": {
118371
- "kind": "object",
118372
- "properties": [],
118373
- "indexSignature": {
118374
- "kind": "indexSignature",
118375
- "name": "key",
118376
- "type": {
118377
- "kind": "primitive",
118378
- "value": "string"
118379
- },
118380
- "value": {
118381
- "kind": "function",
118382
- "parameters": [
118383
- {
118384
- "kind": "parameter",
118385
- "name": "data",
118386
- "type": {
118387
- "kind": "unknown",
118388
- "value": "unknown",
118389
- "text": "object"
118390
- },
118391
- "required": false,
118392
- "rest": false,
118393
- "description": "",
118394
- "declarations": [
118395
- {
118396
- "name": "data",
118397
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/models.ts"
118398
- }
118399
- ],
118400
- "tags": {}
118401
- }
118402
- ],
118403
- "members": [],
118404
- "returnType": {
118405
- "kind": "primitive",
118406
- "value": "void"
118407
- }
118408
- }
118409
- }
118410
- },
118411
- "required": true
118412
- },
118413
- {
118414
- "kind": "typeParameter",
118415
- "name": "TGuardMap",
118416
- "constraint": {
118417
- "kind": "external",
118418
- "name": "Record",
118419
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118420
- "typeParameters": [
118421
- {
118422
- "kind": "primitive",
118423
- "value": "string"
118424
- },
118425
- {
118426
- "kind": "unknown",
118427
- "value": "unknown",
118428
- "text": "keyof TEvents"
118429
- }
118430
- ]
118431
- },
118432
- "required": true
118433
- },
118434
- {
118435
- "kind": "typeParameter",
118436
- "name": "TCallbackMap",
118437
- "constraint": {
118438
- "kind": "external",
118439
- "name": "Record",
118440
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
118441
- "typeParameters": [
118442
- {
118443
- "kind": "primitive",
118444
- "value": "string"
118445
- },
118446
- {
118447
- "kind": "unknown",
118448
- "value": "unknown",
118449
- "text": "keyof TEvents"
118450
- }
118451
- ]
118452
- },
118453
- "required": true
118454
- }
118455
- ]
116573
+ "kind": "symbol",
116574
+ "name": "EventMap",
116575
+ "value": "EventMap<ToEvent<TEvents>, TGuardMap, TCallbackMap>"
118456
116576
  },
118457
116577
  "required": true,
118458
116578
  "description": "",
@@ -119693,25 +117813,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
119693
117813
  "parameters": [],
119694
117814
  "members": [],
119695
117815
  "returnType": {
119696
- "kind": "type",
119697
- "typeParameters": [],
119698
- "value": {
119699
- "kind": "union",
119700
- "value": [
119701
- {
119702
- "kind": "string",
119703
- "value": "mouse"
119704
- },
119705
- {
119706
- "kind": "string",
119707
- "value": "touch"
119708
- },
119709
- {
119710
- "kind": "string",
119711
- "value": "pen"
119712
- }
119713
- ]
119714
- }
117816
+ "kind": "symbol",
117817
+ "name": "Modality",
117818
+ "value": "Modality"
119715
117819
  }
119716
117820
  }
119717
117821
  },
@@ -162565,37 +160669,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162565
160669
  "kind": "parameter",
162566
160670
  "name": "__0",
162567
160671
  "type": {
162568
- "kind": "type",
162569
- "typeParameters": [],
162570
- "value": {
162571
- "kind": "symbol",
162572
- "name": "Pick",
162573
- "typeParameters": [
162574
- {
162575
- "kind": "symbol",
162576
- "name": "PaginationState",
162577
- "value": "PaginationState"
162578
- },
162579
- {
162580
- "kind": "union",
162581
- "value": [
162582
- {
162583
- "kind": "string",
162584
- "value": "currentPage"
162585
- },
162586
- {
162587
- "kind": "string",
162588
- "value": "lastPage"
162589
- },
162590
- {
162591
- "kind": "string",
162592
- "value": "rangeSize"
162593
- }
162594
- ]
162595
- }
162596
- ],
162597
- "value": "Pick<T, K>"
162598
- }
160672
+ "kind": "symbol",
160673
+ "name": "BuildPageRangeConfig",
160674
+ "value": "BuildPageRangeConfig"
162599
160675
  },
162600
160676
  "required": true,
162601
160677
  "rest": false,
@@ -162843,124 +160919,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
162843
160919
  "kind": "parameter",
162844
160920
  "name": "config",
162845
160921
  "defaultValue": {
162846
- "kind": "object",
162847
- "properties": [
162848
- {
162849
- "kind": "property",
162850
- "name": "aria-atomic",
162851
- "required": false,
162852
- "type": {
162853
- "kind": "union",
162854
- "value": [
162855
- {
162856
- "kind": "parenthesis",
162857
- "value": {
162858
- "kind": "union",
162859
- "value": [
162860
- {
162861
- "kind": "primitive",
162862
- "value": "boolean"
162863
- },
162864
- {
162865
- "kind": "string",
162866
- "value": "false"
162867
- },
162868
- {
162869
- "kind": "string",
162870
- "value": "true"
162871
- }
162872
- ]
162873
- }
162874
- },
162875
- {
162876
- "kind": "primitive",
162877
- "value": "undefined"
162878
- }
162879
- ]
162880
- },
162881
- "description": "",
162882
- "declarations": [
162883
- {
162884
- "name": "aria-atomic",
162885
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162886
- }
162887
- ],
162888
- "tags": {}
162889
- },
162890
- {
162891
- "kind": "property",
162892
- "name": "aria-live",
162893
- "required": false,
162894
- "type": {
162895
- "kind": "union",
162896
- "value": [
162897
- {
162898
- "kind": "string",
162899
- "value": "polite"
162900
- },
162901
- {
162902
- "kind": "string",
162903
- "value": "assertive"
162904
- }
162905
- ]
162906
- },
162907
- "description": "",
162908
- "declarations": [
162909
- {
162910
- "name": "aria-live",
162911
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162912
- }
162913
- ],
162914
- "tags": {}
162915
- },
162916
- {
162917
- "kind": "property",
162918
- "name": "role",
162919
- "required": false,
162920
- "type": {
162921
- "kind": "union",
162922
- "value": [
162923
- {
162924
- "kind": "string",
162925
- "value": "status"
162926
- },
162927
- {
162928
- "kind": "string",
162929
- "value": "alert"
162930
- },
162931
- {
162932
- "kind": "string",
162933
- "value": "log"
162934
- }
162935
- ]
162936
- },
162937
- "description": "",
162938
- "declarations": [
162939
- {
162940
- "name": "role",
162941
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162942
- }
162943
- ],
162944
- "tags": {}
162945
- },
162946
- {
162947
- "kind": "property",
162948
- "name": "shouldAnnounceToScreenReader",
162949
- "required": false,
162950
- "type": {
162951
- "kind": "primitive",
162952
- "value": "boolean"
162953
- },
162954
- "description": "",
162955
- "declarations": [
162956
- {
162957
- "name": "shouldAnnounceToScreenReader",
162958
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
162959
- }
162960
- ],
162961
- "tags": {}
162962
- }
162963
- ]
160922
+ "kind": "symbol",
160923
+ "name": "UseLiveRegionConfig",
160924
+ "value": "UseLiveRegionConfig"
162964
160925
  },
162965
160926
  "type": {
162966
160927
  "kind": "object",
@@ -163096,124 +161057,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
163096
161057
  ],
163097
161058
  "members": [],
163098
161059
  "returnType": {
163099
- "kind": "object",
163100
- "properties": [
163101
- {
163102
- "kind": "property",
163103
- "name": "aria-atomic",
163104
- "required": false,
163105
- "type": {
163106
- "kind": "union",
163107
- "value": [
163108
- {
163109
- "kind": "parenthesis",
163110
- "value": {
163111
- "kind": "union",
163112
- "value": [
163113
- {
163114
- "kind": "primitive",
163115
- "value": "boolean"
163116
- },
163117
- {
163118
- "kind": "string",
163119
- "value": "false"
163120
- },
163121
- {
163122
- "kind": "string",
163123
- "value": "true"
163124
- }
163125
- ]
163126
- }
163127
- },
163128
- {
163129
- "kind": "primitive",
163130
- "value": "undefined"
163131
- }
163132
- ]
163133
- },
163134
- "description": "",
163135
- "declarations": [
163136
- {
163137
- "name": "aria-atomic",
163138
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163139
- }
163140
- ],
163141
- "tags": {}
163142
- },
163143
- {
163144
- "kind": "property",
163145
- "name": "aria-live",
163146
- "required": false,
163147
- "type": {
163148
- "kind": "union",
163149
- "value": [
163150
- {
163151
- "kind": "string",
163152
- "value": "polite"
163153
- },
163154
- {
163155
- "kind": "string",
163156
- "value": "assertive"
163157
- }
163158
- ]
163159
- },
163160
- "description": "",
163161
- "declarations": [
163162
- {
163163
- "name": "aria-live",
163164
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163165
- }
163166
- ],
163167
- "tags": {}
163168
- },
163169
- {
163170
- "kind": "property",
163171
- "name": "role",
163172
- "required": false,
163173
- "type": {
163174
- "kind": "union",
163175
- "value": [
163176
- {
163177
- "kind": "string",
163178
- "value": "status"
163179
- },
163180
- {
163181
- "kind": "string",
163182
- "value": "alert"
163183
- },
163184
- {
163185
- "kind": "string",
163186
- "value": "log"
163187
- }
163188
- ]
163189
- },
163190
- "description": "",
163191
- "declarations": [
163192
- {
163193
- "name": "role",
163194
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163195
- }
163196
- ],
163197
- "tags": {}
163198
- },
163199
- {
163200
- "kind": "property",
163201
- "name": "shouldAnnounceToScreenReader",
163202
- "required": false,
163203
- "type": {
163204
- "kind": "primitive",
163205
- "value": "boolean"
163206
- },
163207
- "description": "",
163208
- "declarations": [
163209
- {
163210
- "name": "shouldAnnounceToScreenReader",
163211
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/pagination/lib/Pagination/common/useLiveRegion.tsx"
163212
- }
163213
- ],
163214
- "tags": {}
163215
- }
163216
- ]
161060
+ "kind": "symbol",
161061
+ "name": "UseLiveRegionConfig",
161062
+ "value": "UseLiveRegionConfig"
163217
161063
  }
163218
161064
  }
163219
161065
  },
@@ -238558,9 +236404,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238558
236404
  "kind": "property",
238559
236405
  "name": "onBlur",
238560
236406
  "defaultValue": {
238561
- "kind": "unknown",
238562
- "value": "unknown",
238563
- "text": "onHide"
236407
+ "kind": "symbol",
236408
+ "name": "onHide",
236409
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236410
+ "value": "onHide"
238564
236411
  },
238565
236412
  "type": {
238566
236413
  "kind": "function",
@@ -238681,9 +236528,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238681
236528
  "kind": "property",
238682
236529
  "name": "open",
238683
236530
  "defaultValue": {
238684
- "kind": "unknown",
238685
- "value": "unknown",
238686
- "text": "visible"
236531
+ "kind": "symbol",
236532
+ "name": "visible",
236533
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236534
+ "value": "visible"
238687
236535
  },
238688
236536
  "type": {
238689
236537
  "kind": "primitive",
@@ -238852,9 +236700,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238852
236700
  "kind": "property",
238853
236701
  "name": "onMouseLeave",
238854
236702
  "defaultValue": {
238855
- "kind": "unknown",
238856
- "value": "unknown",
238857
- "text": "onHide"
236703
+ "kind": "symbol",
236704
+ "name": "onHide",
236705
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236706
+ "value": "onHide"
238858
236707
  },
238859
236708
  "type": {
238860
236709
  "kind": "function",
@@ -238936,9 +236785,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238936
236785
  "kind": "property",
238937
236786
  "name": "onMouseEnter",
238938
236787
  "defaultValue": {
238939
- "kind": "unknown",
238940
- "value": "unknown",
238941
- "text": "onOpen"
236788
+ "kind": "symbol",
236789
+ "name": "onOpen",
236790
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236791
+ "value": "onOpen"
238942
236792
  },
238943
236793
  "type": {
238944
236794
  "kind": "function",
@@ -238963,9 +236813,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
238963
236813
  "kind": "property",
238964
236814
  "name": "onMouseLeave",
238965
236815
  "defaultValue": {
238966
- "kind": "unknown",
238967
- "value": "unknown",
238968
- "text": "onHide"
236816
+ "kind": "symbol",
236817
+ "name": "onHide",
236818
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx",
236819
+ "value": "onHide"
238969
236820
  },
238970
236821
  "type": {
238971
236822
  "kind": "function",