@hubspot/ui-extensions-sdk-api-metadata 0.12.0 → 0.12.1
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 +502 -22
- 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 +15 -19
- 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/jsx-utils.d.ts +32 -0
- package/dist/internal/utils/jsx-utils.js +77 -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 +6 -5
- package/dist/internal/utils/html-utils.d.ts +0 -7
- package/dist/internal/utils/html-utils.js +0 -18
|
@@ -77,12 +77,12 @@ 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
88
|
"text": "The props type for {@link !components.BarChart}.",
|
|
@@ -1013,12 +1013,12 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1013
1013
|
{
|
|
1014
1014
|
"kind": "export",
|
|
1015
1015
|
"exportName": "LineChartProps",
|
|
1016
|
-
"declarationKind": "
|
|
1016
|
+
"declarationKind": "interface",
|
|
1017
1017
|
"isType": true,
|
|
1018
1018
|
"type": {
|
|
1019
1019
|
"kind": "type-reference",
|
|
1020
|
-
"typeId": "
|
|
1021
|
-
"typeString": "
|
|
1020
|
+
"typeId": "LineChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
1021
|
+
"typeString": "LineChartProps"
|
|
1022
1022
|
},
|
|
1023
1023
|
"jsdoc": {
|
|
1024
1024
|
"text": "The props type for {@link !components.LineChart}.",
|
|
@@ -3028,7 +3028,21 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3028
3028
|
"name": "colors",
|
|
3029
3029
|
"type": {
|
|
3030
3030
|
"kind": "object",
|
|
3031
|
-
"properties": []
|
|
3031
|
+
"properties": [],
|
|
3032
|
+
"indexSignatures": [
|
|
3033
|
+
{
|
|
3034
|
+
"kind": "index-signature",
|
|
3035
|
+
"keyType": {
|
|
3036
|
+
"kind": "primitive",
|
|
3037
|
+
"name": "string"
|
|
3038
|
+
},
|
|
3039
|
+
"valueType": {
|
|
3040
|
+
"kind": "type-reference",
|
|
3041
|
+
"typeId": "ChartColor:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3042
|
+
"typeString": "ChartColor"
|
|
3043
|
+
}
|
|
3044
|
+
}
|
|
3045
|
+
]
|
|
3032
3046
|
},
|
|
3033
3047
|
"isOptional": true,
|
|
3034
3048
|
"jsdoc": {
|
|
@@ -3037,6 +3051,101 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3037
3051
|
}
|
|
3038
3052
|
]
|
|
3039
3053
|
},
|
|
3054
|
+
"BarChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
3055
|
+
"kind": "object",
|
|
3056
|
+
"properties": [
|
|
3057
|
+
{
|
|
3058
|
+
"kind": "property",
|
|
3059
|
+
"name": "data",
|
|
3060
|
+
"type": {
|
|
3061
|
+
"kind": "union",
|
|
3062
|
+
"types": [
|
|
3063
|
+
{
|
|
3064
|
+
"kind": "array",
|
|
3065
|
+
"elementType": {
|
|
3066
|
+
"kind": "type-reference",
|
|
3067
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3068
|
+
"typeString": "ChartDataRow"
|
|
3069
|
+
}
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"kind": "object",
|
|
3073
|
+
"properties": [
|
|
3074
|
+
{
|
|
3075
|
+
"kind": "property",
|
|
3076
|
+
"name": "data",
|
|
3077
|
+
"type": {
|
|
3078
|
+
"kind": "array",
|
|
3079
|
+
"elementType": {
|
|
3080
|
+
"kind": "type-reference",
|
|
3081
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3082
|
+
"typeString": "ChartDataRow"
|
|
3083
|
+
}
|
|
3084
|
+
}
|
|
3085
|
+
},
|
|
3086
|
+
{
|
|
3087
|
+
"kind": "property",
|
|
3088
|
+
"name": "options",
|
|
3089
|
+
"type": {
|
|
3090
|
+
"kind": "type-reference",
|
|
3091
|
+
"typeId": "ChartDataOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3092
|
+
"typeString": "ChartDataOptions"
|
|
3093
|
+
},
|
|
3094
|
+
"isOptional": true
|
|
3095
|
+
}
|
|
3096
|
+
]
|
|
3097
|
+
}
|
|
3098
|
+
]
|
|
3099
|
+
},
|
|
3100
|
+
"jsdoc": {
|
|
3101
|
+
"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)."
|
|
3102
|
+
}
|
|
3103
|
+
},
|
|
3104
|
+
{
|
|
3105
|
+
"kind": "property",
|
|
3106
|
+
"name": "axes",
|
|
3107
|
+
"type": {
|
|
3108
|
+
"kind": "type-reference",
|
|
3109
|
+
"typeId": "ChartAxisPair:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3110
|
+
"typeString": "ChartAxisPair"
|
|
3111
|
+
},
|
|
3112
|
+
"jsdoc": {
|
|
3113
|
+
"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)."
|
|
3114
|
+
}
|
|
3115
|
+
},
|
|
3116
|
+
{
|
|
3117
|
+
"kind": "property",
|
|
3118
|
+
"name": "options",
|
|
3119
|
+
"type": {
|
|
3120
|
+
"kind": "type-reference",
|
|
3121
|
+
"typeId": "ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
3122
|
+
"typeString": "ChartOptions"
|
|
3123
|
+
},
|
|
3124
|
+
"isOptional": true,
|
|
3125
|
+
"jsdoc": {
|
|
3126
|
+
"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)."
|
|
3127
|
+
}
|
|
3128
|
+
},
|
|
3129
|
+
{
|
|
3130
|
+
"kind": "property",
|
|
3131
|
+
"name": "testId",
|
|
3132
|
+
"type": {
|
|
3133
|
+
"kind": "primitive",
|
|
3134
|
+
"name": "string"
|
|
3135
|
+
},
|
|
3136
|
+
"isOptional": true,
|
|
3137
|
+
"jsdoc": {
|
|
3138
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
3139
|
+
"tags": [
|
|
3140
|
+
{
|
|
3141
|
+
"name": "see",
|
|
3142
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
3143
|
+
}
|
|
3144
|
+
]
|
|
3145
|
+
}
|
|
3146
|
+
}
|
|
3147
|
+
]
|
|
3148
|
+
},
|
|
3040
3149
|
"BaseButtonProps:@hubspot/ui-extensions:dist/shared/types/components/button.d.ts": {
|
|
3041
3150
|
"kind": "object",
|
|
3042
3151
|
"properties": [
|
|
@@ -4825,7 +4934,30 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4825
4934
|
"name": "propertyLabels",
|
|
4826
4935
|
"type": {
|
|
4827
4936
|
"kind": "object",
|
|
4828
|
-
"properties": []
|
|
4937
|
+
"properties": [],
|
|
4938
|
+
"indexSignatures": [
|
|
4939
|
+
{
|
|
4940
|
+
"kind": "index-signature",
|
|
4941
|
+
"keyType": {
|
|
4942
|
+
"kind": "primitive",
|
|
4943
|
+
"name": "string"
|
|
4944
|
+
},
|
|
4945
|
+
"valueType": {
|
|
4946
|
+
"kind": "built-in-type-reference",
|
|
4947
|
+
"name": "Record",
|
|
4948
|
+
"typeArguments": [
|
|
4949
|
+
{
|
|
4950
|
+
"kind": "primitive",
|
|
4951
|
+
"name": "string"
|
|
4952
|
+
},
|
|
4953
|
+
{
|
|
4954
|
+
"kind": "primitive",
|
|
4955
|
+
"name": "string"
|
|
4956
|
+
}
|
|
4957
|
+
]
|
|
4958
|
+
}
|
|
4959
|
+
}
|
|
4960
|
+
]
|
|
4829
4961
|
},
|
|
4830
4962
|
"isOptional": true,
|
|
4831
4963
|
"jsdoc": {
|
|
@@ -4836,7 +4968,29 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4836
4968
|
},
|
|
4837
4969
|
"ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
4838
4970
|
"kind": "object",
|
|
4839
|
-
"properties": []
|
|
4971
|
+
"properties": [],
|
|
4972
|
+
"indexSignatures": [
|
|
4973
|
+
{
|
|
4974
|
+
"kind": "index-signature",
|
|
4975
|
+
"keyType": {
|
|
4976
|
+
"kind": "primitive",
|
|
4977
|
+
"name": "string"
|
|
4978
|
+
},
|
|
4979
|
+
"valueType": {
|
|
4980
|
+
"kind": "union",
|
|
4981
|
+
"types": [
|
|
4982
|
+
{
|
|
4983
|
+
"kind": "primitive",
|
|
4984
|
+
"name": "string"
|
|
4985
|
+
},
|
|
4986
|
+
{
|
|
4987
|
+
"kind": "primitive",
|
|
4988
|
+
"name": "number"
|
|
4989
|
+
}
|
|
4990
|
+
]
|
|
4991
|
+
}
|
|
4992
|
+
}
|
|
4993
|
+
]
|
|
4840
4994
|
},
|
|
4841
4995
|
"ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
4842
4996
|
"kind": "object",
|
|
@@ -5019,7 +5173,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5019
5173
|
},
|
|
5020
5174
|
"isOptional": true,
|
|
5021
5175
|
"jsdoc": {
|
|
5022
|
-
"text": "Additional chart configuration options."
|
|
5176
|
+
"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
5177
|
}
|
|
5024
5178
|
},
|
|
5025
5179
|
{
|
|
@@ -11914,6 +12068,101 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11914
12068
|
}
|
|
11915
12069
|
]
|
|
11916
12070
|
},
|
|
12071
|
+
"LineChartProps:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts": {
|
|
12072
|
+
"kind": "object",
|
|
12073
|
+
"properties": [
|
|
12074
|
+
{
|
|
12075
|
+
"kind": "property",
|
|
12076
|
+
"name": "data",
|
|
12077
|
+
"type": {
|
|
12078
|
+
"kind": "union",
|
|
12079
|
+
"types": [
|
|
12080
|
+
{
|
|
12081
|
+
"kind": "array",
|
|
12082
|
+
"elementType": {
|
|
12083
|
+
"kind": "type-reference",
|
|
12084
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12085
|
+
"typeString": "ChartDataRow"
|
|
12086
|
+
}
|
|
12087
|
+
},
|
|
12088
|
+
{
|
|
12089
|
+
"kind": "object",
|
|
12090
|
+
"properties": [
|
|
12091
|
+
{
|
|
12092
|
+
"kind": "property",
|
|
12093
|
+
"name": "data",
|
|
12094
|
+
"type": {
|
|
12095
|
+
"kind": "array",
|
|
12096
|
+
"elementType": {
|
|
12097
|
+
"kind": "type-reference",
|
|
12098
|
+
"typeId": "ChartDataRow:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12099
|
+
"typeString": "ChartDataRow"
|
|
12100
|
+
}
|
|
12101
|
+
}
|
|
12102
|
+
},
|
|
12103
|
+
{
|
|
12104
|
+
"kind": "property",
|
|
12105
|
+
"name": "options",
|
|
12106
|
+
"type": {
|
|
12107
|
+
"kind": "type-reference",
|
|
12108
|
+
"typeId": "ChartDataOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12109
|
+
"typeString": "ChartDataOptions"
|
|
12110
|
+
},
|
|
12111
|
+
"isOptional": true
|
|
12112
|
+
}
|
|
12113
|
+
]
|
|
12114
|
+
}
|
|
12115
|
+
]
|
|
12116
|
+
},
|
|
12117
|
+
"jsdoc": {
|
|
12118
|
+
"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)."
|
|
12119
|
+
}
|
|
12120
|
+
},
|
|
12121
|
+
{
|
|
12122
|
+
"kind": "property",
|
|
12123
|
+
"name": "axes",
|
|
12124
|
+
"type": {
|
|
12125
|
+
"kind": "type-reference",
|
|
12126
|
+
"typeId": "ChartAxisPair:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12127
|
+
"typeString": "ChartAxisPair"
|
|
12128
|
+
},
|
|
12129
|
+
"jsdoc": {
|
|
12130
|
+
"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)."
|
|
12131
|
+
}
|
|
12132
|
+
},
|
|
12133
|
+
{
|
|
12134
|
+
"kind": "property",
|
|
12135
|
+
"name": "options",
|
|
12136
|
+
"type": {
|
|
12137
|
+
"kind": "type-reference",
|
|
12138
|
+
"typeId": "ChartOptions:@hubspot/ui-extensions:dist/shared/types/components/chart.d.ts",
|
|
12139
|
+
"typeString": "ChartOptions"
|
|
12140
|
+
},
|
|
12141
|
+
"isOptional": true,
|
|
12142
|
+
"jsdoc": {
|
|
12143
|
+
"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)."
|
|
12144
|
+
}
|
|
12145
|
+
},
|
|
12146
|
+
{
|
|
12147
|
+
"kind": "property",
|
|
12148
|
+
"name": "testId",
|
|
12149
|
+
"type": {
|
|
12150
|
+
"kind": "primitive",
|
|
12151
|
+
"name": "string"
|
|
12152
|
+
},
|
|
12153
|
+
"isOptional": true,
|
|
12154
|
+
"jsdoc": {
|
|
12155
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
12156
|
+
"tags": [
|
|
12157
|
+
{
|
|
12158
|
+
"name": "see",
|
|
12159
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
12160
|
+
}
|
|
12161
|
+
]
|
|
12162
|
+
}
|
|
12163
|
+
}
|
|
12164
|
+
]
|
|
12165
|
+
},
|
|
11917
12166
|
"LinkProps:@hubspot/ui-extensions:dist/shared/types/components/link.d.ts": {
|
|
11918
12167
|
"kind": "object",
|
|
11919
12168
|
"properties": [
|
|
@@ -14014,6 +14263,27 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14014
14263
|
}
|
|
14015
14264
|
]
|
|
14016
14265
|
},
|
|
14266
|
+
"NonNullable:typescript@5.9.3:lib/lib.es5.d.ts": {
|
|
14267
|
+
"kind": "union",
|
|
14268
|
+
"types": [
|
|
14269
|
+
{
|
|
14270
|
+
"kind": "primitive",
|
|
14271
|
+
"name": "string"
|
|
14272
|
+
},
|
|
14273
|
+
{
|
|
14274
|
+
"kind": "primitive",
|
|
14275
|
+
"name": "number"
|
|
14276
|
+
},
|
|
14277
|
+
{
|
|
14278
|
+
"kind": "literal",
|
|
14279
|
+
"value": false
|
|
14280
|
+
},
|
|
14281
|
+
{
|
|
14282
|
+
"kind": "literal",
|
|
14283
|
+
"value": true
|
|
14284
|
+
}
|
|
14285
|
+
]
|
|
14286
|
+
},
|
|
14017
14287
|
"NumberInputProps:@hubspot/ui-extensions:dist/shared/types/components/inputs.d.ts": {
|
|
14018
14288
|
"kind": "object",
|
|
14019
14289
|
"properties": [
|
|
@@ -15642,17 +15912,225 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15642
15912
|
]
|
|
15643
15913
|
},
|
|
15644
15914
|
"RadioButtonProps:@hubspot/ui-extensions:dist/shared/types/components/toggleInputs.d.ts": {
|
|
15645
|
-
"kind": "
|
|
15646
|
-
"
|
|
15647
|
-
"typeArguments": [
|
|
15915
|
+
"kind": "object",
|
|
15916
|
+
"properties": [
|
|
15648
15917
|
{
|
|
15649
|
-
"kind": "
|
|
15650
|
-
"
|
|
15651
|
-
"
|
|
15918
|
+
"kind": "property",
|
|
15919
|
+
"name": "description",
|
|
15920
|
+
"type": {
|
|
15921
|
+
"kind": "primitive",
|
|
15922
|
+
"name": "string"
|
|
15923
|
+
},
|
|
15924
|
+
"isOptional": true,
|
|
15925
|
+
"jsdoc": {
|
|
15926
|
+
"text": "Text that describes the field's purpose."
|
|
15927
|
+
}
|
|
15652
15928
|
},
|
|
15653
15929
|
{
|
|
15654
|
-
"kind": "
|
|
15655
|
-
"
|
|
15930
|
+
"kind": "property",
|
|
15931
|
+
"name": "name",
|
|
15932
|
+
"type": {
|
|
15933
|
+
"kind": "primitive",
|
|
15934
|
+
"name": "string"
|
|
15935
|
+
},
|
|
15936
|
+
"isOptional": true,
|
|
15937
|
+
"jsdoc": {
|
|
15938
|
+
"text": "The checkbox's unique identifier."
|
|
15939
|
+
}
|
|
15940
|
+
},
|
|
15941
|
+
{
|
|
15942
|
+
"kind": "property",
|
|
15943
|
+
"name": "value",
|
|
15944
|
+
"type": {
|
|
15945
|
+
"kind": "primitive",
|
|
15946
|
+
"name": "string"
|
|
15947
|
+
},
|
|
15948
|
+
"isOptional": true,
|
|
15949
|
+
"jsdoc": {
|
|
15950
|
+
"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."
|
|
15951
|
+
}
|
|
15952
|
+
},
|
|
15953
|
+
{
|
|
15954
|
+
"kind": "property",
|
|
15955
|
+
"name": "readOnly",
|
|
15956
|
+
"type": {
|
|
15957
|
+
"kind": "primitive",
|
|
15958
|
+
"name": "boolean"
|
|
15959
|
+
},
|
|
15960
|
+
"isOptional": true,
|
|
15961
|
+
"jsdoc": {
|
|
15962
|
+
"text": "When set to `true`, the checkbox cannot be selected."
|
|
15963
|
+
}
|
|
15964
|
+
},
|
|
15965
|
+
{
|
|
15966
|
+
"kind": "property",
|
|
15967
|
+
"name": "onChange",
|
|
15968
|
+
"type": {
|
|
15969
|
+
"kind": "function",
|
|
15970
|
+
"functionKind": "arrow",
|
|
15971
|
+
"parameters": [
|
|
15972
|
+
{
|
|
15973
|
+
"kind": "parameter",
|
|
15974
|
+
"name": "checked",
|
|
15975
|
+
"type": {
|
|
15976
|
+
"kind": "primitive",
|
|
15977
|
+
"name": "boolean"
|
|
15978
|
+
}
|
|
15979
|
+
},
|
|
15980
|
+
{
|
|
15981
|
+
"kind": "parameter",
|
|
15982
|
+
"name": "value",
|
|
15983
|
+
"type": {
|
|
15984
|
+
"kind": "primitive",
|
|
15985
|
+
"name": "string"
|
|
15986
|
+
}
|
|
15987
|
+
}
|
|
15988
|
+
],
|
|
15989
|
+
"returnType": {
|
|
15990
|
+
"kind": "primitive",
|
|
15991
|
+
"name": "void"
|
|
15992
|
+
}
|
|
15993
|
+
},
|
|
15994
|
+
"isOptional": true,
|
|
15995
|
+
"jsdoc": {
|
|
15996
|
+
"text": "A callback function that is called when the checkbox is selected or cleared. Passes the new value.",
|
|
15997
|
+
"tags": [
|
|
15998
|
+
{
|
|
15999
|
+
"name": "event",
|
|
16000
|
+
"text": ""
|
|
16001
|
+
}
|
|
16002
|
+
]
|
|
16003
|
+
}
|
|
16004
|
+
},
|
|
16005
|
+
{
|
|
16006
|
+
"kind": "property",
|
|
16007
|
+
"name": "testId",
|
|
16008
|
+
"type": {
|
|
16009
|
+
"kind": "primitive",
|
|
16010
|
+
"name": "string"
|
|
16011
|
+
},
|
|
16012
|
+
"isOptional": true,
|
|
16013
|
+
"jsdoc": {
|
|
16014
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
16015
|
+
"tags": [
|
|
16016
|
+
{
|
|
16017
|
+
"name": "see",
|
|
16018
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
16019
|
+
}
|
|
16020
|
+
]
|
|
16021
|
+
}
|
|
16022
|
+
},
|
|
16023
|
+
{
|
|
16024
|
+
"kind": "property",
|
|
16025
|
+
"name": "inline",
|
|
16026
|
+
"type": {
|
|
16027
|
+
"kind": "primitive",
|
|
16028
|
+
"name": "boolean"
|
|
16029
|
+
},
|
|
16030
|
+
"isOptional": true,
|
|
16031
|
+
"jsdoc": {
|
|
16032
|
+
"text": "When set to `true`, arranges checkboxes side by side.",
|
|
16033
|
+
"tags": [
|
|
16034
|
+
{
|
|
16035
|
+
"name": "defaultValue",
|
|
16036
|
+
"text": "`false`"
|
|
16037
|
+
}
|
|
16038
|
+
]
|
|
16039
|
+
}
|
|
16040
|
+
},
|
|
16041
|
+
{
|
|
16042
|
+
"kind": "property",
|
|
16043
|
+
"name": "checked",
|
|
16044
|
+
"type": {
|
|
16045
|
+
"kind": "primitive",
|
|
16046
|
+
"name": "boolean"
|
|
16047
|
+
},
|
|
16048
|
+
"isOptional": true,
|
|
16049
|
+
"jsdoc": {
|
|
16050
|
+
"text": "When set to `true`, the checkbox is selected.",
|
|
16051
|
+
"tags": [
|
|
16052
|
+
{
|
|
16053
|
+
"name": "defaultValue",
|
|
16054
|
+
"text": "`false`"
|
|
16055
|
+
}
|
|
16056
|
+
]
|
|
16057
|
+
}
|
|
16058
|
+
},
|
|
16059
|
+
{
|
|
16060
|
+
"kind": "property",
|
|
16061
|
+
"name": "readonly",
|
|
16062
|
+
"type": {
|
|
16063
|
+
"kind": "primitive",
|
|
16064
|
+
"name": "boolean"
|
|
16065
|
+
},
|
|
16066
|
+
"isOptional": true,
|
|
16067
|
+
"jsdoc": {
|
|
16068
|
+
"text": "",
|
|
16069
|
+
"tags": [
|
|
16070
|
+
{
|
|
16071
|
+
"name": "deprecated",
|
|
16072
|
+
"text": "use readOnly instead"
|
|
16073
|
+
}
|
|
16074
|
+
]
|
|
16075
|
+
}
|
|
16076
|
+
},
|
|
16077
|
+
{
|
|
16078
|
+
"kind": "property",
|
|
16079
|
+
"name": "variant",
|
|
16080
|
+
"type": {
|
|
16081
|
+
"kind": "union",
|
|
16082
|
+
"types": [
|
|
16083
|
+
{
|
|
16084
|
+
"kind": "literal",
|
|
16085
|
+
"value": "small"
|
|
16086
|
+
},
|
|
16087
|
+
{
|
|
16088
|
+
"kind": "literal",
|
|
16089
|
+
"value": "default"
|
|
16090
|
+
}
|
|
16091
|
+
]
|
|
16092
|
+
},
|
|
16093
|
+
"isOptional": true,
|
|
16094
|
+
"jsdoc": {
|
|
16095
|
+
"text": "The size of the checkbox.",
|
|
16096
|
+
"tags": [
|
|
16097
|
+
{
|
|
16098
|
+
"name": "defaultValue",
|
|
16099
|
+
"text": "`\"default\"`"
|
|
16100
|
+
}
|
|
16101
|
+
]
|
|
16102
|
+
}
|
|
16103
|
+
},
|
|
16104
|
+
{
|
|
16105
|
+
"kind": "property",
|
|
16106
|
+
"name": "children",
|
|
16107
|
+
"type": {
|
|
16108
|
+
"kind": "type-reference",
|
|
16109
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
16110
|
+
"typeString": "ReactNode"
|
|
16111
|
+
},
|
|
16112
|
+
"isOptional": true,
|
|
16113
|
+
"jsdoc": {
|
|
16114
|
+
"text": "The text that displays next to the checkbox."
|
|
16115
|
+
}
|
|
16116
|
+
},
|
|
16117
|
+
{
|
|
16118
|
+
"kind": "property",
|
|
16119
|
+
"name": "initialIsChecked",
|
|
16120
|
+
"type": {
|
|
16121
|
+
"kind": "primitive",
|
|
16122
|
+
"name": "boolean"
|
|
16123
|
+
},
|
|
16124
|
+
"isOptional": true,
|
|
16125
|
+
"jsdoc": {
|
|
16126
|
+
"text": "When set to `true`, the checkbox is selected by default.",
|
|
16127
|
+
"tags": [
|
|
16128
|
+
{
|
|
16129
|
+
"name": "defaultValue",
|
|
16130
|
+
"text": "`false`"
|
|
16131
|
+
}
|
|
16132
|
+
]
|
|
16133
|
+
}
|
|
15656
16134
|
}
|
|
15657
16135
|
]
|
|
15658
16136
|
},
|
|
@@ -16174,8 +16652,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16174
16652
|
"kind": "parameter",
|
|
16175
16653
|
"name": "value",
|
|
16176
16654
|
"type": {
|
|
16177
|
-
"kind": "
|
|
16178
|
-
"
|
|
16655
|
+
"kind": "type-reference",
|
|
16656
|
+
"typeId": "NonNullable:typescript@5.9.3:lib/lib.es5.d.ts",
|
|
16657
|
+
"typeString": "NonNullable<string | number | boolean | undefined>",
|
|
16179
16658
|
"typeArguments": [
|
|
16180
16659
|
{
|
|
16181
16660
|
"kind": "union",
|
|
@@ -16642,8 +17121,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16642
17121
|
"kind": "parameter",
|
|
16643
17122
|
"name": "value",
|
|
16644
17123
|
"type": {
|
|
16645
|
-
"kind": "
|
|
16646
|
-
"
|
|
17124
|
+
"kind": "type-reference",
|
|
17125
|
+
"typeId": "NonNullable:typescript@5.9.3:lib/lib.es5.d.ts",
|
|
17126
|
+
"typeString": "NonNullable<\"none\" | \"ascending\" | \"descending\">",
|
|
16647
17127
|
"typeArguments": [
|
|
16648
17128
|
{
|
|
16649
17129
|
"kind": "union",
|