@hubspot/ui-extensions-sdk-api-metadata 0.12.0 → 0.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/__generated__/component-props.js +1151 -547
- package/dist/__tests__/component-props-docs.spec.js +287 -6
- package/dist/__tests__/jsx-utils.spec.d.ts +1 -0
- package/dist/__tests__/jsx-utils.spec.js +162 -0
- package/dist/__tests__/markdown-utils.spec.d.ts +1 -0
- package/dist/__tests__/markdown-utils.spec.js +13 -0
- package/dist/component-props-docs.js +20 -22
- package/dist/internal/get-type-source.js +372 -0
- package/dist/internal/render-prop-type.d.ts +4 -4
- package/dist/internal/render-prop-type.js +161 -49
- package/dist/internal/utils/jsdoc-utils.d.ts +11 -0
- package/dist/internal/utils/jsdoc-utils.js +18 -0
- package/dist/internal/utils/jsx-utils.d.ts +32 -0
- package/dist/internal/utils/jsx-utils.js +87 -0
- package/dist/internal/utils/markdown-utils.d.ts +8 -3
- package/dist/internal/utils/markdown-utils.js +11 -4
- package/dist/types.d.ts +94 -1
- package/dist/types.js +93 -0
- package/package.json +8 -6
- package/dist/internal/utils/html-utils.d.ts +0 -7
- package/dist/internal/utils/html-utils.js +0 -18
|
@@ -14,7 +14,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14
14
|
"typeString": "AccordionProps"
|
|
15
15
|
},
|
|
16
16
|
"jsdoc": {
|
|
17
|
-
"text": "The props type for
|
|
17
|
+
"text": "The props type for [Accordion](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/accordion).",
|
|
18
18
|
"tags": [
|
|
19
19
|
{
|
|
20
20
|
"name": "category",
|
|
@@ -34,7 +34,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
34
34
|
"typeString": "AlertProps"
|
|
35
35
|
},
|
|
36
36
|
"jsdoc": {
|
|
37
|
-
"text": "The props type for
|
|
37
|
+
"text": "The props type for [Alert](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/alert).",
|
|
38
38
|
"tags": [
|
|
39
39
|
{
|
|
40
40
|
"name": "category",
|
|
@@ -65,7 +65,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
65
65
|
"typeString": "AutoGridProps"
|
|
66
66
|
},
|
|
67
67
|
"jsdoc": {
|
|
68
|
-
"text": "The props type for
|
|
68
|
+
"text": "The props type for [AutoGrid](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/autogrid).",
|
|
69
69
|
"tags": [
|
|
70
70
|
{
|
|
71
71
|
"name": "category",
|
|
@@ -77,15 +77,15 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
77
77
|
{
|
|
78
78
|
"kind": "export",
|
|
79
79
|
"exportName": "BarChartProps",
|
|
80
|
-
"declarationKind": "
|
|
80
|
+
"declarationKind": "interface",
|
|
81
81
|
"isType": true,
|
|
82
82
|
"type": {
|
|
83
83
|
"kind": "type-reference",
|
|
84
|
-
"typeId": "
|
|
85
|
-
"typeString": "
|
|
84
|
+
"typeId": "BarChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
85
|
+
"typeString": "BarChartProps"
|
|
86
86
|
},
|
|
87
87
|
"jsdoc": {
|
|
88
|
-
"text": "The props type for
|
|
88
|
+
"text": "The props type for [BarChart](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/bar-chart).",
|
|
89
89
|
"tags": [
|
|
90
90
|
{
|
|
91
91
|
"name": "category",
|
|
@@ -175,7 +175,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
175
175
|
"typeString": "BoxProps"
|
|
176
176
|
},
|
|
177
177
|
"jsdoc": {
|
|
178
|
-
"text": "The props type for
|
|
178
|
+
"text": "The props type for [Box](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/box).",
|
|
179
179
|
"tags": [
|
|
180
180
|
{
|
|
181
181
|
"name": "category",
|
|
@@ -195,7 +195,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
195
195
|
"typeString": "ButtonProps"
|
|
196
196
|
},
|
|
197
197
|
"jsdoc": {
|
|
198
|
-
"text": "The props type for
|
|
198
|
+
"text": "The props type for [Button](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/button).",
|
|
199
199
|
"tags": [
|
|
200
200
|
{
|
|
201
201
|
"name": "category",
|
|
@@ -229,7 +229,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
229
229
|
"typeString": "ButtonRowProps"
|
|
230
230
|
},
|
|
231
231
|
"jsdoc": {
|
|
232
|
-
"text": "The props type for
|
|
232
|
+
"text": "The props type for [ButtonRow](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/button-row).",
|
|
233
233
|
"tags": [
|
|
234
234
|
{
|
|
235
235
|
"name": "category",
|
|
@@ -291,7 +291,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
291
291
|
"typeString": "CheckboxProps"
|
|
292
292
|
},
|
|
293
293
|
"jsdoc": {
|
|
294
|
-
"text": "The props type for
|
|
294
|
+
"text": "The props type for [Checkbox](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/checkbox).",
|
|
295
295
|
"tags": [
|
|
296
296
|
{
|
|
297
297
|
"name": "category",
|
|
@@ -320,15 +320,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
320
320
|
"kind": "type-reference",
|
|
321
321
|
"typeId": "CrmActionButtonProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
322
322
|
"typeString": "CrmActionButtonProps"
|
|
323
|
-
},
|
|
324
|
-
"jsdoc": {
|
|
325
|
-
"text": "",
|
|
326
|
-
"tags": [
|
|
327
|
-
{
|
|
328
|
-
"name": "ignore",
|
|
329
|
-
"text": ""
|
|
330
|
-
}
|
|
331
|
-
]
|
|
332
323
|
}
|
|
333
324
|
},
|
|
334
325
|
{
|
|
@@ -340,15 +331,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
340
331
|
"kind": "type-reference",
|
|
341
332
|
"typeId": "CrmActionLinkProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
342
333
|
"typeString": "CrmActionLinkProps"
|
|
343
|
-
},
|
|
344
|
-
"jsdoc": {
|
|
345
|
-
"text": "",
|
|
346
|
-
"tags": [
|
|
347
|
-
{
|
|
348
|
-
"name": "ignore",
|
|
349
|
-
"text": ""
|
|
350
|
-
}
|
|
351
|
-
]
|
|
352
334
|
}
|
|
353
335
|
},
|
|
354
336
|
{
|
|
@@ -360,15 +342,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
360
342
|
"kind": "type-reference",
|
|
361
343
|
"typeId": "CrmAssociationPivotProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
362
344
|
"typeString": "CrmAssociationPivotProps"
|
|
363
|
-
},
|
|
364
|
-
"jsdoc": {
|
|
365
|
-
"text": "",
|
|
366
|
-
"tags": [
|
|
367
|
-
{
|
|
368
|
-
"name": "ignore",
|
|
369
|
-
"text": ""
|
|
370
|
-
}
|
|
371
|
-
]
|
|
372
345
|
}
|
|
373
346
|
},
|
|
374
347
|
{
|
|
@@ -380,15 +353,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
380
353
|
"kind": "type-reference",
|
|
381
354
|
"typeId": "CrmAssociationPropertyListProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
382
355
|
"typeString": "CrmAssociationPropertyListProps"
|
|
383
|
-
},
|
|
384
|
-
"jsdoc": {
|
|
385
|
-
"text": "",
|
|
386
|
-
"tags": [
|
|
387
|
-
{
|
|
388
|
-
"name": "ignore",
|
|
389
|
-
"text": ""
|
|
390
|
-
}
|
|
391
|
-
]
|
|
392
356
|
}
|
|
393
357
|
},
|
|
394
358
|
{
|
|
@@ -400,15 +364,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
400
364
|
"kind": "type-reference",
|
|
401
365
|
"typeId": "CrmAssociationStageTrackerProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
402
366
|
"typeString": "CrmAssociationStageTrackerProps"
|
|
403
|
-
},
|
|
404
|
-
"jsdoc": {
|
|
405
|
-
"text": "",
|
|
406
|
-
"tags": [
|
|
407
|
-
{
|
|
408
|
-
"name": "ignore",
|
|
409
|
-
"text": ""
|
|
410
|
-
}
|
|
411
|
-
]
|
|
412
367
|
}
|
|
413
368
|
},
|
|
414
369
|
{
|
|
@@ -420,15 +375,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
420
375
|
"kind": "type-reference",
|
|
421
376
|
"typeId": "CrmAssociationTableProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
422
377
|
"typeString": "CrmAssociationTableProps"
|
|
423
|
-
},
|
|
424
|
-
"jsdoc": {
|
|
425
|
-
"text": "",
|
|
426
|
-
"tags": [
|
|
427
|
-
{
|
|
428
|
-
"name": "ignore",
|
|
429
|
-
"text": ""
|
|
430
|
-
}
|
|
431
|
-
]
|
|
432
378
|
}
|
|
433
379
|
},
|
|
434
380
|
{
|
|
@@ -440,15 +386,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
440
386
|
"kind": "type-reference",
|
|
441
387
|
"typeId": "CrmCardActionsProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
442
388
|
"typeString": "CrmCardActionsProps"
|
|
443
|
-
},
|
|
444
|
-
"jsdoc": {
|
|
445
|
-
"text": "",
|
|
446
|
-
"tags": [
|
|
447
|
-
{
|
|
448
|
-
"name": "ignore",
|
|
449
|
-
"text": ""
|
|
450
|
-
}
|
|
451
|
-
]
|
|
452
389
|
}
|
|
453
390
|
},
|
|
454
391
|
{
|
|
@@ -460,15 +397,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
460
397
|
"kind": "type-reference",
|
|
461
398
|
"typeId": "CrmDataHighlightProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
462
399
|
"typeString": "CrmDataHighlightProps"
|
|
463
|
-
},
|
|
464
|
-
"jsdoc": {
|
|
465
|
-
"text": "",
|
|
466
|
-
"tags": [
|
|
467
|
-
{
|
|
468
|
-
"name": "ignore",
|
|
469
|
-
"text": ""
|
|
470
|
-
}
|
|
471
|
-
]
|
|
472
400
|
}
|
|
473
401
|
},
|
|
474
402
|
{
|
|
@@ -480,15 +408,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
480
408
|
"kind": "type-reference",
|
|
481
409
|
"typeId": "CrmPropertyListProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
482
410
|
"typeString": "CrmPropertyListProps"
|
|
483
|
-
},
|
|
484
|
-
"jsdoc": {
|
|
485
|
-
"text": "",
|
|
486
|
-
"tags": [
|
|
487
|
-
{
|
|
488
|
-
"name": "ignore",
|
|
489
|
-
"text": ""
|
|
490
|
-
}
|
|
491
|
-
]
|
|
492
411
|
}
|
|
493
412
|
},
|
|
494
413
|
{
|
|
@@ -500,15 +419,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
500
419
|
"kind": "type-reference",
|
|
501
420
|
"typeId": "CrmRelativeTimelineProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
502
421
|
"typeString": "CrmRelativeTimelineProps"
|
|
503
|
-
},
|
|
504
|
-
"jsdoc": {
|
|
505
|
-
"text": "",
|
|
506
|
-
"tags": [
|
|
507
|
-
{
|
|
508
|
-
"name": "ignore",
|
|
509
|
-
"text": ""
|
|
510
|
-
}
|
|
511
|
-
]
|
|
512
422
|
}
|
|
513
423
|
},
|
|
514
424
|
{
|
|
@@ -520,15 +430,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
520
430
|
"kind": "type-reference",
|
|
521
431
|
"typeId": "CrmReportProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
522
432
|
"typeString": "CrmReportProps"
|
|
523
|
-
},
|
|
524
|
-
"jsdoc": {
|
|
525
|
-
"text": "",
|
|
526
|
-
"tags": [
|
|
527
|
-
{
|
|
528
|
-
"name": "ignore",
|
|
529
|
-
"text": ""
|
|
530
|
-
}
|
|
531
|
-
]
|
|
532
433
|
}
|
|
533
434
|
},
|
|
534
435
|
{
|
|
@@ -540,15 +441,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
540
441
|
"kind": "type-reference",
|
|
541
442
|
"typeId": "CrmSimpleDeadlineProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
542
443
|
"typeString": "CrmSimpleDeadlineProps"
|
|
543
|
-
},
|
|
544
|
-
"jsdoc": {
|
|
545
|
-
"text": "",
|
|
546
|
-
"tags": [
|
|
547
|
-
{
|
|
548
|
-
"name": "ignore",
|
|
549
|
-
"text": ""
|
|
550
|
-
}
|
|
551
|
-
]
|
|
552
444
|
}
|
|
553
445
|
},
|
|
554
446
|
{
|
|
@@ -560,15 +452,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
560
452
|
"kind": "type-reference",
|
|
561
453
|
"typeId": "CrmStageTrackerProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
562
454
|
"typeString": "CrmStageTrackerProps"
|
|
563
|
-
},
|
|
564
|
-
"jsdoc": {
|
|
565
|
-
"text": "",
|
|
566
|
-
"tags": [
|
|
567
|
-
{
|
|
568
|
-
"name": "ignore",
|
|
569
|
-
"text": ""
|
|
570
|
-
}
|
|
571
|
-
]
|
|
572
455
|
}
|
|
573
456
|
},
|
|
574
457
|
{
|
|
@@ -580,15 +463,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
580
463
|
"kind": "type-reference",
|
|
581
464
|
"typeId": "CrmStatisticsProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
582
465
|
"typeString": "CrmStatisticsProps"
|
|
583
|
-
},
|
|
584
|
-
"jsdoc": {
|
|
585
|
-
"text": "",
|
|
586
|
-
"tags": [
|
|
587
|
-
{
|
|
588
|
-
"name": "ignore",
|
|
589
|
-
"text": ""
|
|
590
|
-
}
|
|
591
|
-
]
|
|
592
466
|
}
|
|
593
467
|
},
|
|
594
468
|
{
|
|
@@ -602,7 +476,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
602
476
|
"typeString": "CurrencyInputProps"
|
|
603
477
|
},
|
|
604
478
|
"jsdoc": {
|
|
605
|
-
"text": "The props type for
|
|
479
|
+
"text": "The props type for [CurrencyInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/currency-input).",
|
|
606
480
|
"tags": [
|
|
607
481
|
{
|
|
608
482
|
"name": "category",
|
|
@@ -622,7 +496,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
622
496
|
"typeString": "DateInputProps"
|
|
623
497
|
},
|
|
624
498
|
"jsdoc": {
|
|
625
|
-
"text": "The props type for
|
|
499
|
+
"text": "The props type for [DateInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/date-input).",
|
|
626
500
|
"tags": [
|
|
627
501
|
{
|
|
628
502
|
"name": "category",
|
|
@@ -642,7 +516,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
642
516
|
"typeString": "DescriptionListItemProps"
|
|
643
517
|
},
|
|
644
518
|
"jsdoc": {
|
|
645
|
-
"text": "The props type for
|
|
519
|
+
"text": "The props type for [DescriptionListItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/description-list).",
|
|
646
520
|
"tags": [
|
|
647
521
|
{
|
|
648
522
|
"name": "category",
|
|
@@ -662,7 +536,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
662
536
|
"typeString": "DescriptionListProps"
|
|
663
537
|
},
|
|
664
538
|
"jsdoc": {
|
|
665
|
-
"text": "The props type for
|
|
539
|
+
"text": "The props type for [DescriptionList](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/description-list).",
|
|
666
540
|
"tags": [
|
|
667
541
|
{
|
|
668
542
|
"name": "category",
|
|
@@ -682,7 +556,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
682
556
|
"typeString": "DividerProps"
|
|
683
557
|
},
|
|
684
558
|
"jsdoc": {
|
|
685
|
-
"text": "The props type for
|
|
559
|
+
"text": "The props type for [Divider](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/divider).",
|
|
686
560
|
"tags": [
|
|
687
561
|
{
|
|
688
562
|
"name": "category",
|
|
@@ -702,7 +576,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
702
576
|
"typeString": "DropdownButtonItemProps"
|
|
703
577
|
},
|
|
704
578
|
"jsdoc": {
|
|
705
|
-
"text": "The props type for
|
|
579
|
+
"text": "The props type for [DropdownButtonItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/dropdown).",
|
|
706
580
|
"tags": [
|
|
707
581
|
{
|
|
708
582
|
"name": "category",
|
|
@@ -722,7 +596,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
722
596
|
"typeString": "DropdownProps"
|
|
723
597
|
},
|
|
724
598
|
"jsdoc": {
|
|
725
|
-
"text": "The props type for
|
|
599
|
+
"text": "The props type for [Dropdown](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/dropdown).",
|
|
726
600
|
"tags": [
|
|
727
601
|
{
|
|
728
602
|
"name": "category",
|
|
@@ -742,7 +616,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
742
616
|
"typeString": "EmptyStateProps"
|
|
743
617
|
},
|
|
744
618
|
"jsdoc": {
|
|
745
|
-
"text": "The props type for
|
|
619
|
+
"text": "The props type for [EmptyState](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/empty-state).",
|
|
746
620
|
"tags": [
|
|
747
621
|
{
|
|
748
622
|
"name": "category",
|
|
@@ -762,7 +636,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
762
636
|
"typeString": "ErrorStateProps"
|
|
763
637
|
},
|
|
764
638
|
"jsdoc": {
|
|
765
|
-
"text": "The props type for
|
|
639
|
+
"text": "The props type for [ErrorState](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/error-state).",
|
|
766
640
|
"tags": [
|
|
767
641
|
{
|
|
768
642
|
"name": "category",
|
|
@@ -793,7 +667,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
793
667
|
"typeString": "FlexProps"
|
|
794
668
|
},
|
|
795
669
|
"jsdoc": {
|
|
796
|
-
"text": "The props type for
|
|
670
|
+
"text": "The props type for [Flex](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/flex).",
|
|
797
671
|
"tags": [
|
|
798
672
|
{
|
|
799
673
|
"name": "category",
|
|
@@ -813,7 +687,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
813
687
|
"typeString": "FormProps"
|
|
814
688
|
},
|
|
815
689
|
"jsdoc": {
|
|
816
|
-
"text": "The props type for
|
|
690
|
+
"text": "The props type for [Form](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/form).",
|
|
817
691
|
"tags": [
|
|
818
692
|
{
|
|
819
693
|
"name": "category",
|
|
@@ -833,7 +707,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
833
707
|
"typeString": "HeaderActionButtonProps"
|
|
834
708
|
},
|
|
835
709
|
"jsdoc": {
|
|
836
|
-
"text": "The props type for
|
|
710
|
+
"text": "The props type for [HeaderActions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/create-an-app-home-page#headeractions).",
|
|
837
711
|
"tags": [
|
|
838
712
|
{
|
|
839
713
|
"name": "category",
|
|
@@ -853,7 +727,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
853
727
|
"typeString": "HeaderActionsProps"
|
|
854
728
|
},
|
|
855
729
|
"jsdoc": {
|
|
856
|
-
"text": "The props type for
|
|
730
|
+
"text": "The props type for [HeaderActions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/create-an-app-home-page#headeractions).",
|
|
857
731
|
"tags": [
|
|
858
732
|
{
|
|
859
733
|
"name": "category",
|
|
@@ -873,7 +747,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
873
747
|
"typeString": "HeadingProps"
|
|
874
748
|
},
|
|
875
749
|
"jsdoc": {
|
|
876
|
-
"text": "The props type for
|
|
750
|
+
"text": "The props type for [Heading](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/heading).",
|
|
877
751
|
"tags": [
|
|
878
752
|
{
|
|
879
753
|
"name": "category",
|
|
@@ -893,7 +767,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
893
767
|
"typeString": "IconProps"
|
|
894
768
|
},
|
|
895
769
|
"jsdoc": {
|
|
896
|
-
"text": "The props type for
|
|
770
|
+
"text": "The props type for [Icon](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/icon).",
|
|
897
771
|
"tags": [
|
|
898
772
|
{
|
|
899
773
|
"name": "category",
|
|
@@ -941,7 +815,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
941
815
|
"typeString": "IllustrationProps"
|
|
942
816
|
},
|
|
943
817
|
"jsdoc": {
|
|
944
|
-
"text": "The props type for
|
|
818
|
+
"text": "The props type for [Illustration](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/illustration).",
|
|
945
819
|
"tags": [
|
|
946
820
|
{
|
|
947
821
|
"name": "category",
|
|
@@ -961,7 +835,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
961
835
|
"typeString": "ImageProps"
|
|
962
836
|
},
|
|
963
837
|
"jsdoc": {
|
|
964
|
-
"text": "The props type for
|
|
838
|
+
"text": "The props type for [Image](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/image).",
|
|
965
839
|
"tags": [
|
|
966
840
|
{
|
|
967
841
|
"name": "category",
|
|
@@ -981,7 +855,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
981
855
|
"typeString": "InlineProps"
|
|
982
856
|
},
|
|
983
857
|
"jsdoc": {
|
|
984
|
-
"text": "The props type for
|
|
858
|
+
"text": "The props type for [Inline](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/inline).",
|
|
985
859
|
"tags": [
|
|
986
860
|
{
|
|
987
861
|
"name": "category",
|
|
@@ -1001,7 +875,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1001
875
|
"typeString": "InputProps"
|
|
1002
876
|
},
|
|
1003
877
|
"jsdoc": {
|
|
1004
|
-
"text": "The props type for
|
|
878
|
+
"text": "The props type for [Input](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/input).",
|
|
1005
879
|
"tags": [
|
|
1006
880
|
{
|
|
1007
881
|
"name": "category",
|
|
@@ -1013,15 +887,15 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1013
887
|
{
|
|
1014
888
|
"kind": "export",
|
|
1015
889
|
"exportName": "LineChartProps",
|
|
1016
|
-
"declarationKind": "
|
|
890
|
+
"declarationKind": "interface",
|
|
1017
891
|
"isType": true,
|
|
1018
892
|
"type": {
|
|
1019
893
|
"kind": "type-reference",
|
|
1020
|
-
"typeId": "
|
|
1021
|
-
"typeString": "
|
|
894
|
+
"typeId": "LineChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
895
|
+
"typeString": "LineChartProps"
|
|
1022
896
|
},
|
|
1023
897
|
"jsdoc": {
|
|
1024
|
-
"text": "The props type for
|
|
898
|
+
"text": "The props type for [LineChart](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/line-chart).",
|
|
1025
899
|
"tags": [
|
|
1026
900
|
{
|
|
1027
901
|
"name": "category",
|
|
@@ -1041,7 +915,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1041
915
|
"typeString": "LinkProps"
|
|
1042
916
|
},
|
|
1043
917
|
"jsdoc": {
|
|
1044
|
-
"text": "The props type for
|
|
918
|
+
"text": "The props type for [Link](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/link).",
|
|
1045
919
|
"tags": [
|
|
1046
920
|
{
|
|
1047
921
|
"name": "category",
|
|
@@ -1061,7 +935,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1061
935
|
"typeString": "ListProps"
|
|
1062
936
|
},
|
|
1063
937
|
"jsdoc": {
|
|
1064
|
-
"text": "The props type for
|
|
938
|
+
"text": "The props type for [List](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/list).",
|
|
1065
939
|
"tags": [
|
|
1066
940
|
{
|
|
1067
941
|
"name": "category",
|
|
@@ -1081,7 +955,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1081
955
|
"typeString": "LoadingButtonProps"
|
|
1082
956
|
},
|
|
1083
957
|
"jsdoc": {
|
|
1084
|
-
"text": "The props type for
|
|
958
|
+
"text": "The props type for [LoadingButton](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/loading-button).",
|
|
1085
959
|
"tags": [
|
|
1086
960
|
{
|
|
1087
961
|
"name": "category",
|
|
@@ -1101,7 +975,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1101
975
|
"typeString": "LoadingSpinnerProps"
|
|
1102
976
|
},
|
|
1103
977
|
"jsdoc": {
|
|
1104
|
-
"text": "The props type for
|
|
978
|
+
"text": "The props type for [LoadingSpinner](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/loading-spinner).",
|
|
1105
979
|
"tags": [
|
|
1106
980
|
{
|
|
1107
981
|
"name": "category",
|
|
@@ -1154,7 +1028,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1154
1028
|
"typeString": "MultiSelectProps"
|
|
1155
1029
|
},
|
|
1156
1030
|
"jsdoc": {
|
|
1157
|
-
"text": "The props type for
|
|
1031
|
+
"text": "The props type for [MultiSelect](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/multi-select).",
|
|
1158
1032
|
"tags": [
|
|
1159
1033
|
{
|
|
1160
1034
|
"name": "category",
|
|
@@ -1174,7 +1048,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1174
1048
|
"typeString": "NumberInputProps"
|
|
1175
1049
|
},
|
|
1176
1050
|
"jsdoc": {
|
|
1177
|
-
"text": "The props type for
|
|
1051
|
+
"text": "The props type for [NumberInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/number-input).",
|
|
1178
1052
|
"tags": [
|
|
1179
1053
|
{
|
|
1180
1054
|
"name": "category",
|
|
@@ -1249,7 +1123,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1249
1123
|
"typeString": "ProgressBarProps"
|
|
1250
1124
|
},
|
|
1251
1125
|
"jsdoc": {
|
|
1252
|
-
"text": "The props type for
|
|
1126
|
+
"text": "The props type for [ProgressBar](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/progress-bar).",
|
|
1253
1127
|
"tags": [
|
|
1254
1128
|
{
|
|
1255
1129
|
"name": "category",
|
|
@@ -1280,7 +1154,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1280
1154
|
"typeString": "RadioButtonProps"
|
|
1281
1155
|
},
|
|
1282
1156
|
"jsdoc": {
|
|
1283
|
-
"text": "The props type for
|
|
1157
|
+
"text": "The props type for [RadioButton](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/radio-button).",
|
|
1284
1158
|
"tags": [
|
|
1285
1159
|
{
|
|
1286
1160
|
"name": "category",
|
|
@@ -1324,7 +1198,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1324
1198
|
"typeString": "SearchInputProps"
|
|
1325
1199
|
},
|
|
1326
1200
|
"jsdoc": {
|
|
1327
|
-
"text": "The props type for
|
|
1201
|
+
"text": "The props type for [SearchInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/search-input).",
|
|
1328
1202
|
"tags": [
|
|
1329
1203
|
{
|
|
1330
1204
|
"name": "category",
|
|
@@ -1344,7 +1218,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1344
1218
|
"typeString": "SelectProps"
|
|
1345
1219
|
},
|
|
1346
1220
|
"jsdoc": {
|
|
1347
|
-
"text": "The props type for
|
|
1221
|
+
"text": "The props type for [Select](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/select).",
|
|
1348
1222
|
"tags": [
|
|
1349
1223
|
{
|
|
1350
1224
|
"name": "category",
|
|
@@ -1364,7 +1238,27 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1364
1238
|
"typeString": "SortedTableHeaderProps"
|
|
1365
1239
|
},
|
|
1366
1240
|
"jsdoc": {
|
|
1367
|
-
"text": "The props type for
|
|
1241
|
+
"text": "The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table) when sorted !== never.",
|
|
1242
|
+
"tags": [
|
|
1243
|
+
{
|
|
1244
|
+
"name": "category",
|
|
1245
|
+
"text": "Component Props"
|
|
1246
|
+
}
|
|
1247
|
+
]
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
{
|
|
1251
|
+
"kind": "export",
|
|
1252
|
+
"exportName": "SpacerProps",
|
|
1253
|
+
"declarationKind": "interface",
|
|
1254
|
+
"isType": true,
|
|
1255
|
+
"type": {
|
|
1256
|
+
"kind": "type-reference",
|
|
1257
|
+
"typeId": "SpacerProps:@hubspot/ui-extensions:dist/shared/types/components/spacer.d.ts",
|
|
1258
|
+
"typeString": "SpacerProps"
|
|
1259
|
+
},
|
|
1260
|
+
"jsdoc": {
|
|
1261
|
+
"text": "The props type for [Spacer](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/spacer)",
|
|
1368
1262
|
"tags": [
|
|
1369
1263
|
{
|
|
1370
1264
|
"name": "category",
|
|
@@ -1384,7 +1278,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1384
1278
|
"typeString": "StackProps"
|
|
1385
1279
|
},
|
|
1386
1280
|
"jsdoc": {
|
|
1387
|
-
"text": "The props type for
|
|
1281
|
+
"text": "The props type for [Stack](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/flex).",
|
|
1388
1282
|
"tags": [
|
|
1389
1283
|
{
|
|
1390
1284
|
"name": "category",
|
|
@@ -1404,7 +1298,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1404
1298
|
"typeString": "StatisticsItemProps"
|
|
1405
1299
|
},
|
|
1406
1300
|
"jsdoc": {
|
|
1407
|
-
"text": "The props type for
|
|
1301
|
+
"text": "The props type for [StatisticsItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).",
|
|
1408
1302
|
"tags": [
|
|
1409
1303
|
{
|
|
1410
1304
|
"name": "category",
|
|
@@ -1424,7 +1318,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1424
1318
|
"typeString": "StatisticsProps"
|
|
1425
1319
|
},
|
|
1426
1320
|
"jsdoc": {
|
|
1427
|
-
"text": "The props type for
|
|
1321
|
+
"text": "The props type for [Statistics](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).",
|
|
1428
1322
|
"tags": [
|
|
1429
1323
|
{
|
|
1430
1324
|
"name": "category",
|
|
@@ -1444,7 +1338,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1444
1338
|
"typeString": "StatisticsTrendProps"
|
|
1445
1339
|
},
|
|
1446
1340
|
"jsdoc": {
|
|
1447
|
-
"text": "The props type for
|
|
1341
|
+
"text": "The props type for [StatisticsTrend](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics).",
|
|
1448
1342
|
"tags": [
|
|
1449
1343
|
{
|
|
1450
1344
|
"name": "category",
|
|
@@ -1464,7 +1358,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1464
1358
|
"typeString": "StatusTagProps"
|
|
1465
1359
|
},
|
|
1466
1360
|
"jsdoc": {
|
|
1467
|
-
"text": "The props type for
|
|
1361
|
+
"text": "The props type for [StatusTag](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/status-tag).",
|
|
1468
1362
|
"tags": [
|
|
1469
1363
|
{
|
|
1470
1364
|
"name": "category",
|
|
@@ -1484,7 +1378,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1484
1378
|
"typeString": "StepIndicatorProps"
|
|
1485
1379
|
},
|
|
1486
1380
|
"jsdoc": {
|
|
1487
|
-
"text": "The props type for
|
|
1381
|
+
"text": "The props type for [StepIndicator](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/step-indicator).",
|
|
1488
1382
|
"tags": [
|
|
1489
1383
|
{
|
|
1490
1384
|
"name": "category",
|
|
@@ -1504,7 +1398,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1504
1398
|
"typeString": "StepperInputProps"
|
|
1505
1399
|
},
|
|
1506
1400
|
"jsdoc": {
|
|
1507
|
-
"text": "The props type for
|
|
1401
|
+
"text": "The props type for [StepperInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/stepper-input).",
|
|
1508
1402
|
"tags": [
|
|
1509
1403
|
{
|
|
1510
1404
|
"name": "category",
|
|
@@ -1546,7 +1440,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1546
1440
|
"typeString": "TableHeaderProps"
|
|
1547
1441
|
},
|
|
1548
1442
|
"jsdoc": {
|
|
1549
|
-
"text": "The props type for
|
|
1443
|
+
"text": "The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table).",
|
|
1550
1444
|
"tags": [
|
|
1551
1445
|
{
|
|
1552
1446
|
"name": "category",
|
|
@@ -1606,7 +1500,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1606
1500
|
"typeString": "TableProps"
|
|
1607
1501
|
},
|
|
1608
1502
|
"jsdoc": {
|
|
1609
|
-
"text": "The props type for
|
|
1503
|
+
"text": "The props type for [Table](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table).",
|
|
1610
1504
|
"tags": [
|
|
1611
1505
|
{
|
|
1612
1506
|
"name": "category",
|
|
@@ -1648,7 +1542,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1648
1542
|
"typeString": "TagProps"
|
|
1649
1543
|
},
|
|
1650
1544
|
"jsdoc": {
|
|
1651
|
-
"text": "The props type for
|
|
1545
|
+
"text": "The props type for [Tag](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/tag).",
|
|
1652
1546
|
"tags": [
|
|
1653
1547
|
{
|
|
1654
1548
|
"name": "category",
|
|
@@ -1692,7 +1586,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1692
1586
|
"typeString": "TextAreaProps"
|
|
1693
1587
|
},
|
|
1694
1588
|
"jsdoc": {
|
|
1695
|
-
"text": "The props type for
|
|
1589
|
+
"text": "The props type for [TextArea](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text-area).",
|
|
1696
1590
|
"tags": [
|
|
1697
1591
|
{
|
|
1698
1592
|
"name": "category",
|
|
@@ -1712,7 +1606,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1712
1606
|
"typeString": "TextProps"
|
|
1713
1607
|
},
|
|
1714
1608
|
"jsdoc": {
|
|
1715
|
-
"text": "The props type for
|
|
1609
|
+
"text": "The props type for [Text](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text).",
|
|
1716
1610
|
"tags": [
|
|
1717
1611
|
{
|
|
1718
1612
|
"name": "interface",
|
|
@@ -1736,7 +1630,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1736
1630
|
"typeString": "TileProps"
|
|
1737
1631
|
},
|
|
1738
1632
|
"jsdoc": {
|
|
1739
|
-
"text": "The props type for
|
|
1633
|
+
"text": "The props type for [Tile](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/tile).",
|
|
1740
1634
|
"tags": [
|
|
1741
1635
|
{
|
|
1742
1636
|
"name": "category",
|
|
@@ -1756,7 +1650,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1756
1650
|
"typeString": "TimeInputProps"
|
|
1757
1651
|
},
|
|
1758
1652
|
"jsdoc": {
|
|
1759
|
-
"text": "The props type for
|
|
1653
|
+
"text": "The props type for [TimeInput](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/time-input).",
|
|
1760
1654
|
"tags": [
|
|
1761
1655
|
{
|
|
1762
1656
|
"name": "category",
|
|
@@ -1776,7 +1670,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1776
1670
|
"typeString": "ToggleGroupProps"
|
|
1777
1671
|
},
|
|
1778
1672
|
"jsdoc": {
|
|
1779
|
-
"text": "The props type for
|
|
1673
|
+
"text": "The props type for [ToggleGroup](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/toggle-group).",
|
|
1780
1674
|
"tags": [
|
|
1781
1675
|
{
|
|
1782
1676
|
"name": "interface",
|
|
@@ -1800,7 +1694,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1800
1694
|
"typeString": "ToggleProps"
|
|
1801
1695
|
},
|
|
1802
1696
|
"jsdoc": {
|
|
1803
|
-
"text": "The props type for
|
|
1697
|
+
"text": "The props type for [Toggle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/toggle).",
|
|
1804
1698
|
"tags": [
|
|
1805
1699
|
{
|
|
1806
1700
|
"name": "category",
|
|
@@ -1842,7 +1736,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1842
1736
|
"typeString": "UnSortedTableHeaderProps"
|
|
1843
1737
|
},
|
|
1844
1738
|
"jsdoc": {
|
|
1845
|
-
"text": "The props type for
|
|
1739
|
+
"text": "The props type for [TableHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/table) when sorted === never.",
|
|
1846
1740
|
"tags": [
|
|
1847
1741
|
{
|
|
1848
1742
|
"name": "category",
|
|
@@ -1873,15 +1767,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1873
1767
|
"kind": "type-reference",
|
|
1874
1768
|
"typeId": "CrmActionButtonProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1875
1769
|
"typeString": "CrmActionButtonProps"
|
|
1876
|
-
},
|
|
1877
|
-
"jsdoc": {
|
|
1878
|
-
"text": "",
|
|
1879
|
-
"tags": [
|
|
1880
|
-
{
|
|
1881
|
-
"name": "ignore",
|
|
1882
|
-
"text": ""
|
|
1883
|
-
}
|
|
1884
|
-
]
|
|
1885
1770
|
}
|
|
1886
1771
|
},
|
|
1887
1772
|
{
|
|
@@ -1893,15 +1778,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1893
1778
|
"kind": "type-reference",
|
|
1894
1779
|
"typeId": "CrmActionLinkProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1895
1780
|
"typeString": "CrmActionLinkProps"
|
|
1896
|
-
},
|
|
1897
|
-
"jsdoc": {
|
|
1898
|
-
"text": "",
|
|
1899
|
-
"tags": [
|
|
1900
|
-
{
|
|
1901
|
-
"name": "ignore",
|
|
1902
|
-
"text": ""
|
|
1903
|
-
}
|
|
1904
|
-
]
|
|
1905
1781
|
}
|
|
1906
1782
|
},
|
|
1907
1783
|
{
|
|
@@ -1913,15 +1789,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1913
1789
|
"kind": "type-reference",
|
|
1914
1790
|
"typeId": "CrmAssociationPivotProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1915
1791
|
"typeString": "CrmAssociationPivotProps"
|
|
1916
|
-
},
|
|
1917
|
-
"jsdoc": {
|
|
1918
|
-
"text": "",
|
|
1919
|
-
"tags": [
|
|
1920
|
-
{
|
|
1921
|
-
"name": "ignore",
|
|
1922
|
-
"text": ""
|
|
1923
|
-
}
|
|
1924
|
-
]
|
|
1925
1792
|
}
|
|
1926
1793
|
},
|
|
1927
1794
|
{
|
|
@@ -1933,15 +1800,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1933
1800
|
"kind": "type-reference",
|
|
1934
1801
|
"typeId": "CrmAssociationPropertyListProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1935
1802
|
"typeString": "CrmAssociationPropertyListProps"
|
|
1936
|
-
},
|
|
1937
|
-
"jsdoc": {
|
|
1938
|
-
"text": "",
|
|
1939
|
-
"tags": [
|
|
1940
|
-
{
|
|
1941
|
-
"name": "ignore",
|
|
1942
|
-
"text": ""
|
|
1943
|
-
}
|
|
1944
|
-
]
|
|
1945
1803
|
}
|
|
1946
1804
|
},
|
|
1947
1805
|
{
|
|
@@ -1953,15 +1811,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1953
1811
|
"kind": "type-reference",
|
|
1954
1812
|
"typeId": "CrmAssociationStageTrackerProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1955
1813
|
"typeString": "CrmAssociationStageTrackerProps"
|
|
1956
|
-
},
|
|
1957
|
-
"jsdoc": {
|
|
1958
|
-
"text": "",
|
|
1959
|
-
"tags": [
|
|
1960
|
-
{
|
|
1961
|
-
"name": "ignore",
|
|
1962
|
-
"text": ""
|
|
1963
|
-
}
|
|
1964
|
-
]
|
|
1965
1814
|
}
|
|
1966
1815
|
},
|
|
1967
1816
|
{
|
|
@@ -1973,15 +1822,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1973
1822
|
"kind": "type-reference",
|
|
1974
1823
|
"typeId": "CrmAssociationTableProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1975
1824
|
"typeString": "CrmAssociationTableProps"
|
|
1976
|
-
},
|
|
1977
|
-
"jsdoc": {
|
|
1978
|
-
"text": "",
|
|
1979
|
-
"tags": [
|
|
1980
|
-
{
|
|
1981
|
-
"name": "ignore",
|
|
1982
|
-
"text": ""
|
|
1983
|
-
}
|
|
1984
|
-
]
|
|
1985
1825
|
}
|
|
1986
1826
|
},
|
|
1987
1827
|
{
|
|
@@ -1993,15 +1833,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1993
1833
|
"kind": "type-reference",
|
|
1994
1834
|
"typeId": "CrmCardActionsProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
1995
1835
|
"typeString": "CrmCardActionsProps"
|
|
1996
|
-
},
|
|
1997
|
-
"jsdoc": {
|
|
1998
|
-
"text": "",
|
|
1999
|
-
"tags": [
|
|
2000
|
-
{
|
|
2001
|
-
"name": "ignore",
|
|
2002
|
-
"text": ""
|
|
2003
|
-
}
|
|
2004
|
-
]
|
|
2005
1836
|
}
|
|
2006
1837
|
},
|
|
2007
1838
|
{
|
|
@@ -2013,15 +1844,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2013
1844
|
"kind": "type-reference",
|
|
2014
1845
|
"typeId": "CrmDataHighlightProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2015
1846
|
"typeString": "CrmDataHighlightProps"
|
|
2016
|
-
},
|
|
2017
|
-
"jsdoc": {
|
|
2018
|
-
"text": "",
|
|
2019
|
-
"tags": [
|
|
2020
|
-
{
|
|
2021
|
-
"name": "ignore",
|
|
2022
|
-
"text": ""
|
|
2023
|
-
}
|
|
2024
|
-
]
|
|
2025
1847
|
}
|
|
2026
1848
|
},
|
|
2027
1849
|
{
|
|
@@ -2033,15 +1855,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2033
1855
|
"kind": "type-reference",
|
|
2034
1856
|
"typeId": "CrmPropertyListProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2035
1857
|
"typeString": "CrmPropertyListProps"
|
|
2036
|
-
},
|
|
2037
|
-
"jsdoc": {
|
|
2038
|
-
"text": "",
|
|
2039
|
-
"tags": [
|
|
2040
|
-
{
|
|
2041
|
-
"name": "ignore",
|
|
2042
|
-
"text": ""
|
|
2043
|
-
}
|
|
2044
|
-
]
|
|
2045
1858
|
}
|
|
2046
1859
|
},
|
|
2047
1860
|
{
|
|
@@ -2053,15 +1866,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2053
1866
|
"kind": "type-reference",
|
|
2054
1867
|
"typeId": "CrmRelativeTimelineProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2055
1868
|
"typeString": "CrmRelativeTimelineProps"
|
|
2056
|
-
},
|
|
2057
|
-
"jsdoc": {
|
|
2058
|
-
"text": "",
|
|
2059
|
-
"tags": [
|
|
2060
|
-
{
|
|
2061
|
-
"name": "ignore",
|
|
2062
|
-
"text": ""
|
|
2063
|
-
}
|
|
2064
|
-
]
|
|
2065
1869
|
}
|
|
2066
1870
|
},
|
|
2067
1871
|
{
|
|
@@ -2073,15 +1877,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2073
1877
|
"kind": "type-reference",
|
|
2074
1878
|
"typeId": "CrmReportProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2075
1879
|
"typeString": "CrmReportProps"
|
|
2076
|
-
},
|
|
2077
|
-
"jsdoc": {
|
|
2078
|
-
"text": "",
|
|
2079
|
-
"tags": [
|
|
2080
|
-
{
|
|
2081
|
-
"name": "ignore",
|
|
2082
|
-
"text": ""
|
|
2083
|
-
}
|
|
2084
|
-
]
|
|
2085
1880
|
}
|
|
2086
1881
|
},
|
|
2087
1882
|
{
|
|
@@ -2093,15 +1888,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2093
1888
|
"kind": "type-reference",
|
|
2094
1889
|
"typeId": "CrmSimpleDeadlineProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2095
1890
|
"typeString": "CrmSimpleDeadlineProps"
|
|
2096
|
-
},
|
|
2097
|
-
"jsdoc": {
|
|
2098
|
-
"text": "",
|
|
2099
|
-
"tags": [
|
|
2100
|
-
{
|
|
2101
|
-
"name": "ignore",
|
|
2102
|
-
"text": ""
|
|
2103
|
-
}
|
|
2104
|
-
]
|
|
2105
1891
|
}
|
|
2106
1892
|
},
|
|
2107
1893
|
{
|
|
@@ -2113,15 +1899,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2113
1899
|
"kind": "type-reference",
|
|
2114
1900
|
"typeId": "CrmStageTrackerProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2115
1901
|
"typeString": "CrmStageTrackerProps"
|
|
2116
|
-
},
|
|
2117
|
-
"jsdoc": {
|
|
2118
|
-
"text": "",
|
|
2119
|
-
"tags": [
|
|
2120
|
-
{
|
|
2121
|
-
"name": "ignore",
|
|
2122
|
-
"text": ""
|
|
2123
|
-
}
|
|
2124
|
-
]
|
|
2125
1902
|
}
|
|
2126
1903
|
},
|
|
2127
1904
|
{
|
|
@@ -2133,15 +1910,6 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2133
1910
|
"kind": "type-reference",
|
|
2134
1911
|
"typeId": "CrmStatisticsProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2135
1912
|
"typeString": "CrmStatisticsProps"
|
|
2136
|
-
},
|
|
2137
|
-
"jsdoc": {
|
|
2138
|
-
"text": "",
|
|
2139
|
-
"tags": [
|
|
2140
|
-
{
|
|
2141
|
-
"name": "ignore",
|
|
2142
|
-
"text": ""
|
|
2143
|
-
}
|
|
2144
|
-
]
|
|
2145
1913
|
}
|
|
2146
1914
|
}
|
|
2147
1915
|
],
|
|
@@ -2531,6 +2299,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2531
2299
|
"type": {
|
|
2532
2300
|
"kind": "literal",
|
|
2533
2301
|
"value": "action-library-button"
|
|
2302
|
+
},
|
|
2303
|
+
"jsdoc": {
|
|
2304
|
+
"text": "The type of button to render:\n- `action-library-button`: a standalone button that can perform one action.\n- `dropdown`: a dropdown menu button containing multiple `'action-library-button'` actions. When using this type, you'll need to include an `options` array containing each action."
|
|
2534
2305
|
}
|
|
2535
2306
|
},
|
|
2536
2307
|
{
|
|
@@ -2540,6 +2311,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2540
2311
|
"kind": "type-reference",
|
|
2541
2312
|
"typeId": "ActionType:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
2542
2313
|
"typeString": "ActionType"
|
|
2314
|
+
},
|
|
2315
|
+
"jsdoc": {
|
|
2316
|
+
"text": "The type of action to perform. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for more information."
|
|
2543
2317
|
}
|
|
2544
2318
|
},
|
|
2545
2319
|
{
|
|
@@ -2556,6 +2330,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2556
2330
|
"typeString": "ActionType"
|
|
2557
2331
|
}
|
|
2558
2332
|
]
|
|
2333
|
+
},
|
|
2334
|
+
"jsdoc": {
|
|
2335
|
+
"text": "An object containing the CRM object and record context for performing the action. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for required context values."
|
|
2559
2336
|
}
|
|
2560
2337
|
},
|
|
2561
2338
|
{
|
|
@@ -2565,7 +2342,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2565
2342
|
"kind": "primitive",
|
|
2566
2343
|
"name": "string"
|
|
2567
2344
|
},
|
|
2568
|
-
"isOptional": true
|
|
2345
|
+
"isOptional": true,
|
|
2346
|
+
"jsdoc": {
|
|
2347
|
+
"text": "The button's label text."
|
|
2348
|
+
}
|
|
2569
2349
|
},
|
|
2570
2350
|
{
|
|
2571
2351
|
"kind": "property",
|
|
@@ -2574,7 +2354,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2574
2354
|
"kind": "primitive",
|
|
2575
2355
|
"name": "boolean"
|
|
2576
2356
|
},
|
|
2577
|
-
"isOptional": true
|
|
2357
|
+
"isOptional": true,
|
|
2358
|
+
"jsdoc": {
|
|
2359
|
+
"text": "When set to `true`, the button or dropdown menu option will render in a disabled, greyed-out state and can't be clicked."
|
|
2360
|
+
}
|
|
2578
2361
|
},
|
|
2579
2362
|
{
|
|
2580
2363
|
"kind": "property",
|
|
@@ -2583,7 +2366,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2583
2366
|
"kind": "primitive",
|
|
2584
2367
|
"name": "string"
|
|
2585
2368
|
},
|
|
2586
|
-
"isOptional": true
|
|
2369
|
+
"isOptional": true,
|
|
2370
|
+
"jsdoc": {
|
|
2371
|
+
"text": "Tooltip text that appears when hovering over the button or dropdown menu option."
|
|
2372
|
+
}
|
|
2587
2373
|
}
|
|
2588
2374
|
]
|
|
2589
2375
|
},
|
|
@@ -3028,7 +2814,21 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3028
2814
|
"name": "colors",
|
|
3029
2815
|
"type": {
|
|
3030
2816
|
"kind": "object",
|
|
3031
|
-
"properties": []
|
|
2817
|
+
"properties": [],
|
|
2818
|
+
"indexSignatures": [
|
|
2819
|
+
{
|
|
2820
|
+
"kind": "index-signature",
|
|
2821
|
+
"keyType": {
|
|
2822
|
+
"kind": "primitive",
|
|
2823
|
+
"name": "string"
|
|
2824
|
+
},
|
|
2825
|
+
"valueType": {
|
|
2826
|
+
"kind": "type-reference",
|
|
2827
|
+
"typeId": "ChartColor:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2828
|
+
"typeString": "ChartColor"
|
|
2829
|
+
}
|
|
2830
|
+
}
|
|
2831
|
+
]
|
|
3032
2832
|
},
|
|
3033
2833
|
"isOptional": true,
|
|
3034
2834
|
"jsdoc": {
|
|
@@ -3037,6 +2837,101 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3037
2837
|
}
|
|
3038
2838
|
]
|
|
3039
2839
|
},
|
|
2840
|
+
"BarChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
2841
|
+
"kind": "object",
|
|
2842
|
+
"properties": [
|
|
2843
|
+
{
|
|
2844
|
+
"kind": "property",
|
|
2845
|
+
"name": "data",
|
|
2846
|
+
"type": {
|
|
2847
|
+
"kind": "union",
|
|
2848
|
+
"types": [
|
|
2849
|
+
{
|
|
2850
|
+
"kind": "array",
|
|
2851
|
+
"elementType": {
|
|
2852
|
+
"kind": "type-reference",
|
|
2853
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2854
|
+
"typeString": "ChartDataRow"
|
|
2855
|
+
}
|
|
2856
|
+
},
|
|
2857
|
+
{
|
|
2858
|
+
"kind": "object",
|
|
2859
|
+
"properties": [
|
|
2860
|
+
{
|
|
2861
|
+
"kind": "property",
|
|
2862
|
+
"name": "data",
|
|
2863
|
+
"type": {
|
|
2864
|
+
"kind": "array",
|
|
2865
|
+
"elementType": {
|
|
2866
|
+
"kind": "type-reference",
|
|
2867
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2868
|
+
"typeString": "ChartDataRow"
|
|
2869
|
+
}
|
|
2870
|
+
}
|
|
2871
|
+
},
|
|
2872
|
+
{
|
|
2873
|
+
"kind": "property",
|
|
2874
|
+
"name": "options",
|
|
2875
|
+
"type": {
|
|
2876
|
+
"kind": "type-reference",
|
|
2877
|
+
"typeId": "ChartDataOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2878
|
+
"typeString": "ChartDataOptions"
|
|
2879
|
+
},
|
|
2880
|
+
"isOptional": true
|
|
2881
|
+
}
|
|
2882
|
+
]
|
|
2883
|
+
}
|
|
2884
|
+
]
|
|
2885
|
+
},
|
|
2886
|
+
"jsdoc": {
|
|
2887
|
+
"text": "An object containing the chart's data in an array.\n- Data should be formatted as comma-separated objects containing key-value pairs.\n- Data will be displayed in the order it's provided, so any sorting will need to be done before passing it to the component.\n- While it's recommended to pre-format your data to be human-readable, you can also provide the `propertyLabels` parameter via this prop's `options` to relabel data values. See example in the [Stacking section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/bar-chart#stacking).\n\nLearn more about [formatting data](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#formatting-data)."
|
|
2888
|
+
}
|
|
2889
|
+
},
|
|
2890
|
+
{
|
|
2891
|
+
"kind": "property",
|
|
2892
|
+
"name": "axes",
|
|
2893
|
+
"type": {
|
|
2894
|
+
"kind": "type-reference",
|
|
2895
|
+
"typeId": "ChartAxisPair:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2896
|
+
"typeString": "ChartAxisPair"
|
|
2897
|
+
},
|
|
2898
|
+
"jsdoc": {
|
|
2899
|
+
"text": "Configures the chart's axes. Using the `x` and `y` fields, you'll configure each axis individually with `field` and `fieldType` parameters, along with an optional `label` parameter:\n- `field` (Required): the field from your dataset to use. This value will be used as the displayed axis label if no `label` is specified.\n- `fieldType` (Required): the type of field. Can be `category`, `datetime`, or `linear`. Learn more about [field types](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#configuring-axes).\n- `label`: the axis label. If not specified, the `field` value will be used.\n\nYou can also include an `options` field to further configure the axes with the following options:\n- `groupFieldByColor` (string): specify a field to [apply color](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/bar-chart#colors) to for visual clarity.\n- `stacking` (boolean): [stack grouped data](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/bar-chart#stacking) instead of always rendering separate bars.\n- `colors` (object): [specify colors for values](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/bar-chart#specify-colors-per-field-value) in the field specified in `groupFieldByColor`.\n\nLearn more about [chart axes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#configuring-axes)."
|
|
2900
|
+
}
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"kind": "property",
|
|
2904
|
+
"name": "options",
|
|
2905
|
+
"type": {
|
|
2906
|
+
"kind": "type-reference",
|
|
2907
|
+
"typeId": "ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
2908
|
+
"typeString": "ChartOptions"
|
|
2909
|
+
},
|
|
2910
|
+
"isOptional": true,
|
|
2911
|
+
"jsdoc": {
|
|
2912
|
+
"text": "Additional chart configuration options. Options include:\n- `title` (string): a title for the chart.\n- `showLegend` (boolean): set to `true` to display a legend above the chart.\n- `showDataLabels` (boolean): set to `true` to display labels above data points.\n- `showTooltips` (boolean): set to `true` to display tooltips for data points on hover.\n- `colorList` (array): specify a custom order for colors to be used in the report.\n\nLearn more about [chart options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#chart-options)."
|
|
2913
|
+
}
|
|
2914
|
+
},
|
|
2915
|
+
{
|
|
2916
|
+
"kind": "property",
|
|
2917
|
+
"name": "testId",
|
|
2918
|
+
"type": {
|
|
2919
|
+
"kind": "primitive",
|
|
2920
|
+
"name": "string"
|
|
2921
|
+
},
|
|
2922
|
+
"isOptional": true,
|
|
2923
|
+
"jsdoc": {
|
|
2924
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
2925
|
+
"tags": [
|
|
2926
|
+
{
|
|
2927
|
+
"name": "see",
|
|
2928
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
2929
|
+
}
|
|
2930
|
+
]
|
|
2931
|
+
}
|
|
2932
|
+
}
|
|
2933
|
+
]
|
|
2934
|
+
},
|
|
3040
2935
|
"BaseButtonProps:@hubspot/ui-extensions:dist/shared/types/components/button.d.ts": {
|
|
3041
2936
|
"kind": "object",
|
|
3042
2937
|
"properties": [
|
|
@@ -3057,7 +2952,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3057
2952
|
},
|
|
3058
2953
|
"isOptional": true,
|
|
3059
2954
|
"jsdoc": {
|
|
3060
|
-
"text": "A function that will be invoked when the button is clicked. It receives
|
|
2955
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
3061
2956
|
"tags": [
|
|
3062
2957
|
{
|
|
3063
2958
|
"name": "event",
|
|
@@ -4114,7 +4009,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4114
4009
|
},
|
|
4115
4010
|
"isOptional": true,
|
|
4116
4011
|
"jsdoc": {
|
|
4117
|
-
"text": "A function that will be invoked when the button is clicked. It receives
|
|
4012
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
4118
4013
|
"tags": [
|
|
4119
4014
|
{
|
|
4120
4015
|
"name": "event",
|
|
@@ -4322,7 +4217,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4322
4217
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
4323
4218
|
"typeString": "ReactNode"
|
|
4324
4219
|
},
|
|
4325
|
-
"isOptional": true
|
|
4220
|
+
"isOptional": true,
|
|
4221
|
+
"jsdoc": {
|
|
4222
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
4223
|
+
}
|
|
4326
4224
|
}
|
|
4327
4225
|
]
|
|
4328
4226
|
},
|
|
@@ -4825,7 +4723,30 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4825
4723
|
"name": "propertyLabels",
|
|
4826
4724
|
"type": {
|
|
4827
4725
|
"kind": "object",
|
|
4828
|
-
"properties": []
|
|
4726
|
+
"properties": [],
|
|
4727
|
+
"indexSignatures": [
|
|
4728
|
+
{
|
|
4729
|
+
"kind": "index-signature",
|
|
4730
|
+
"keyType": {
|
|
4731
|
+
"kind": "primitive",
|
|
4732
|
+
"name": "string"
|
|
4733
|
+
},
|
|
4734
|
+
"valueType": {
|
|
4735
|
+
"kind": "built-in-type-reference",
|
|
4736
|
+
"name": "Record",
|
|
4737
|
+
"typeArguments": [
|
|
4738
|
+
{
|
|
4739
|
+
"kind": "primitive",
|
|
4740
|
+
"name": "string"
|
|
4741
|
+
},
|
|
4742
|
+
{
|
|
4743
|
+
"kind": "primitive",
|
|
4744
|
+
"name": "string"
|
|
4745
|
+
}
|
|
4746
|
+
]
|
|
4747
|
+
}
|
|
4748
|
+
}
|
|
4749
|
+
]
|
|
4829
4750
|
},
|
|
4830
4751
|
"isOptional": true,
|
|
4831
4752
|
"jsdoc": {
|
|
@@ -4836,7 +4757,29 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4836
4757
|
},
|
|
4837
4758
|
"ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
4838
4759
|
"kind": "object",
|
|
4839
|
-
"properties": []
|
|
4760
|
+
"properties": [],
|
|
4761
|
+
"indexSignatures": [
|
|
4762
|
+
{
|
|
4763
|
+
"kind": "index-signature",
|
|
4764
|
+
"keyType": {
|
|
4765
|
+
"kind": "primitive",
|
|
4766
|
+
"name": "string"
|
|
4767
|
+
},
|
|
4768
|
+
"valueType": {
|
|
4769
|
+
"kind": "union",
|
|
4770
|
+
"types": [
|
|
4771
|
+
{
|
|
4772
|
+
"kind": "primitive",
|
|
4773
|
+
"name": "string"
|
|
4774
|
+
},
|
|
4775
|
+
{
|
|
4776
|
+
"kind": "primitive",
|
|
4777
|
+
"name": "number"
|
|
4778
|
+
}
|
|
4779
|
+
]
|
|
4780
|
+
}
|
|
4781
|
+
}
|
|
4782
|
+
]
|
|
4840
4783
|
},
|
|
4841
4784
|
"ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
4842
4785
|
"kind": "object",
|
|
@@ -5019,7 +4962,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5019
4962
|
},
|
|
5020
4963
|
"isOptional": true,
|
|
5021
4964
|
"jsdoc": {
|
|
5022
|
-
"text": "Additional chart configuration options."
|
|
4965
|
+
"text": "Additional chart configuration options. Options include:\n- `title` (string): a title for the chart.\n- `showLegend` (boolean): set to `true` to display a legend above the chart.\n- `showDataLabels` (boolean): set to `true` to display labels above data points.\n- `showTooltips` (boolean): set to `true` to display tooltips for data points on hover.\n- `colorList` (array): specify a custom order for colors to be used in the report.\n\nLearn more about [chart options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#chart-options)."
|
|
5023
4966
|
}
|
|
5024
4967
|
},
|
|
5025
4968
|
{
|
|
@@ -5907,7 +5850,16 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5907
5850
|
}
|
|
5908
5851
|
]
|
|
5909
5852
|
},
|
|
5910
|
-
"isOptional": true
|
|
5853
|
+
"isOptional": true,
|
|
5854
|
+
"jsdoc": {
|
|
5855
|
+
"text": "The color variation of the button.",
|
|
5856
|
+
"tags": [
|
|
5857
|
+
{
|
|
5858
|
+
"name": "defaultValue",
|
|
5859
|
+
"text": "`\"secondary\"`"
|
|
5860
|
+
}
|
|
5861
|
+
]
|
|
5862
|
+
}
|
|
5911
5863
|
},
|
|
5912
5864
|
{
|
|
5913
5865
|
"kind": "property",
|
|
@@ -5929,7 +5881,16 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5929
5881
|
}
|
|
5930
5882
|
]
|
|
5931
5883
|
},
|
|
5932
|
-
"isOptional": true
|
|
5884
|
+
"isOptional": true,
|
|
5885
|
+
"jsdoc": {
|
|
5886
|
+
"text": "The button's HTML `role` attribute.",
|
|
5887
|
+
"tags": [
|
|
5888
|
+
{
|
|
5889
|
+
"name": "defaultValue",
|
|
5890
|
+
"text": "`\"button\"`"
|
|
5891
|
+
}
|
|
5892
|
+
]
|
|
5893
|
+
}
|
|
5933
5894
|
},
|
|
5934
5895
|
{
|
|
5935
5896
|
"kind": "property",
|
|
@@ -5963,7 +5924,16 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5963
5924
|
}
|
|
5964
5925
|
]
|
|
5965
5926
|
},
|
|
5966
|
-
"isOptional": true
|
|
5927
|
+
"isOptional": true,
|
|
5928
|
+
"jsdoc": {
|
|
5929
|
+
"text": "The size of the button.",
|
|
5930
|
+
"tags": [
|
|
5931
|
+
{
|
|
5932
|
+
"name": "defaultValue",
|
|
5933
|
+
"text": "`\"medium\"`"
|
|
5934
|
+
}
|
|
5935
|
+
]
|
|
5936
|
+
}
|
|
5967
5937
|
},
|
|
5968
5938
|
{
|
|
5969
5939
|
"kind": "property",
|
|
@@ -5977,7 +5947,22 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5977
5947
|
"name": "void"
|
|
5978
5948
|
}
|
|
5979
5949
|
},
|
|
5980
|
-
"isOptional": true
|
|
5950
|
+
"isOptional": true,
|
|
5951
|
+
"jsdoc": {
|
|
5952
|
+
"text": "A function that will be invoked when the button is clicked. It receives no arguments and its return value is ignored."
|
|
5953
|
+
}
|
|
5954
|
+
},
|
|
5955
|
+
{
|
|
5956
|
+
"kind": "property",
|
|
5957
|
+
"name": "disabled",
|
|
5958
|
+
"type": {
|
|
5959
|
+
"kind": "primitive",
|
|
5960
|
+
"name": "boolean"
|
|
5961
|
+
},
|
|
5962
|
+
"isOptional": true,
|
|
5963
|
+
"jsdoc": {
|
|
5964
|
+
"text": "When set to `true`, button renders in a disabled, greyed-out state and cannot be clicked."
|
|
5965
|
+
}
|
|
5981
5966
|
},
|
|
5982
5967
|
{
|
|
5983
5968
|
"kind": "property",
|
|
@@ -5986,6 +5971,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5986
5971
|
"kind": "type-reference",
|
|
5987
5972
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
5988
5973
|
"typeString": "ReactNode"
|
|
5974
|
+
},
|
|
5975
|
+
"jsdoc": {
|
|
5976
|
+
"text": "The content that will render inside the component."
|
|
5989
5977
|
}
|
|
5990
5978
|
},
|
|
5991
5979
|
{
|
|
@@ -5995,6 +5983,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5995
5983
|
"kind": "type-reference",
|
|
5996
5984
|
"typeId": "ActionType:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
5997
5985
|
"typeString": "ActionType"
|
|
5986
|
+
},
|
|
5987
|
+
"jsdoc": {
|
|
5988
|
+
"text": "The type of action to perform. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for more information."
|
|
5998
5989
|
}
|
|
5999
5990
|
},
|
|
6000
5991
|
{
|
|
@@ -6011,6 +6002,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6011
6002
|
"typeString": "ActionType"
|
|
6012
6003
|
}
|
|
6013
6004
|
]
|
|
6005
|
+
},
|
|
6006
|
+
"jsdoc": {
|
|
6007
|
+
"text": "An object containing the CRM object and record context for performing the action. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for required context values."
|
|
6014
6008
|
}
|
|
6015
6009
|
},
|
|
6016
6010
|
{
|
|
@@ -6037,7 +6031,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6037
6031
|
"name": "void"
|
|
6038
6032
|
}
|
|
6039
6033
|
},
|
|
6040
|
-
"isOptional": true
|
|
6034
|
+
"isOptional": true,
|
|
6035
|
+
"jsdoc": {
|
|
6036
|
+
"text": "An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action."
|
|
6037
|
+
}
|
|
6041
6038
|
},
|
|
6042
6039
|
{
|
|
6043
6040
|
"kind": "property",
|
|
@@ -6086,7 +6083,16 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6086
6083
|
}
|
|
6087
6084
|
]
|
|
6088
6085
|
},
|
|
6089
|
-
"isOptional": true
|
|
6086
|
+
"isOptional": true,
|
|
6087
|
+
"jsdoc": {
|
|
6088
|
+
"text": "The color variation of the link. See the [variants section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/crm-action-link#variants) for more information.",
|
|
6089
|
+
"tags": [
|
|
6090
|
+
{
|
|
6091
|
+
"name": "defaultValue",
|
|
6092
|
+
"text": "`\"primary\"`"
|
|
6093
|
+
}
|
|
6094
|
+
]
|
|
6095
|
+
}
|
|
6090
6096
|
},
|
|
6091
6097
|
{
|
|
6092
6098
|
"kind": "property",
|
|
@@ -6095,6 +6101,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6095
6101
|
"kind": "type-reference",
|
|
6096
6102
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
6097
6103
|
"typeString": "ReactNode"
|
|
6104
|
+
},
|
|
6105
|
+
"jsdoc": {
|
|
6106
|
+
"text": "The content that will render inside the component."
|
|
6098
6107
|
}
|
|
6099
6108
|
},
|
|
6100
6109
|
{
|
|
@@ -6104,6 +6113,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6104
6113
|
"kind": "type-reference",
|
|
6105
6114
|
"typeId": "ActionType:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
6106
6115
|
"typeString": "ActionType"
|
|
6116
|
+
},
|
|
6117
|
+
"jsdoc": {
|
|
6118
|
+
"text": "The type of action to perform. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for more information."
|
|
6107
6119
|
}
|
|
6108
6120
|
},
|
|
6109
6121
|
{
|
|
@@ -6120,6 +6132,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6120
6132
|
"typeString": "ActionType"
|
|
6121
6133
|
}
|
|
6122
6134
|
]
|
|
6135
|
+
},
|
|
6136
|
+
"jsdoc": {
|
|
6137
|
+
"text": "An object containing the CRM object and record context for performing the action. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for required context values."
|
|
6123
6138
|
}
|
|
6124
6139
|
},
|
|
6125
6140
|
{
|
|
@@ -6146,7 +6161,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6146
6161
|
"name": "void"
|
|
6147
6162
|
}
|
|
6148
6163
|
},
|
|
6149
|
-
"isOptional": true
|
|
6164
|
+
"isOptional": true,
|
|
6165
|
+
"jsdoc": {
|
|
6166
|
+
"text": "An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action."
|
|
6167
|
+
}
|
|
6150
6168
|
},
|
|
6151
6169
|
{
|
|
6152
6170
|
"kind": "property",
|
|
@@ -6177,6 +6195,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6177
6195
|
"type": {
|
|
6178
6196
|
"kind": "primitive",
|
|
6179
6197
|
"name": "string"
|
|
6198
|
+
},
|
|
6199
|
+
"jsdoc": {
|
|
6200
|
+
"text": "The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs."
|
|
6180
6201
|
}
|
|
6181
6202
|
},
|
|
6182
6203
|
{
|
|
@@ -6189,7 +6210,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6189
6210
|
"name": "string"
|
|
6190
6211
|
}
|
|
6191
6212
|
},
|
|
6192
|
-
"isOptional": true
|
|
6213
|
+
"isOptional": true,
|
|
6214
|
+
"jsdoc": {
|
|
6215
|
+
"text": "Filters results by specific association labels. By default, all association labels will appear."
|
|
6216
|
+
}
|
|
6193
6217
|
},
|
|
6194
6218
|
{
|
|
6195
6219
|
"kind": "property",
|
|
@@ -6198,7 +6222,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6198
6222
|
"kind": "primitive",
|
|
6199
6223
|
"name": "number"
|
|
6200
6224
|
},
|
|
6201
|
-
"isOptional": true
|
|
6225
|
+
"isOptional": true,
|
|
6226
|
+
"jsdoc": {
|
|
6227
|
+
"text": "The number of items to return in each association label group before displaying a \"Show more\" button."
|
|
6228
|
+
}
|
|
6202
6229
|
},
|
|
6203
6230
|
{
|
|
6204
6231
|
"kind": "property",
|
|
@@ -6211,7 +6238,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6211
6238
|
"typeString": "CrmSearchFilter"
|
|
6212
6239
|
}
|
|
6213
6240
|
},
|
|
6214
|
-
"isOptional": true
|
|
6241
|
+
"isOptional": true,
|
|
6242
|
+
"jsdoc": {
|
|
6243
|
+
"text": "Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information."
|
|
6244
|
+
}
|
|
6215
6245
|
},
|
|
6216
6246
|
{
|
|
6217
6247
|
"kind": "property",
|
|
@@ -6224,7 +6254,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6224
6254
|
"typeString": "CrmSortDescriptor"
|
|
6225
6255
|
}
|
|
6226
6256
|
},
|
|
6227
|
-
"isOptional": true
|
|
6257
|
+
"isOptional": true,
|
|
6258
|
+
"jsdoc": {
|
|
6259
|
+
"text": "The default sorting behavior for the table. In the array, you'll include an object for the column you want to sort by, which specifies:\n- `columnName`: the column to sort by.\n- `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending."
|
|
6260
|
+
}
|
|
6228
6261
|
},
|
|
6229
6262
|
{
|
|
6230
6263
|
"kind": "property",
|
|
@@ -6255,6 +6288,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6255
6288
|
"type": {
|
|
6256
6289
|
"kind": "primitive",
|
|
6257
6290
|
"name": "string"
|
|
6291
|
+
},
|
|
6292
|
+
"jsdoc": {
|
|
6293
|
+
"text": "The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs."
|
|
6258
6294
|
}
|
|
6259
6295
|
},
|
|
6260
6296
|
{
|
|
@@ -6266,6 +6302,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6266
6302
|
"kind": "primitive",
|
|
6267
6303
|
"name": "string"
|
|
6268
6304
|
}
|
|
6305
|
+
},
|
|
6306
|
+
"jsdoc": {
|
|
6307
|
+
"text": "The list of properties to display from the associated record, up to 24."
|
|
6269
6308
|
}
|
|
6270
6309
|
},
|
|
6271
6310
|
{
|
|
@@ -6278,7 +6317,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6278
6317
|
"name": "string"
|
|
6279
6318
|
}
|
|
6280
6319
|
},
|
|
6281
|
-
"isOptional": true
|
|
6320
|
+
"isOptional": true,
|
|
6321
|
+
"jsdoc": {
|
|
6322
|
+
"text": "When provided, returns associated records that have all the specified labels."
|
|
6323
|
+
}
|
|
6282
6324
|
},
|
|
6283
6325
|
{
|
|
6284
6326
|
"kind": "property",
|
|
@@ -6291,7 +6333,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6291
6333
|
"typeString": "CrmSearchFilter"
|
|
6292
6334
|
}
|
|
6293
6335
|
},
|
|
6294
|
-
"isOptional": true
|
|
6336
|
+
"isOptional": true,
|
|
6337
|
+
"jsdoc": {
|
|
6338
|
+
"text": "Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information."
|
|
6339
|
+
}
|
|
6295
6340
|
},
|
|
6296
6341
|
{
|
|
6297
6342
|
"kind": "property",
|
|
@@ -6304,7 +6349,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6304
6349
|
"typeString": "CrmSortDescriptor"
|
|
6305
6350
|
}
|
|
6306
6351
|
},
|
|
6307
|
-
"isOptional": true
|
|
6352
|
+
"isOptional": true,
|
|
6353
|
+
"jsdoc": {
|
|
6354
|
+
"text": "The default sorting behavior for the table. In each sort object in the array, you'll specify the following:\n- `columnName`: the column to sort by.\n- `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending."
|
|
6355
|
+
}
|
|
6308
6356
|
},
|
|
6309
6357
|
{
|
|
6310
6358
|
"kind": "property",
|
|
@@ -6335,6 +6383,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6335
6383
|
"type": {
|
|
6336
6384
|
"kind": "primitive",
|
|
6337
6385
|
"name": "string"
|
|
6386
|
+
},
|
|
6387
|
+
"jsdoc": {
|
|
6388
|
+
"text": "The numeric ID of the type of associated object to display data from (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs."
|
|
6338
6389
|
}
|
|
6339
6390
|
},
|
|
6340
6391
|
{
|
|
@@ -6346,6 +6397,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6346
6397
|
"kind": "primitive",
|
|
6347
6398
|
"name": "string"
|
|
6348
6399
|
}
|
|
6400
|
+
},
|
|
6401
|
+
"jsdoc": {
|
|
6402
|
+
"text": "The properties of the associated records to display, up to four."
|
|
6349
6403
|
}
|
|
6350
6404
|
},
|
|
6351
6405
|
{
|
|
@@ -6358,7 +6412,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6358
6412
|
"name": "string"
|
|
6359
6413
|
}
|
|
6360
6414
|
},
|
|
6361
|
-
"isOptional": true
|
|
6415
|
+
"isOptional": true,
|
|
6416
|
+
"jsdoc": {
|
|
6417
|
+
"text": "If provided, will only request a list of associated records with the specified label (case sensitive)."
|
|
6418
|
+
}
|
|
6362
6419
|
},
|
|
6363
6420
|
{
|
|
6364
6421
|
"kind": "property",
|
|
@@ -6371,7 +6428,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6371
6428
|
"typeString": "CrmSearchFilter"
|
|
6372
6429
|
}
|
|
6373
6430
|
},
|
|
6374
|
-
"isOptional": true
|
|
6431
|
+
"isOptional": true,
|
|
6432
|
+
"jsdoc": {
|
|
6433
|
+
"text": "If provided, the component will request a list of associated records that match the specified criteria. Learn more about [filtering in CRM data components](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data)."
|
|
6434
|
+
}
|
|
6375
6435
|
},
|
|
6376
6436
|
{
|
|
6377
6437
|
"kind": "property",
|
|
@@ -6380,7 +6440,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6380
6440
|
"kind": "primitive",
|
|
6381
6441
|
"name": "boolean"
|
|
6382
6442
|
},
|
|
6383
|
-
"isOptional": true
|
|
6443
|
+
"isOptional": true,
|
|
6444
|
+
"jsdoc": {
|
|
6445
|
+
"text": "Whether to display the properties below the progress indicator. When set to `false`, properties will not display."
|
|
6446
|
+
}
|
|
6384
6447
|
},
|
|
6385
6448
|
{
|
|
6386
6449
|
"kind": "property",
|
|
@@ -6393,7 +6456,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6393
6456
|
"typeString": "CrmSortDescriptor"
|
|
6394
6457
|
}
|
|
6395
6458
|
},
|
|
6396
|
-
"isOptional": true
|
|
6459
|
+
"isOptional": true,
|
|
6460
|
+
"jsdoc": {
|
|
6461
|
+
"text": "If provided, overrides the default sorting rules used in the search query. In the array, you'll include an object for the column you want to sort by, which specifies:\n- `columnName`: the column to sort by.\n- `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending."
|
|
6462
|
+
}
|
|
6397
6463
|
},
|
|
6398
6464
|
{
|
|
6399
6465
|
"kind": "property",
|
|
@@ -6424,6 +6490,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6424
6490
|
"type": {
|
|
6425
6491
|
"kind": "primitive",
|
|
6426
6492
|
"name": "string"
|
|
6493
|
+
},
|
|
6494
|
+
"jsdoc": {
|
|
6495
|
+
"text": "The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs."
|
|
6427
6496
|
}
|
|
6428
6497
|
},
|
|
6429
6498
|
{
|
|
@@ -6435,6 +6504,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6435
6504
|
"kind": "primitive",
|
|
6436
6505
|
"name": "string"
|
|
6437
6506
|
}
|
|
6507
|
+
},
|
|
6508
|
+
"jsdoc": {
|
|
6509
|
+
"text": "The properties to display as table columns."
|
|
6438
6510
|
}
|
|
6439
6511
|
},
|
|
6440
6512
|
{
|
|
@@ -6447,7 +6519,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6447
6519
|
"name": "string"
|
|
6448
6520
|
}
|
|
6449
6521
|
},
|
|
6450
|
-
"isOptional": true
|
|
6522
|
+
"isOptional": true,
|
|
6523
|
+
"jsdoc": {
|
|
6524
|
+
"text": "The properties that appear as filters above the table. When included, the \"Association label\" quick filter will always display. See note below for more details on this prop."
|
|
6525
|
+
}
|
|
6451
6526
|
},
|
|
6452
6527
|
{
|
|
6453
6528
|
"kind": "property",
|
|
@@ -6456,7 +6531,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6456
6531
|
"kind": "primitive",
|
|
6457
6532
|
"name": "boolean"
|
|
6458
6533
|
},
|
|
6459
|
-
"isOptional": true
|
|
6534
|
+
"isOptional": true,
|
|
6535
|
+
"jsdoc": {
|
|
6536
|
+
"text": "When set to `false`, hides the search bar above the table."
|
|
6537
|
+
}
|
|
6460
6538
|
},
|
|
6461
6539
|
{
|
|
6462
6540
|
"kind": "property",
|
|
@@ -6465,7 +6543,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6465
6543
|
"kind": "primitive",
|
|
6466
6544
|
"name": "boolean"
|
|
6467
6545
|
},
|
|
6468
|
-
"isOptional": true
|
|
6546
|
+
"isOptional": true,
|
|
6547
|
+
"jsdoc": {
|
|
6548
|
+
"text": "When set to `false`, hides the pagination navigation below the table."
|
|
6549
|
+
}
|
|
6469
6550
|
},
|
|
6470
6551
|
{
|
|
6471
6552
|
"kind": "property",
|
|
@@ -6474,7 +6555,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6474
6555
|
"kind": "primitive",
|
|
6475
6556
|
"name": "boolean"
|
|
6476
6557
|
},
|
|
6477
|
-
"isOptional": true
|
|
6558
|
+
"isOptional": true,
|
|
6559
|
+
"jsdoc": {
|
|
6560
|
+
"text": "When set to `false`, hides the \"Association label\" quick filter above the table."
|
|
6561
|
+
}
|
|
6478
6562
|
},
|
|
6479
6563
|
{
|
|
6480
6564
|
"kind": "property",
|
|
@@ -6483,7 +6567,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6483
6567
|
"kind": "primitive",
|
|
6484
6568
|
"name": "number"
|
|
6485
6569
|
},
|
|
6486
|
-
"isOptional": true
|
|
6570
|
+
"isOptional": true,
|
|
6571
|
+
"jsdoc": {
|
|
6572
|
+
"text": "The number of rows to include per page of results. Include the `pagination` property to enable users to navigate through returned results."
|
|
6573
|
+
}
|
|
6487
6574
|
},
|
|
6488
6575
|
{
|
|
6489
6576
|
"kind": "property",
|
|
@@ -6496,7 +6583,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6496
6583
|
"typeString": "CrmSearchFilter"
|
|
6497
6584
|
}
|
|
6498
6585
|
},
|
|
6499
|
-
"isOptional": true
|
|
6586
|
+
"isOptional": true,
|
|
6587
|
+
"jsdoc": {
|
|
6588
|
+
"text": "Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information."
|
|
6589
|
+
}
|
|
6500
6590
|
},
|
|
6501
6591
|
{
|
|
6502
6592
|
"kind": "property",
|
|
@@ -6509,7 +6599,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6509
6599
|
"typeString": "CrmSortDescriptor"
|
|
6510
6600
|
}
|
|
6511
6601
|
},
|
|
6512
|
-
"isOptional": true
|
|
6602
|
+
"isOptional": true,
|
|
6603
|
+
"jsdoc": {
|
|
6604
|
+
"text": "The default sorting behavior for the table. In each sort object in the array, you'll specify the following:\n- `columnName`: the column to sort by.\n- `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending."
|
|
6605
|
+
}
|
|
6513
6606
|
},
|
|
6514
6607
|
{
|
|
6515
6608
|
"kind": "property",
|
|
@@ -6562,6 +6655,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6562
6655
|
"typeId": "CardActionConfig:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
6563
6656
|
"typeString": "CardActionConfig"
|
|
6564
6657
|
}
|
|
6658
|
+
},
|
|
6659
|
+
"jsdoc": {
|
|
6660
|
+
"text": "An array that stores fields for configuration button actions. See below for list of supported fields."
|
|
6565
6661
|
}
|
|
6566
6662
|
},
|
|
6567
6663
|
{
|
|
@@ -6572,7 +6668,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6572
6668
|
"typeId": "ErrorHandler:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
6573
6669
|
"typeString": "ErrorHandler"
|
|
6574
6670
|
},
|
|
6575
|
-
"isOptional": true
|
|
6671
|
+
"isOptional": true,
|
|
6672
|
+
"jsdoc": {
|
|
6673
|
+
"text": "An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action."
|
|
6674
|
+
}
|
|
6576
6675
|
}
|
|
6577
6676
|
]
|
|
6578
6677
|
},
|
|
@@ -6728,6 +6827,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6728
6827
|
"kind": "primitive",
|
|
6729
6828
|
"name": "string"
|
|
6730
6829
|
}
|
|
6830
|
+
},
|
|
6831
|
+
"jsdoc": {
|
|
6832
|
+
"text": "The names of the properties to display."
|
|
6731
6833
|
}
|
|
6732
6834
|
}
|
|
6733
6835
|
]
|
|
@@ -6926,6 +7028,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6926
7028
|
"type": {
|
|
6927
7029
|
"kind": "primitive",
|
|
6928
7030
|
"name": "string"
|
|
7031
|
+
},
|
|
7032
|
+
"jsdoc": {
|
|
7033
|
+
"text": "The name of the property that contains the deadline date."
|
|
6929
7034
|
}
|
|
6930
7035
|
},
|
|
6931
7036
|
{
|
|
@@ -6937,6 +7042,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6937
7042
|
"kind": "primitive",
|
|
6938
7043
|
"name": "string"
|
|
6939
7044
|
}
|
|
7045
|
+
},
|
|
7046
|
+
"jsdoc": {
|
|
7047
|
+
"text": "The properties to display below the progress bar."
|
|
6940
7048
|
}
|
|
6941
7049
|
},
|
|
6942
7050
|
{
|
|
@@ -6947,7 +7055,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6947
7055
|
"typeId": "ProgressTheme:@hubspot/ui-extensions:dist/shared/types/crm.d.ts",
|
|
6948
7056
|
"typeString": "ProgressTheme"
|
|
6949
7057
|
},
|
|
6950
|
-
"isOptional": true
|
|
7058
|
+
"isOptional": true,
|
|
7059
|
+
"jsdoc": {
|
|
7060
|
+
"text": "The theme to apply to the progress bar."
|
|
7061
|
+
}
|
|
6951
7062
|
},
|
|
6952
7063
|
{
|
|
6953
7064
|
"kind": "property",
|
|
@@ -6956,7 +7067,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6956
7067
|
"kind": "primitive",
|
|
6957
7068
|
"name": "boolean"
|
|
6958
7069
|
},
|
|
6959
|
-
"isOptional": true
|
|
7070
|
+
"isOptional": true,
|
|
7071
|
+
"jsdoc": {
|
|
7072
|
+
"text": "Whether to show provided properties below the progress bar."
|
|
7073
|
+
}
|
|
6960
7074
|
},
|
|
6961
7075
|
{
|
|
6962
7076
|
"kind": "property",
|
|
@@ -6964,6 +7078,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
6964
7078
|
"type": {
|
|
6965
7079
|
"kind": "primitive",
|
|
6966
7080
|
"name": "string"
|
|
7081
|
+
},
|
|
7082
|
+
"jsdoc": {
|
|
7083
|
+
"text": "The name of the property that contains the start date."
|
|
6967
7084
|
}
|
|
6968
7085
|
},
|
|
6969
7086
|
{
|
|
@@ -7040,7 +7157,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
7040
7157
|
},
|
|
7041
7158
|
"isOptional": true,
|
|
7042
7159
|
"jsdoc": {
|
|
7043
|
-
"text": "The numeric ID of the type of associated object to display (e.g., `0-1` for contacts)."
|
|
7160
|
+
"text": "The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs."
|
|
7044
7161
|
}
|
|
7045
7162
|
},
|
|
7046
7163
|
{
|
|
@@ -7054,7 +7171,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
7054
7171
|
}
|
|
7055
7172
|
},
|
|
7056
7173
|
"jsdoc": {
|
|
7057
|
-
"text": "The properties to display, up to four. By default, will display property data from the currently displaying record."
|
|
7174
|
+
"text": "The properties to display, up to four. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props."
|
|
7058
7175
|
}
|
|
7059
7176
|
},
|
|
7060
7177
|
{
|
|
@@ -7066,7 +7183,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
7066
7183
|
},
|
|
7067
7184
|
"isOptional": true,
|
|
7068
7185
|
"jsdoc": {
|
|
7069
|
-
"text": "Whether to display the properties below the progress indicator."
|
|
7186
|
+
"text": "Whether to display the properties below the progress indicator. When set to `false`, properties will not display."
|
|
7070
7187
|
}
|
|
7071
7188
|
},
|
|
7072
7189
|
{
|
|
@@ -7998,7 +8115,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
7998
8115
|
"typeString": "ReactNode"
|
|
7999
8116
|
},
|
|
8000
8117
|
"jsdoc": {
|
|
8001
|
-
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be
|
|
8118
|
+
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be [DescriptionListItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/description-list)."
|
|
8002
8119
|
}
|
|
8003
8120
|
},
|
|
8004
8121
|
{
|
|
@@ -8053,7 +8170,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8053
8170
|
"properties": [
|
|
8054
8171
|
{
|
|
8055
8172
|
"kind": "property",
|
|
8056
|
-
"name": "
|
|
8173
|
+
"name": "size",
|
|
8057
8174
|
"type": {
|
|
8058
8175
|
"kind": "union",
|
|
8059
8176
|
"types": [
|
|
@@ -8114,6 +8231,69 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8114
8231
|
]
|
|
8115
8232
|
}
|
|
8116
8233
|
},
|
|
8234
|
+
{
|
|
8235
|
+
"kind": "property",
|
|
8236
|
+
"name": "distance",
|
|
8237
|
+
"type": {
|
|
8238
|
+
"kind": "union",
|
|
8239
|
+
"types": [
|
|
8240
|
+
{
|
|
8241
|
+
"kind": "literal",
|
|
8242
|
+
"value": "xs"
|
|
8243
|
+
},
|
|
8244
|
+
{
|
|
8245
|
+
"kind": "literal",
|
|
8246
|
+
"value": "extra-small"
|
|
8247
|
+
},
|
|
8248
|
+
{
|
|
8249
|
+
"kind": "literal",
|
|
8250
|
+
"value": "sm"
|
|
8251
|
+
},
|
|
8252
|
+
{
|
|
8253
|
+
"kind": "literal",
|
|
8254
|
+
"value": "small"
|
|
8255
|
+
},
|
|
8256
|
+
{
|
|
8257
|
+
"kind": "literal",
|
|
8258
|
+
"value": "md"
|
|
8259
|
+
},
|
|
8260
|
+
{
|
|
8261
|
+
"kind": "literal",
|
|
8262
|
+
"value": "medium"
|
|
8263
|
+
},
|
|
8264
|
+
{
|
|
8265
|
+
"kind": "literal",
|
|
8266
|
+
"value": "flush"
|
|
8267
|
+
},
|
|
8268
|
+
{
|
|
8269
|
+
"kind": "literal",
|
|
8270
|
+
"value": "lg"
|
|
8271
|
+
},
|
|
8272
|
+
{
|
|
8273
|
+
"kind": "literal",
|
|
8274
|
+
"value": "large"
|
|
8275
|
+
},
|
|
8276
|
+
{
|
|
8277
|
+
"kind": "literal",
|
|
8278
|
+
"value": "xl"
|
|
8279
|
+
},
|
|
8280
|
+
{
|
|
8281
|
+
"kind": "literal",
|
|
8282
|
+
"value": "extra-large"
|
|
8283
|
+
}
|
|
8284
|
+
]
|
|
8285
|
+
},
|
|
8286
|
+
"isOptional": true,
|
|
8287
|
+
"jsdoc": {
|
|
8288
|
+
"text": "",
|
|
8289
|
+
"tags": [
|
|
8290
|
+
{
|
|
8291
|
+
"name": "deprecated",
|
|
8292
|
+
"text": "Use `size` instead."
|
|
8293
|
+
}
|
|
8294
|
+
]
|
|
8295
|
+
}
|
|
8296
|
+
},
|
|
8117
8297
|
{
|
|
8118
8298
|
"kind": "property",
|
|
8119
8299
|
"name": "testId",
|
|
@@ -8183,7 +8363,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8183
8363
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
8184
8364
|
"typeString": "ReactNode"
|
|
8185
8365
|
},
|
|
8186
|
-
"isOptional": true
|
|
8366
|
+
"isOptional": true,
|
|
8367
|
+
"jsdoc": {
|
|
8368
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
8369
|
+
}
|
|
8187
8370
|
},
|
|
8188
8371
|
{
|
|
8189
8372
|
"kind": "property",
|
|
@@ -8214,6 +8397,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8214
8397
|
"type": {
|
|
8215
8398
|
"kind": "literal",
|
|
8216
8399
|
"value": "dropdown"
|
|
8400
|
+
},
|
|
8401
|
+
"jsdoc": {
|
|
8402
|
+
"text": "The type of button to render:\n- `action-library-button`: a standalone button that can perform one action.\n- `dropdown`: a dropdown menu button containing multiple `'action-library-button'` actions. When using this type, you'll need to include an `options` array containing each action."
|
|
8217
8403
|
}
|
|
8218
8404
|
},
|
|
8219
8405
|
{
|
|
@@ -8240,6 +8426,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8240
8426
|
"isRest": true
|
|
8241
8427
|
}
|
|
8242
8428
|
]
|
|
8429
|
+
},
|
|
8430
|
+
"jsdoc": {
|
|
8431
|
+
"text": "For `dropdown` type buttons, this array stores objects for each action in the dropdown menu. Each action should be set to the `'action-library-button'` type."
|
|
8243
8432
|
}
|
|
8244
8433
|
},
|
|
8245
8434
|
{
|
|
@@ -8249,7 +8438,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8249
8438
|
"kind": "primitive",
|
|
8250
8439
|
"name": "string"
|
|
8251
8440
|
},
|
|
8252
|
-
"isOptional": true
|
|
8441
|
+
"isOptional": true,
|
|
8442
|
+
"jsdoc": {
|
|
8443
|
+
"text": "The button's label text."
|
|
8444
|
+
}
|
|
8253
8445
|
},
|
|
8254
8446
|
{
|
|
8255
8447
|
"kind": "property",
|
|
@@ -8258,7 +8450,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8258
8450
|
"kind": "primitive",
|
|
8259
8451
|
"name": "boolean"
|
|
8260
8452
|
},
|
|
8261
|
-
"isOptional": true
|
|
8453
|
+
"isOptional": true,
|
|
8454
|
+
"jsdoc": {
|
|
8455
|
+
"text": "When set to `true`, the button or dropdown menu option will render in a disabled, greyed-out state and can't be clicked."
|
|
8456
|
+
}
|
|
8262
8457
|
},
|
|
8263
8458
|
{
|
|
8264
8459
|
"kind": "property",
|
|
@@ -8267,7 +8462,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8267
8462
|
"kind": "primitive",
|
|
8268
8463
|
"name": "string"
|
|
8269
8464
|
},
|
|
8270
|
-
"isOptional": true
|
|
8465
|
+
"isOptional": true,
|
|
8466
|
+
"jsdoc": {
|
|
8467
|
+
"text": "Tooltip text that appears when hovering over the button or dropdown menu option."
|
|
8468
|
+
}
|
|
8271
8469
|
}
|
|
8272
8470
|
]
|
|
8273
8471
|
},
|
|
@@ -9955,7 +10153,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
9955
10153
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
9956
10154
|
"typeString": "ReactNode"
|
|
9957
10155
|
},
|
|
9958
|
-
"isOptional": true
|
|
10156
|
+
"isOptional": true,
|
|
10157
|
+
"jsdoc": {
|
|
10158
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
10159
|
+
}
|
|
9959
10160
|
},
|
|
9960
10161
|
{
|
|
9961
10162
|
"kind": "property",
|
|
@@ -11337,7 +11538,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11337
11538
|
},
|
|
11338
11539
|
"isOptional": true,
|
|
11339
11540
|
"jsdoc": {
|
|
11340
|
-
"text": "A function that will be
|
|
11541
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
11341
11542
|
"tags": [
|
|
11342
11543
|
{
|
|
11343
11544
|
"name": "event",
|
|
@@ -11389,7 +11590,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11389
11590
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
11390
11591
|
"typeString": "ReactNode"
|
|
11391
11592
|
},
|
|
11392
|
-
"isOptional": true
|
|
11593
|
+
"isOptional": true,
|
|
11594
|
+
"jsdoc": {
|
|
11595
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
11596
|
+
}
|
|
11393
11597
|
},
|
|
11394
11598
|
{
|
|
11395
11599
|
"kind": "property",
|
|
@@ -11914,39 +12118,134 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11914
12118
|
}
|
|
11915
12119
|
]
|
|
11916
12120
|
},
|
|
11917
|
-
"
|
|
12121
|
+
"LineChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
11918
12122
|
"kind": "object",
|
|
11919
12123
|
"properties": [
|
|
11920
12124
|
{
|
|
11921
12125
|
"kind": "property",
|
|
11922
|
-
"name": "
|
|
12126
|
+
"name": "data",
|
|
11923
12127
|
"type": {
|
|
11924
|
-
"kind": "
|
|
11925
|
-
"
|
|
11926
|
-
|
|
12128
|
+
"kind": "union",
|
|
12129
|
+
"types": [
|
|
12130
|
+
{
|
|
12131
|
+
"kind": "array",
|
|
12132
|
+
"elementType": {
|
|
12133
|
+
"kind": "type-reference",
|
|
12134
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12135
|
+
"typeString": "ChartDataRow"
|
|
12136
|
+
}
|
|
12137
|
+
},
|
|
12138
|
+
{
|
|
12139
|
+
"kind": "object",
|
|
12140
|
+
"properties": [
|
|
12141
|
+
{
|
|
12142
|
+
"kind": "property",
|
|
12143
|
+
"name": "data",
|
|
12144
|
+
"type": {
|
|
12145
|
+
"kind": "array",
|
|
12146
|
+
"elementType": {
|
|
12147
|
+
"kind": "type-reference",
|
|
12148
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12149
|
+
"typeString": "ChartDataRow"
|
|
12150
|
+
}
|
|
12151
|
+
}
|
|
12152
|
+
},
|
|
12153
|
+
{
|
|
12154
|
+
"kind": "property",
|
|
12155
|
+
"name": "options",
|
|
12156
|
+
"type": {
|
|
12157
|
+
"kind": "type-reference",
|
|
12158
|
+
"typeId": "ChartDataOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12159
|
+
"typeString": "ChartDataOptions"
|
|
12160
|
+
},
|
|
12161
|
+
"isOptional": true
|
|
12162
|
+
}
|
|
12163
|
+
]
|
|
12164
|
+
}
|
|
12165
|
+
]
|
|
11927
12166
|
},
|
|
11928
12167
|
"jsdoc": {
|
|
11929
|
-
"text": "
|
|
12168
|
+
"text": "An object containing the chart's data in an array.\n- Data should be formatted as comma-separated objects containing key-value pairs.\n- Data will be displayed in the order it's provided, so any sorting will need to be done before passing it to the component.\n- While it's recommended to pre-format your data to be human-readable, you can also provide the `propertyLabels` parameter via this prop's `options` to relabel data values. See example in the [Stacking section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/line-chart#stacking).\n\nLearn more about [formatting data](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#formatting-data)."
|
|
11930
12169
|
}
|
|
11931
12170
|
},
|
|
11932
12171
|
{
|
|
11933
12172
|
"kind": "property",
|
|
11934
|
-
"name": "
|
|
12173
|
+
"name": "axes",
|
|
11935
12174
|
"type": {
|
|
11936
12175
|
"kind": "type-reference",
|
|
11937
|
-
"typeId": "
|
|
11938
|
-
"typeString": "
|
|
12176
|
+
"typeId": "ChartAxisPair:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12177
|
+
"typeString": "ChartAxisPair"
|
|
11939
12178
|
},
|
|
11940
12179
|
"jsdoc": {
|
|
11941
|
-
"text": "
|
|
12180
|
+
"text": "Configures the chart's axes. Using the `x` and `y` fields, you'll configure each axis individually with `field` and `fieldType` parameters, along with an optional `label` parameter:\n- `field` (Required): the field from your dataset to use. This value will be used as the displayed axis label if no `label` is specified.\n- `fieldType` (Required): the type of field. Can be `category`, `datetime`, or `linear`. Learn more about [field types](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#configuring-axes).\n- `label`: the axis label. If not specified, the `field` value will be used.\n\nYou can also include an `options` field to further configure the axes with the following options:\n- `groupFieldByColor` (string): specify a field to [apply color](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/line-chart#colors) to for visual clarity.\n- `stacking` (boolean): [stack grouped data](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/line-chart#stacking) instead of always rendering separated lines.\n- `colors` (object): [specify colors for values](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/line-chart#specify-colors-per-field-value) in the field specified in `groupFieldByColor`.\n\nLearn more about [chart axes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#configuring-axes)."
|
|
11942
12181
|
}
|
|
11943
12182
|
},
|
|
11944
12183
|
{
|
|
11945
12184
|
"kind": "property",
|
|
11946
|
-
"name": "
|
|
12185
|
+
"name": "options",
|
|
11947
12186
|
"type": {
|
|
11948
|
-
"kind": "
|
|
11949
|
-
"
|
|
12187
|
+
"kind": "type-reference",
|
|
12188
|
+
"typeId": "ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12189
|
+
"typeString": "ChartOptions"
|
|
12190
|
+
},
|
|
12191
|
+
"isOptional": true,
|
|
12192
|
+
"jsdoc": {
|
|
12193
|
+
"text": "Additional chart configuration options. Options include:\n- `title` (string): a title for the chart.\n- `showLegend` (boolean): set to `true` to display a legend above the chart.\n- `showDataLabels` (boolean): set to `true` to display labels above data points.\n- `showTooltips` (boolean): set to `true` to display tooltips for data points on hover.\n- `colorList` (array): specify a custom order for colors to be used in the report.\n\nLearn more about [chart options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/charts/overview#chart-options)."
|
|
12194
|
+
}
|
|
12195
|
+
},
|
|
12196
|
+
{
|
|
12197
|
+
"kind": "property",
|
|
12198
|
+
"name": "testId",
|
|
12199
|
+
"type": {
|
|
12200
|
+
"kind": "primitive",
|
|
12201
|
+
"name": "string"
|
|
12202
|
+
},
|
|
12203
|
+
"isOptional": true,
|
|
12204
|
+
"jsdoc": {
|
|
12205
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
12206
|
+
"tags": [
|
|
12207
|
+
{
|
|
12208
|
+
"name": "see",
|
|
12209
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
12210
|
+
}
|
|
12211
|
+
]
|
|
12212
|
+
}
|
|
12213
|
+
}
|
|
12214
|
+
]
|
|
12215
|
+
},
|
|
12216
|
+
"LinkProps:@hubspot/ui-extensions:dist/shared/types/components/link.d.ts": {
|
|
12217
|
+
"kind": "object",
|
|
12218
|
+
"properties": [
|
|
12219
|
+
{
|
|
12220
|
+
"kind": "property",
|
|
12221
|
+
"name": "children",
|
|
12222
|
+
"type": {
|
|
12223
|
+
"kind": "type-reference",
|
|
12224
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
12225
|
+
"typeString": "ReactNode"
|
|
12226
|
+
},
|
|
12227
|
+
"jsdoc": {
|
|
12228
|
+
"text": "Sets the content that will render inside the component."
|
|
12229
|
+
}
|
|
12230
|
+
},
|
|
12231
|
+
{
|
|
12232
|
+
"kind": "property",
|
|
12233
|
+
"name": "href",
|
|
12234
|
+
"type": {
|
|
12235
|
+
"kind": "type-reference",
|
|
12236
|
+
"typeId": "HrefProp:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
12237
|
+
"typeString": "HrefProp"
|
|
12238
|
+
},
|
|
12239
|
+
"jsdoc": {
|
|
12240
|
+
"text": "Sets the link's URL and open behavior. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon."
|
|
12241
|
+
}
|
|
12242
|
+
},
|
|
12243
|
+
{
|
|
12244
|
+
"kind": "property",
|
|
12245
|
+
"name": "variant",
|
|
12246
|
+
"type": {
|
|
12247
|
+
"kind": "union",
|
|
12248
|
+
"types": [
|
|
11950
12249
|
{
|
|
11951
12250
|
"kind": "literal",
|
|
11952
12251
|
"value": "primary"
|
|
@@ -11993,7 +12292,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11993
12292
|
},
|
|
11994
12293
|
"isOptional": true,
|
|
11995
12294
|
"jsdoc": {
|
|
11996
|
-
"text": "A function that
|
|
12295
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
11997
12296
|
"tags": [
|
|
11998
12297
|
{
|
|
11999
12298
|
"name": "event",
|
|
@@ -12028,7 +12327,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
12028
12327
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
12029
12328
|
"typeString": "ReactNode"
|
|
12030
12329
|
},
|
|
12031
|
-
"isOptional": true
|
|
12330
|
+
"isOptional": true,
|
|
12331
|
+
"jsdoc": {
|
|
12332
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
12333
|
+
}
|
|
12032
12334
|
},
|
|
12033
12335
|
{
|
|
12034
12336
|
"kind": "property",
|
|
@@ -13021,7 +13323,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
13021
13323
|
},
|
|
13022
13324
|
"isOptional": true,
|
|
13023
13325
|
"jsdoc": {
|
|
13024
|
-
"text": "A function that will be invoked when the button is clicked. It receives
|
|
13326
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
13025
13327
|
"tags": [
|
|
13026
13328
|
{
|
|
13027
13329
|
"name": "event",
|
|
@@ -13194,7 +13496,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
13194
13496
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
13195
13497
|
"typeString": "ReactNode"
|
|
13196
13498
|
},
|
|
13197
|
-
"isOptional": true
|
|
13499
|
+
"isOptional": true,
|
|
13500
|
+
"jsdoc": {
|
|
13501
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
13502
|
+
}
|
|
13198
13503
|
}
|
|
13199
13504
|
]
|
|
13200
13505
|
},
|
|
@@ -14014,6 +14319,27 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14014
14319
|
}
|
|
14015
14320
|
]
|
|
14016
14321
|
},
|
|
14322
|
+
"NonNullable:typescript@5.9.3:lib/lib.es5.d.ts": {
|
|
14323
|
+
"kind": "union",
|
|
14324
|
+
"types": [
|
|
14325
|
+
{
|
|
14326
|
+
"kind": "primitive",
|
|
14327
|
+
"name": "string"
|
|
14328
|
+
},
|
|
14329
|
+
{
|
|
14330
|
+
"kind": "primitive",
|
|
14331
|
+
"name": "number"
|
|
14332
|
+
},
|
|
14333
|
+
{
|
|
14334
|
+
"kind": "literal",
|
|
14335
|
+
"value": false
|
|
14336
|
+
},
|
|
14337
|
+
{
|
|
14338
|
+
"kind": "literal",
|
|
14339
|
+
"value": true
|
|
14340
|
+
}
|
|
14341
|
+
]
|
|
14342
|
+
},
|
|
14017
14343
|
"NumberInputProps:@hubspot/ui-extensions:dist/shared/types/components/inputs.d.ts": {
|
|
14018
14344
|
"kind": "object",
|
|
14019
14345
|
"properties": [
|
|
@@ -14459,7 +14785,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14459
14785
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
14460
14786
|
"typeString": "ReactNode"
|
|
14461
14787
|
},
|
|
14462
|
-
"isOptional": true
|
|
14788
|
+
"isOptional": true,
|
|
14789
|
+
"jsdoc": {
|
|
14790
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
14791
|
+
}
|
|
14463
14792
|
}
|
|
14464
14793
|
]
|
|
14465
14794
|
},
|
|
@@ -15393,34 +15722,373 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15393
15722
|
"text": "When set to `true`, displays a required indicator next to the toggle group.",
|
|
15394
15723
|
"tags": [
|
|
15395
15724
|
{
|
|
15396
|
-
"name": "defaultValue",
|
|
15397
|
-
"text": "`false`"
|
|
15725
|
+
"name": "defaultValue",
|
|
15726
|
+
"text": "`false`"
|
|
15727
|
+
}
|
|
15728
|
+
]
|
|
15729
|
+
}
|
|
15730
|
+
},
|
|
15731
|
+
{
|
|
15732
|
+
"kind": "property",
|
|
15733
|
+
"name": "tooltip",
|
|
15734
|
+
"type": {
|
|
15735
|
+
"kind": "primitive",
|
|
15736
|
+
"name": "string"
|
|
15737
|
+
},
|
|
15738
|
+
"isOptional": true,
|
|
15739
|
+
"jsdoc": {
|
|
15740
|
+
"text": "Text that will appear in a tooltip next to the toggle group label."
|
|
15741
|
+
}
|
|
15742
|
+
},
|
|
15743
|
+
{
|
|
15744
|
+
"kind": "property",
|
|
15745
|
+
"name": "error",
|
|
15746
|
+
"type": {
|
|
15747
|
+
"kind": "primitive",
|
|
15748
|
+
"name": "boolean"
|
|
15749
|
+
},
|
|
15750
|
+
"isOptional": true,
|
|
15751
|
+
"jsdoc": {
|
|
15752
|
+
"text": "When set to `true`, `validationMessage` is displayed as an error message if provided. The input will also render its error state to let the user know there is an error. If left `false`, `validationMessage` is displayed as a success message.",
|
|
15753
|
+
"tags": [
|
|
15754
|
+
{
|
|
15755
|
+
"name": "defaultValue",
|
|
15756
|
+
"text": "`false`"
|
|
15757
|
+
}
|
|
15758
|
+
]
|
|
15759
|
+
}
|
|
15760
|
+
},
|
|
15761
|
+
{
|
|
15762
|
+
"kind": "property",
|
|
15763
|
+
"name": "options",
|
|
15764
|
+
"type": {
|
|
15765
|
+
"kind": "array",
|
|
15766
|
+
"elementType": {
|
|
15767
|
+
"kind": "type-reference",
|
|
15768
|
+
"typeId": "ToggleGroupOption:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts",
|
|
15769
|
+
"typeString": "ToggleGroupOption"
|
|
15770
|
+
}
|
|
15771
|
+
},
|
|
15772
|
+
"jsdoc": {
|
|
15773
|
+
"text": "An array of options to display in the group.",
|
|
15774
|
+
"tags": [
|
|
15775
|
+
{
|
|
15776
|
+
"name": "defaultValue",
|
|
15777
|
+
"text": "`[]`"
|
|
15778
|
+
}
|
|
15779
|
+
]
|
|
15780
|
+
}
|
|
15781
|
+
},
|
|
15782
|
+
{
|
|
15783
|
+
"kind": "property",
|
|
15784
|
+
"name": "inline",
|
|
15785
|
+
"type": {
|
|
15786
|
+
"kind": "primitive",
|
|
15787
|
+
"name": "boolean"
|
|
15788
|
+
},
|
|
15789
|
+
"isOptional": true,
|
|
15790
|
+
"jsdoc": {
|
|
15791
|
+
"text": "When set to `true`, stacks the options horizontally.",
|
|
15792
|
+
"tags": [
|
|
15793
|
+
{
|
|
15794
|
+
"name": "defaultValue",
|
|
15795
|
+
"text": "`false`"
|
|
15796
|
+
}
|
|
15797
|
+
]
|
|
15798
|
+
}
|
|
15799
|
+
},
|
|
15800
|
+
{
|
|
15801
|
+
"kind": "property",
|
|
15802
|
+
"name": "variant",
|
|
15803
|
+
"type": {
|
|
15804
|
+
"kind": "union",
|
|
15805
|
+
"types": [
|
|
15806
|
+
{
|
|
15807
|
+
"kind": "literal",
|
|
15808
|
+
"value": "small"
|
|
15809
|
+
},
|
|
15810
|
+
{
|
|
15811
|
+
"kind": "literal",
|
|
15812
|
+
"value": "default"
|
|
15813
|
+
}
|
|
15814
|
+
]
|
|
15815
|
+
},
|
|
15816
|
+
"isOptional": true,
|
|
15817
|
+
"jsdoc": {
|
|
15818
|
+
"text": "The size of the toggle.",
|
|
15819
|
+
"tags": [
|
|
15820
|
+
{
|
|
15821
|
+
"name": "defaultValue",
|
|
15822
|
+
"text": "`\"default\"`"
|
|
15823
|
+
}
|
|
15824
|
+
]
|
|
15825
|
+
}
|
|
15826
|
+
},
|
|
15827
|
+
{
|
|
15828
|
+
"kind": "property",
|
|
15829
|
+
"name": "testId",
|
|
15830
|
+
"type": {
|
|
15831
|
+
"kind": "primitive",
|
|
15832
|
+
"name": "string"
|
|
15833
|
+
},
|
|
15834
|
+
"isOptional": true,
|
|
15835
|
+
"jsdoc": {
|
|
15836
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15837
|
+
"tags": [
|
|
15838
|
+
{
|
|
15839
|
+
"name": "see",
|
|
15840
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15841
|
+
}
|
|
15842
|
+
]
|
|
15843
|
+
}
|
|
15844
|
+
}
|
|
15845
|
+
]
|
|
15846
|
+
},
|
|
15847
|
+
"RadioButtonListProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts": {
|
|
15848
|
+
"kind": "object",
|
|
15849
|
+
"properties": [
|
|
15850
|
+
{
|
|
15851
|
+
"kind": "property",
|
|
15852
|
+
"name": "value",
|
|
15853
|
+
"type": {
|
|
15854
|
+
"kind": "union",
|
|
15855
|
+
"types": [
|
|
15856
|
+
{
|
|
15857
|
+
"kind": "primitive",
|
|
15858
|
+
"name": "string"
|
|
15859
|
+
},
|
|
15860
|
+
{
|
|
15861
|
+
"kind": "intersection",
|
|
15862
|
+
"types": [
|
|
15863
|
+
{
|
|
15864
|
+
"kind": "primitive",
|
|
15865
|
+
"name": "string"
|
|
15866
|
+
},
|
|
15867
|
+
{
|
|
15868
|
+
"kind": "array",
|
|
15869
|
+
"elementType": {
|
|
15870
|
+
"kind": "primitive",
|
|
15871
|
+
"name": "string"
|
|
15872
|
+
}
|
|
15873
|
+
}
|
|
15874
|
+
]
|
|
15875
|
+
}
|
|
15876
|
+
]
|
|
15877
|
+
},
|
|
15878
|
+
"isOptional": true
|
|
15879
|
+
},
|
|
15880
|
+
{
|
|
15881
|
+
"kind": "property",
|
|
15882
|
+
"name": "onChange",
|
|
15883
|
+
"type": {
|
|
15884
|
+
"kind": "function",
|
|
15885
|
+
"functionKind": "arrow",
|
|
15886
|
+
"parameters": [
|
|
15887
|
+
{
|
|
15888
|
+
"kind": "parameter",
|
|
15889
|
+
"name": "value",
|
|
15890
|
+
"type": {
|
|
15891
|
+
"kind": "primitive",
|
|
15892
|
+
"name": "string"
|
|
15893
|
+
}
|
|
15894
|
+
}
|
|
15895
|
+
],
|
|
15896
|
+
"returnType": {
|
|
15897
|
+
"kind": "primitive",
|
|
15898
|
+
"name": "void"
|
|
15899
|
+
}
|
|
15900
|
+
},
|
|
15901
|
+
"isOptional": true
|
|
15902
|
+
},
|
|
15903
|
+
{
|
|
15904
|
+
"kind": "property",
|
|
15905
|
+
"name": "name",
|
|
15906
|
+
"type": {
|
|
15907
|
+
"kind": "primitive",
|
|
15908
|
+
"name": "string"
|
|
15909
|
+
}
|
|
15910
|
+
},
|
|
15911
|
+
{
|
|
15912
|
+
"kind": "property",
|
|
15913
|
+
"name": "options",
|
|
15914
|
+
"type": {
|
|
15915
|
+
"kind": "array",
|
|
15916
|
+
"elementType": {
|
|
15917
|
+
"kind": "type-reference",
|
|
15918
|
+
"typeId": "ToggleGroupOption:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts",
|
|
15919
|
+
"typeString": "ToggleGroupOption"
|
|
15920
|
+
}
|
|
15921
|
+
}
|
|
15922
|
+
},
|
|
15923
|
+
{
|
|
15924
|
+
"kind": "property",
|
|
15925
|
+
"name": "variant",
|
|
15926
|
+
"type": {
|
|
15927
|
+
"kind": "union",
|
|
15928
|
+
"types": [
|
|
15929
|
+
{
|
|
15930
|
+
"kind": "primitive",
|
|
15931
|
+
"name": "undefined"
|
|
15932
|
+
},
|
|
15933
|
+
{
|
|
15934
|
+
"kind": "literal",
|
|
15935
|
+
"value": "small"
|
|
15936
|
+
},
|
|
15937
|
+
{
|
|
15938
|
+
"kind": "literal",
|
|
15939
|
+
"value": "default"
|
|
15940
|
+
}
|
|
15941
|
+
]
|
|
15942
|
+
}
|
|
15943
|
+
},
|
|
15944
|
+
{
|
|
15945
|
+
"kind": "property",
|
|
15946
|
+
"name": "inline",
|
|
15947
|
+
"type": {
|
|
15948
|
+
"kind": "primitive",
|
|
15949
|
+
"name": "boolean"
|
|
15950
|
+
},
|
|
15951
|
+
"isOptional": true
|
|
15952
|
+
},
|
|
15953
|
+
{
|
|
15954
|
+
"kind": "property",
|
|
15955
|
+
"name": "testId",
|
|
15956
|
+
"type": {
|
|
15957
|
+
"kind": "primitive",
|
|
15958
|
+
"name": "string"
|
|
15959
|
+
},
|
|
15960
|
+
"isOptional": true,
|
|
15961
|
+
"jsdoc": {
|
|
15962
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15963
|
+
"tags": [
|
|
15964
|
+
{
|
|
15965
|
+
"name": "see",
|
|
15966
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15967
|
+
}
|
|
15968
|
+
]
|
|
15969
|
+
}
|
|
15970
|
+
}
|
|
15971
|
+
]
|
|
15972
|
+
},
|
|
15973
|
+
"RadioButtonProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts": {
|
|
15974
|
+
"kind": "object",
|
|
15975
|
+
"properties": [
|
|
15976
|
+
{
|
|
15977
|
+
"kind": "property",
|
|
15978
|
+
"name": "description",
|
|
15979
|
+
"type": {
|
|
15980
|
+
"kind": "primitive",
|
|
15981
|
+
"name": "string"
|
|
15982
|
+
},
|
|
15983
|
+
"isOptional": true,
|
|
15984
|
+
"jsdoc": {
|
|
15985
|
+
"text": "Text that describes the field's purpose."
|
|
15986
|
+
}
|
|
15987
|
+
},
|
|
15988
|
+
{
|
|
15989
|
+
"kind": "property",
|
|
15990
|
+
"name": "name",
|
|
15991
|
+
"type": {
|
|
15992
|
+
"kind": "primitive",
|
|
15993
|
+
"name": "string"
|
|
15994
|
+
},
|
|
15995
|
+
"isOptional": true,
|
|
15996
|
+
"jsdoc": {
|
|
15997
|
+
"text": "The checkbox's unique identifier."
|
|
15998
|
+
}
|
|
15999
|
+
},
|
|
16000
|
+
{
|
|
16001
|
+
"kind": "property",
|
|
16002
|
+
"name": "value",
|
|
16003
|
+
"type": {
|
|
16004
|
+
"kind": "primitive",
|
|
16005
|
+
"name": "string"
|
|
16006
|
+
},
|
|
16007
|
+
"isOptional": true,
|
|
16008
|
+
"jsdoc": {
|
|
16009
|
+
"text": "The checkbox value. This value is not displayed on the card, but is passed on the server side when submitted, along with the checkbox name."
|
|
16010
|
+
}
|
|
16011
|
+
},
|
|
16012
|
+
{
|
|
16013
|
+
"kind": "property",
|
|
16014
|
+
"name": "readOnly",
|
|
16015
|
+
"type": {
|
|
16016
|
+
"kind": "primitive",
|
|
16017
|
+
"name": "boolean"
|
|
16018
|
+
},
|
|
16019
|
+
"isOptional": true,
|
|
16020
|
+
"jsdoc": {
|
|
16021
|
+
"text": "When set to `true`, the checkbox cannot be selected."
|
|
16022
|
+
}
|
|
16023
|
+
},
|
|
16024
|
+
{
|
|
16025
|
+
"kind": "property",
|
|
16026
|
+
"name": "onChange",
|
|
16027
|
+
"type": {
|
|
16028
|
+
"kind": "function",
|
|
16029
|
+
"functionKind": "arrow",
|
|
16030
|
+
"parameters": [
|
|
16031
|
+
{
|
|
16032
|
+
"kind": "parameter",
|
|
16033
|
+
"name": "checked",
|
|
16034
|
+
"type": {
|
|
16035
|
+
"kind": "primitive",
|
|
16036
|
+
"name": "boolean"
|
|
16037
|
+
}
|
|
16038
|
+
},
|
|
16039
|
+
{
|
|
16040
|
+
"kind": "parameter",
|
|
16041
|
+
"name": "value",
|
|
16042
|
+
"type": {
|
|
16043
|
+
"kind": "primitive",
|
|
16044
|
+
"name": "string"
|
|
16045
|
+
}
|
|
16046
|
+
}
|
|
16047
|
+
],
|
|
16048
|
+
"returnType": {
|
|
16049
|
+
"kind": "primitive",
|
|
16050
|
+
"name": "void"
|
|
16051
|
+
}
|
|
16052
|
+
},
|
|
16053
|
+
"isOptional": true,
|
|
16054
|
+
"jsdoc": {
|
|
16055
|
+
"text": "A callback function that is called when the checkbox is selected or cleared. Passes the new value.",
|
|
16056
|
+
"tags": [
|
|
16057
|
+
{
|
|
16058
|
+
"name": "event",
|
|
16059
|
+
"text": ""
|
|
15398
16060
|
}
|
|
15399
16061
|
]
|
|
15400
16062
|
}
|
|
15401
16063
|
},
|
|
15402
16064
|
{
|
|
15403
16065
|
"kind": "property",
|
|
15404
|
-
"name": "
|
|
16066
|
+
"name": "testId",
|
|
15405
16067
|
"type": {
|
|
15406
16068
|
"kind": "primitive",
|
|
15407
16069
|
"name": "string"
|
|
15408
16070
|
},
|
|
15409
16071
|
"isOptional": true,
|
|
15410
16072
|
"jsdoc": {
|
|
15411
|
-
"text": "
|
|
16073
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
16074
|
+
"tags": [
|
|
16075
|
+
{
|
|
16076
|
+
"name": "see",
|
|
16077
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
16078
|
+
}
|
|
16079
|
+
]
|
|
15412
16080
|
}
|
|
15413
16081
|
},
|
|
15414
16082
|
{
|
|
15415
16083
|
"kind": "property",
|
|
15416
|
-
"name": "
|
|
16084
|
+
"name": "inline",
|
|
15417
16085
|
"type": {
|
|
15418
16086
|
"kind": "primitive",
|
|
15419
16087
|
"name": "boolean"
|
|
15420
16088
|
},
|
|
15421
16089
|
"isOptional": true,
|
|
15422
16090
|
"jsdoc": {
|
|
15423
|
-
"text": "When set to `true`,
|
|
16091
|
+
"text": "When set to `true`, arranges checkboxes side by side.",
|
|
15424
16092
|
"tags": [
|
|
15425
16093
|
{
|
|
15426
16094
|
"name": "defaultValue",
|
|
@@ -15431,39 +16099,36 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15431
16099
|
},
|
|
15432
16100
|
{
|
|
15433
16101
|
"kind": "property",
|
|
15434
|
-
"name": "
|
|
16102
|
+
"name": "checked",
|
|
15435
16103
|
"type": {
|
|
15436
|
-
"kind": "
|
|
15437
|
-
"
|
|
15438
|
-
"kind": "type-reference",
|
|
15439
|
-
"typeId": "ToggleGroupOption:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts",
|
|
15440
|
-
"typeString": "ToggleGroupOption"
|
|
15441
|
-
}
|
|
16104
|
+
"kind": "primitive",
|
|
16105
|
+
"name": "boolean"
|
|
15442
16106
|
},
|
|
16107
|
+
"isOptional": true,
|
|
15443
16108
|
"jsdoc": {
|
|
15444
|
-
"text": "
|
|
16109
|
+
"text": "When set to `true`, the checkbox is selected.",
|
|
15445
16110
|
"tags": [
|
|
15446
16111
|
{
|
|
15447
16112
|
"name": "defaultValue",
|
|
15448
|
-
"text": "`
|
|
16113
|
+
"text": "`false`"
|
|
15449
16114
|
}
|
|
15450
16115
|
]
|
|
15451
16116
|
}
|
|
15452
16117
|
},
|
|
15453
16118
|
{
|
|
15454
16119
|
"kind": "property",
|
|
15455
|
-
"name": "
|
|
16120
|
+
"name": "readonly",
|
|
15456
16121
|
"type": {
|
|
15457
16122
|
"kind": "primitive",
|
|
15458
16123
|
"name": "boolean"
|
|
15459
16124
|
},
|
|
15460
16125
|
"isOptional": true,
|
|
15461
16126
|
"jsdoc": {
|
|
15462
|
-
"text": "
|
|
16127
|
+
"text": "",
|
|
15463
16128
|
"tags": [
|
|
15464
16129
|
{
|
|
15465
|
-
"name": "
|
|
15466
|
-
"text": "
|
|
16130
|
+
"name": "deprecated",
|
|
16131
|
+
"text": "use readOnly instead"
|
|
15467
16132
|
}
|
|
15468
16133
|
]
|
|
15469
16134
|
}
|
|
@@ -15486,7 +16151,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15486
16151
|
},
|
|
15487
16152
|
"isOptional": true,
|
|
15488
16153
|
"jsdoc": {
|
|
15489
|
-
"text": "The size of the
|
|
16154
|
+
"text": "The size of the checkbox.",
|
|
15490
16155
|
"tags": [
|
|
15491
16156
|
{
|
|
15492
16157
|
"name": "defaultValue",
|
|
@@ -15497,165 +16162,37 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15497
16162
|
},
|
|
15498
16163
|
{
|
|
15499
16164
|
"kind": "property",
|
|
15500
|
-
"name": "
|
|
16165
|
+
"name": "children",
|
|
15501
16166
|
"type": {
|
|
15502
|
-
"kind": "
|
|
15503
|
-
"
|
|
16167
|
+
"kind": "type-reference",
|
|
16168
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
16169
|
+
"typeString": "ReactNode"
|
|
15504
16170
|
},
|
|
15505
16171
|
"isOptional": true,
|
|
15506
16172
|
"jsdoc": {
|
|
15507
|
-
"text": "
|
|
15508
|
-
"tags": [
|
|
15509
|
-
{
|
|
15510
|
-
"name": "see",
|
|
15511
|
-
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15512
|
-
}
|
|
15513
|
-
]
|
|
15514
|
-
}
|
|
15515
|
-
}
|
|
15516
|
-
]
|
|
15517
|
-
},
|
|
15518
|
-
"RadioButtonListProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts": {
|
|
15519
|
-
"kind": "object",
|
|
15520
|
-
"properties": [
|
|
15521
|
-
{
|
|
15522
|
-
"kind": "property",
|
|
15523
|
-
"name": "value",
|
|
15524
|
-
"type": {
|
|
15525
|
-
"kind": "union",
|
|
15526
|
-
"types": [
|
|
15527
|
-
{
|
|
15528
|
-
"kind": "primitive",
|
|
15529
|
-
"name": "string"
|
|
15530
|
-
},
|
|
15531
|
-
{
|
|
15532
|
-
"kind": "intersection",
|
|
15533
|
-
"types": [
|
|
15534
|
-
{
|
|
15535
|
-
"kind": "primitive",
|
|
15536
|
-
"name": "string"
|
|
15537
|
-
},
|
|
15538
|
-
{
|
|
15539
|
-
"kind": "array",
|
|
15540
|
-
"elementType": {
|
|
15541
|
-
"kind": "primitive",
|
|
15542
|
-
"name": "string"
|
|
15543
|
-
}
|
|
15544
|
-
}
|
|
15545
|
-
]
|
|
15546
|
-
}
|
|
15547
|
-
]
|
|
15548
|
-
},
|
|
15549
|
-
"isOptional": true
|
|
15550
|
-
},
|
|
15551
|
-
{
|
|
15552
|
-
"kind": "property",
|
|
15553
|
-
"name": "onChange",
|
|
15554
|
-
"type": {
|
|
15555
|
-
"kind": "function",
|
|
15556
|
-
"functionKind": "arrow",
|
|
15557
|
-
"parameters": [
|
|
15558
|
-
{
|
|
15559
|
-
"kind": "parameter",
|
|
15560
|
-
"name": "value",
|
|
15561
|
-
"type": {
|
|
15562
|
-
"kind": "primitive",
|
|
15563
|
-
"name": "string"
|
|
15564
|
-
}
|
|
15565
|
-
}
|
|
15566
|
-
],
|
|
15567
|
-
"returnType": {
|
|
15568
|
-
"kind": "primitive",
|
|
15569
|
-
"name": "void"
|
|
15570
|
-
}
|
|
15571
|
-
},
|
|
15572
|
-
"isOptional": true
|
|
15573
|
-
},
|
|
15574
|
-
{
|
|
15575
|
-
"kind": "property",
|
|
15576
|
-
"name": "name",
|
|
15577
|
-
"type": {
|
|
15578
|
-
"kind": "primitive",
|
|
15579
|
-
"name": "string"
|
|
15580
|
-
}
|
|
15581
|
-
},
|
|
15582
|
-
{
|
|
15583
|
-
"kind": "property",
|
|
15584
|
-
"name": "options",
|
|
15585
|
-
"type": {
|
|
15586
|
-
"kind": "array",
|
|
15587
|
-
"elementType": {
|
|
15588
|
-
"kind": "type-reference",
|
|
15589
|
-
"typeId": "ToggleGroupOption:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts",
|
|
15590
|
-
"typeString": "ToggleGroupOption"
|
|
15591
|
-
}
|
|
15592
|
-
}
|
|
15593
|
-
},
|
|
15594
|
-
{
|
|
15595
|
-
"kind": "property",
|
|
15596
|
-
"name": "variant",
|
|
15597
|
-
"type": {
|
|
15598
|
-
"kind": "union",
|
|
15599
|
-
"types": [
|
|
15600
|
-
{
|
|
15601
|
-
"kind": "primitive",
|
|
15602
|
-
"name": "undefined"
|
|
15603
|
-
},
|
|
15604
|
-
{
|
|
15605
|
-
"kind": "literal",
|
|
15606
|
-
"value": "small"
|
|
15607
|
-
},
|
|
15608
|
-
{
|
|
15609
|
-
"kind": "literal",
|
|
15610
|
-
"value": "default"
|
|
15611
|
-
}
|
|
15612
|
-
]
|
|
16173
|
+
"text": "The text that displays next to the checkbox."
|
|
15613
16174
|
}
|
|
15614
16175
|
},
|
|
15615
16176
|
{
|
|
15616
16177
|
"kind": "property",
|
|
15617
|
-
"name": "
|
|
16178
|
+
"name": "initialIsChecked",
|
|
15618
16179
|
"type": {
|
|
15619
16180
|
"kind": "primitive",
|
|
15620
16181
|
"name": "boolean"
|
|
15621
16182
|
},
|
|
15622
|
-
"isOptional": true
|
|
15623
|
-
},
|
|
15624
|
-
{
|
|
15625
|
-
"kind": "property",
|
|
15626
|
-
"name": "testId",
|
|
15627
|
-
"type": {
|
|
15628
|
-
"kind": "primitive",
|
|
15629
|
-
"name": "string"
|
|
15630
|
-
},
|
|
15631
16183
|
"isOptional": true,
|
|
15632
16184
|
"jsdoc": {
|
|
15633
|
-
"text": "
|
|
16185
|
+
"text": "When set to `true`, the checkbox is selected by default.",
|
|
15634
16186
|
"tags": [
|
|
15635
16187
|
{
|
|
15636
|
-
"name": "
|
|
15637
|
-
"text": "
|
|
16188
|
+
"name": "defaultValue",
|
|
16189
|
+
"text": "`false`"
|
|
15638
16190
|
}
|
|
15639
16191
|
]
|
|
15640
16192
|
}
|
|
15641
16193
|
}
|
|
15642
16194
|
]
|
|
15643
16195
|
},
|
|
15644
|
-
"RadioButtonProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts": {
|
|
15645
|
-
"kind": "built-in-type-reference",
|
|
15646
|
-
"name": "Omit",
|
|
15647
|
-
"typeArguments": [
|
|
15648
|
-
{
|
|
15649
|
-
"kind": "type-reference",
|
|
15650
|
-
"typeId": "CheckboxProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts",
|
|
15651
|
-
"typeString": "CheckboxProps"
|
|
15652
|
-
},
|
|
15653
|
-
{
|
|
15654
|
-
"kind": "literal",
|
|
15655
|
-
"value": "aria-label"
|
|
15656
|
-
}
|
|
15657
|
-
]
|
|
15658
|
-
},
|
|
15659
16196
|
"ReactNode:@types/react@18.3.26:index.d.ts": {
|
|
15660
16197
|
"kind": "external-type-reference",
|
|
15661
16198
|
"typeName": "ReactNode",
|
|
@@ -16174,8 +16711,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16174
16711
|
"kind": "parameter",
|
|
16175
16712
|
"name": "value",
|
|
16176
16713
|
"type": {
|
|
16177
|
-
"kind": "
|
|
16178
|
-
"
|
|
16714
|
+
"kind": "type-reference",
|
|
16715
|
+
"typeId": "NonNullable:typescript@5.9.3:lib/lib.es5.d.ts",
|
|
16716
|
+
"typeString": "NonNullable<string | number | boolean | undefined>",
|
|
16179
16717
|
"typeArguments": [
|
|
16180
16718
|
{
|
|
16181
16719
|
"kind": "union",
|
|
@@ -16642,8 +17180,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16642
17180
|
"kind": "parameter",
|
|
16643
17181
|
"name": "value",
|
|
16644
17182
|
"type": {
|
|
16645
|
-
"kind": "
|
|
16646
|
-
"
|
|
17183
|
+
"kind": "type-reference",
|
|
17184
|
+
"typeId": "NonNullable:typescript@5.9.3:lib/lib.es5.d.ts",
|
|
17185
|
+
"typeString": "NonNullable<\"none\" | \"ascending\" | \"descending\">",
|
|
16647
17186
|
"typeArguments": [
|
|
16648
17187
|
{
|
|
16649
17188
|
"kind": "union",
|
|
@@ -16782,6 +17321,68 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16782
17321
|
}
|
|
16783
17322
|
]
|
|
16784
17323
|
},
|
|
17324
|
+
"SpacerProps:@hubspot/ui-extensions:dist/shared/types/components/spacer.d.ts": {
|
|
17325
|
+
"kind": "object",
|
|
17326
|
+
"properties": [
|
|
17327
|
+
{
|
|
17328
|
+
"kind": "property",
|
|
17329
|
+
"name": "size",
|
|
17330
|
+
"type": {
|
|
17331
|
+
"kind": "union",
|
|
17332
|
+
"types": [
|
|
17333
|
+
{
|
|
17334
|
+
"kind": "literal",
|
|
17335
|
+
"value": "extra-small"
|
|
17336
|
+
},
|
|
17337
|
+
{
|
|
17338
|
+
"kind": "literal",
|
|
17339
|
+
"value": "small"
|
|
17340
|
+
},
|
|
17341
|
+
{
|
|
17342
|
+
"kind": "literal",
|
|
17343
|
+
"value": "medium"
|
|
17344
|
+
},
|
|
17345
|
+
{
|
|
17346
|
+
"kind": "literal",
|
|
17347
|
+
"value": "large"
|
|
17348
|
+
},
|
|
17349
|
+
{
|
|
17350
|
+
"kind": "literal",
|
|
17351
|
+
"value": "extra-large"
|
|
17352
|
+
}
|
|
17353
|
+
]
|
|
17354
|
+
},
|
|
17355
|
+
"isOptional": true,
|
|
17356
|
+
"jsdoc": {
|
|
17357
|
+
"text": "The amount of vertical space to render.",
|
|
17358
|
+
"tags": [
|
|
17359
|
+
{
|
|
17360
|
+
"name": "defaultValue",
|
|
17361
|
+
"text": "`\"small\"`"
|
|
17362
|
+
}
|
|
17363
|
+
]
|
|
17364
|
+
}
|
|
17365
|
+
},
|
|
17366
|
+
{
|
|
17367
|
+
"kind": "property",
|
|
17368
|
+
"name": "testId",
|
|
17369
|
+
"type": {
|
|
17370
|
+
"kind": "primitive",
|
|
17371
|
+
"name": "string"
|
|
17372
|
+
},
|
|
17373
|
+
"isOptional": true,
|
|
17374
|
+
"jsdoc": {
|
|
17375
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
17376
|
+
"tags": [
|
|
17377
|
+
{
|
|
17378
|
+
"name": "see",
|
|
17379
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
17380
|
+
}
|
|
17381
|
+
]
|
|
17382
|
+
}
|
|
17383
|
+
}
|
|
17384
|
+
]
|
|
17385
|
+
},
|
|
16785
17386
|
"Stack2Props:@hubspot/ui-extensions:dist/shared/types/experimental.d.ts": {
|
|
16786
17387
|
"kind": "object",
|
|
16787
17388
|
"properties": [
|
|
@@ -17166,7 +17767,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
17166
17767
|
},
|
|
17167
17768
|
"isOptional": true,
|
|
17168
17769
|
"jsdoc": {
|
|
17169
|
-
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be
|
|
17770
|
+
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be [StatisticsTrend](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics) or [Text](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/text)."
|
|
17170
17771
|
}
|
|
17171
17772
|
},
|
|
17172
17773
|
{
|
|
@@ -17201,7 +17802,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
17201
17802
|
"typeString": "ReactNode"
|
|
17202
17803
|
},
|
|
17203
17804
|
"jsdoc": {
|
|
17204
|
-
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be
|
|
17805
|
+
"text": "Sets the content that will render inside the component. This prop is passed implicitly by providing sub-components. The children should be [StatisticsItem](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/statistics)."
|
|
17205
17806
|
}
|
|
17206
17807
|
},
|
|
17207
17808
|
{
|
|
@@ -18862,7 +19463,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
18862
19463
|
},
|
|
18863
19464
|
"isOptional": true,
|
|
18864
19465
|
"jsdoc": {
|
|
18865
|
-
"text": "A function that will be invoked when the
|
|
19466
|
+
"text": "A function that will be invoked when the button is clicked. It receives an event object and a reactions object\nwith methods to control overlays. Its return value is ignored.",
|
|
18866
19467
|
"tags": [
|
|
18867
19468
|
{
|
|
18868
19469
|
"name": "event",
|
|
@@ -18897,7 +19498,10 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
18897
19498
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
18898
19499
|
"typeString": "ReactNode"
|
|
18899
19500
|
},
|
|
18900
|
-
"isOptional": true
|
|
19501
|
+
"isOptional": true,
|
|
19502
|
+
"jsdoc": {
|
|
19503
|
+
"text": "Include a [Modal](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/modal) or\n[Panel](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel) component to\nopen it as an overlay on click.\n\nLearn more about [using overlays](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-extensions-sdk#open-overlays)."
|
|
19504
|
+
}
|
|
18901
19505
|
},
|
|
18902
19506
|
{
|
|
18903
19507
|
"kind": "property",
|