@hubspot/ui-extensions-sdk-api-metadata 0.12.2 → 0.12.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/__generated__/component-props.js +1181 -139
- package/dist/__tests__/component-props-docs.spec.js +3 -0
- package/dist/component-props-docs.d.ts +1 -1
- package/dist/component-props-docs.js +2 -2
- package/dist/internal/get-type-source.d.ts +1 -1
- package/dist/internal/get-type-source.js +60 -0
- package/dist/internal/render-prop-type.d.ts +1 -1
- package/dist/internal/utils/jsdoc-utils.d.ts +1 -1
- package/dist/internal/utils/jsx-utils.js +1 -1
- package/dist/types.d.ts +15 -0
- package/dist/types.js +15 -0
- package/package.json +25 -17
|
@@ -605,6 +605,17 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
605
605
|
]
|
|
606
606
|
}
|
|
607
607
|
},
|
|
608
|
+
{
|
|
609
|
+
"kind": "export",
|
|
610
|
+
"exportName": "EmptyProps",
|
|
611
|
+
"declarationKind": "type",
|
|
612
|
+
"isType": true,
|
|
613
|
+
"type": {
|
|
614
|
+
"kind": "type-reference",
|
|
615
|
+
"typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
616
|
+
"typeString": "EmptyProps"
|
|
617
|
+
}
|
|
618
|
+
},
|
|
608
619
|
{
|
|
609
620
|
"kind": "export",
|
|
610
621
|
"exportName": "EmptyStateProps",
|
|
@@ -1167,6 +1178,20 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1167
1178
|
]
|
|
1168
1179
|
}
|
|
1169
1180
|
},
|
|
1181
|
+
{
|
|
1182
|
+
"kind": "export",
|
|
1183
|
+
"exportName": "ReactFragmentProps",
|
|
1184
|
+
"declarationKind": "interface",
|
|
1185
|
+
"isType": true,
|
|
1186
|
+
"type": {
|
|
1187
|
+
"kind": "type-reference",
|
|
1188
|
+
"typeId": "ReactFragmentProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
1189
|
+
"typeString": "ReactFragmentProps"
|
|
1190
|
+
},
|
|
1191
|
+
"jsdoc": {
|
|
1192
|
+
"text": "The props type for a React fragment component."
|
|
1193
|
+
}
|
|
1194
|
+
},
|
|
1170
1195
|
{
|
|
1171
1196
|
"kind": "export",
|
|
1172
1197
|
"exportName": "ScoreProps",
|
|
@@ -1178,7 +1203,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1178
1203
|
"typeString": "ScoreProps"
|
|
1179
1204
|
},
|
|
1180
1205
|
"jsdoc": {
|
|
1181
|
-
"text": "The props type for
|
|
1206
|
+
"text": "The props type for [ScoreCircle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/scorecircle)",
|
|
1182
1207
|
"tags": [
|
|
1183
1208
|
{
|
|
1184
1209
|
"name": "category",
|
|
@@ -1913,6 +1938,268 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
1913
1938
|
}
|
|
1914
1939
|
}
|
|
1915
1940
|
],
|
|
1941
|
+
"./experimental/pages": [
|
|
1942
|
+
{
|
|
1943
|
+
"kind": "export",
|
|
1944
|
+
"exportName": "AnyRouteProps",
|
|
1945
|
+
"declarationKind": "type",
|
|
1946
|
+
"isType": true,
|
|
1947
|
+
"type": {
|
|
1948
|
+
"kind": "type-reference",
|
|
1949
|
+
"typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
|
|
1950
|
+
"typeString": "BaseRouteProps"
|
|
1951
|
+
},
|
|
1952
|
+
"jsdoc": {
|
|
1953
|
+
"text": "The props type for [PageRoutes.AnyRoute](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-anyroute)."
|
|
1954
|
+
}
|
|
1955
|
+
},
|
|
1956
|
+
{
|
|
1957
|
+
"kind": "export",
|
|
1958
|
+
"exportName": "IndexRouteProps",
|
|
1959
|
+
"declarationKind": "type",
|
|
1960
|
+
"isType": true,
|
|
1961
|
+
"type": {
|
|
1962
|
+
"kind": "type-reference",
|
|
1963
|
+
"typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
|
|
1964
|
+
"typeString": "BaseRouteProps"
|
|
1965
|
+
},
|
|
1966
|
+
"jsdoc": {
|
|
1967
|
+
"text": "The props type for [PageRoutes.IndexRoute](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-indexroute)."
|
|
1968
|
+
}
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"kind": "export",
|
|
1972
|
+
"exportName": "PageBreadcrumbsCurrentProps",
|
|
1973
|
+
"declarationKind": "interface",
|
|
1974
|
+
"isType": true,
|
|
1975
|
+
"type": {
|
|
1976
|
+
"kind": "type-reference",
|
|
1977
|
+
"typeId": "PageBreadcrumbsCurrentProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
|
|
1978
|
+
"typeString": "PageBreadcrumbsCurrentProps"
|
|
1979
|
+
}
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"kind": "export",
|
|
1983
|
+
"exportName": "PageBreadcrumbsPageLinkProps",
|
|
1984
|
+
"declarationKind": "interface",
|
|
1985
|
+
"isType": true,
|
|
1986
|
+
"type": {
|
|
1987
|
+
"kind": "type-reference",
|
|
1988
|
+
"typeId": "PageBreadcrumbsPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
|
|
1989
|
+
"typeString": "PageBreadcrumbsPageLinkProps"
|
|
1990
|
+
}
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"kind": "export",
|
|
1994
|
+
"exportName": "PageBreadcrumbsProps",
|
|
1995
|
+
"declarationKind": "interface",
|
|
1996
|
+
"isType": true,
|
|
1997
|
+
"type": {
|
|
1998
|
+
"kind": "type-reference",
|
|
1999
|
+
"typeId": "PageBreadcrumbsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
|
|
2000
|
+
"typeString": "PageBreadcrumbsProps"
|
|
2001
|
+
},
|
|
2002
|
+
"jsdoc": {
|
|
2003
|
+
"text": "The props type for [PageBreadcrumbs](https://developers.hubspot.com/docs/reference/ui-components/app-page-components/page-breadcrumbs)"
|
|
2004
|
+
}
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"kind": "export",
|
|
2008
|
+
"exportName": "PageHeaderLinkProps",
|
|
2009
|
+
"declarationKind": "interface",
|
|
2010
|
+
"isType": true,
|
|
2011
|
+
"type": {
|
|
2012
|
+
"kind": "type-reference",
|
|
2013
|
+
"typeId": "PageHeaderLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
|
|
2014
|
+
"typeString": "PageHeaderLinkProps"
|
|
2015
|
+
},
|
|
2016
|
+
"jsdoc": {
|
|
2017
|
+
"text": "The props type for [PageHeader.Link](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-link).",
|
|
2018
|
+
"tags": [
|
|
2019
|
+
{
|
|
2020
|
+
"name": "category",
|
|
2021
|
+
"text": "Component Props"
|
|
2022
|
+
}
|
|
2023
|
+
]
|
|
2024
|
+
}
|
|
2025
|
+
},
|
|
2026
|
+
{
|
|
2027
|
+
"kind": "export",
|
|
2028
|
+
"exportName": "PageHeaderPageLinkProps",
|
|
2029
|
+
"declarationKind": "interface",
|
|
2030
|
+
"isType": true,
|
|
2031
|
+
"type": {
|
|
2032
|
+
"kind": "type-reference",
|
|
2033
|
+
"typeId": "PageHeaderPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
|
|
2034
|
+
"typeString": "PageHeaderPageLinkProps"
|
|
2035
|
+
},
|
|
2036
|
+
"jsdoc": {
|
|
2037
|
+
"text": "The props type for [PageHeader.PageLink](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-pagelink).",
|
|
2038
|
+
"tags": [
|
|
2039
|
+
{
|
|
2040
|
+
"name": "category",
|
|
2041
|
+
"text": "Component Props"
|
|
2042
|
+
}
|
|
2043
|
+
]
|
|
2044
|
+
}
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"kind": "export",
|
|
2048
|
+
"exportName": "PageHeaderPrimaryActionProps",
|
|
2049
|
+
"declarationKind": "interface",
|
|
2050
|
+
"isType": true,
|
|
2051
|
+
"type": {
|
|
2052
|
+
"kind": "type-reference",
|
|
2053
|
+
"typeId": "PageHeaderPrimaryActionProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
|
|
2054
|
+
"typeString": "PageHeaderPrimaryActionProps"
|
|
2055
|
+
},
|
|
2056
|
+
"jsdoc": {
|
|
2057
|
+
"text": "The props type for [PageHeader.PrimaryAction](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-primaryaction).",
|
|
2058
|
+
"tags": [
|
|
2059
|
+
{
|
|
2060
|
+
"name": "category",
|
|
2061
|
+
"text": "Component Props"
|
|
2062
|
+
}
|
|
2063
|
+
]
|
|
2064
|
+
}
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
"kind": "export",
|
|
2068
|
+
"exportName": "PageHeaderProps",
|
|
2069
|
+
"declarationKind": "interface",
|
|
2070
|
+
"isType": true,
|
|
2071
|
+
"type": {
|
|
2072
|
+
"kind": "type-reference",
|
|
2073
|
+
"typeId": "PageHeaderProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
|
|
2074
|
+
"typeString": "PageHeaderProps"
|
|
2075
|
+
},
|
|
2076
|
+
"jsdoc": {
|
|
2077
|
+
"text": "The props type for [PageHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header).",
|
|
2078
|
+
"tags": [
|
|
2079
|
+
{
|
|
2080
|
+
"name": "category",
|
|
2081
|
+
"text": "Component Props"
|
|
2082
|
+
}
|
|
2083
|
+
]
|
|
2084
|
+
}
|
|
2085
|
+
},
|
|
2086
|
+
{
|
|
2087
|
+
"kind": "export",
|
|
2088
|
+
"exportName": "PageHeaderSecondaryActionsProps",
|
|
2089
|
+
"declarationKind": "interface",
|
|
2090
|
+
"isType": true,
|
|
2091
|
+
"type": {
|
|
2092
|
+
"kind": "type-reference",
|
|
2093
|
+
"typeId": "PageHeaderSecondaryActionsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
|
|
2094
|
+
"typeString": "PageHeaderSecondaryActionsProps"
|
|
2095
|
+
},
|
|
2096
|
+
"jsdoc": {
|
|
2097
|
+
"text": "The props type for [PageHeader.SecondaryActions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-secondaryactions).",
|
|
2098
|
+
"tags": [
|
|
2099
|
+
{
|
|
2100
|
+
"name": "category",
|
|
2101
|
+
"text": "Component Props"
|
|
2102
|
+
}
|
|
2103
|
+
]
|
|
2104
|
+
}
|
|
2105
|
+
},
|
|
2106
|
+
{
|
|
2107
|
+
"kind": "export",
|
|
2108
|
+
"exportName": "PageLinkProps",
|
|
2109
|
+
"declarationKind": "interface",
|
|
2110
|
+
"isType": true,
|
|
2111
|
+
"type": {
|
|
2112
|
+
"kind": "type-reference",
|
|
2113
|
+
"typeId": "PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts",
|
|
2114
|
+
"typeString": "PageLinkProps"
|
|
2115
|
+
},
|
|
2116
|
+
"jsdoc": {
|
|
2117
|
+
"text": "The props type for [PageLink](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-link).",
|
|
2118
|
+
"tags": [
|
|
2119
|
+
{
|
|
2120
|
+
"name": "category",
|
|
2121
|
+
"text": "Component Props"
|
|
2122
|
+
}
|
|
2123
|
+
]
|
|
2124
|
+
}
|
|
2125
|
+
},
|
|
2126
|
+
{
|
|
2127
|
+
"kind": "export",
|
|
2128
|
+
"exportName": "PageRouterProps",
|
|
2129
|
+
"declarationKind": "type",
|
|
2130
|
+
"isType": true,
|
|
2131
|
+
"type": {
|
|
2132
|
+
"kind": "type-reference",
|
|
2133
|
+
"typeId": "PageRouterProps:@hubspot/ui-extensions:dist/experimental/pages/types.d.ts",
|
|
2134
|
+
"typeString": "PageRouterProps"
|
|
2135
|
+
},
|
|
2136
|
+
"jsdoc": {
|
|
2137
|
+
"text": "The props type for a PageRouter component."
|
|
2138
|
+
}
|
|
2139
|
+
},
|
|
2140
|
+
{
|
|
2141
|
+
"kind": "export",
|
|
2142
|
+
"exportName": "PageRoutesLayoutProps",
|
|
2143
|
+
"declarationKind": "interface",
|
|
2144
|
+
"isType": true,
|
|
2145
|
+
"type": {
|
|
2146
|
+
"kind": "type-reference",
|
|
2147
|
+
"typeId": "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
|
|
2148
|
+
"typeString": "PageRoutesLayoutProps"
|
|
2149
|
+
},
|
|
2150
|
+
"jsdoc": {
|
|
2151
|
+
"text": "The props type for the layout component of [PageRoutes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes)."
|
|
2152
|
+
}
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"kind": "export",
|
|
2156
|
+
"exportName": "PageRoutesProps",
|
|
2157
|
+
"declarationKind": "interface",
|
|
2158
|
+
"isType": true,
|
|
2159
|
+
"type": {
|
|
2160
|
+
"kind": "type-reference",
|
|
2161
|
+
"typeId": "PageRoutesProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
|
|
2162
|
+
"typeString": "PageRoutesProps"
|
|
2163
|
+
},
|
|
2164
|
+
"jsdoc": {
|
|
2165
|
+
"text": "The props type for [PageRoutes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes)."
|
|
2166
|
+
}
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
"kind": "export",
|
|
2170
|
+
"exportName": "PageTitleProps",
|
|
2171
|
+
"declarationKind": "interface",
|
|
2172
|
+
"isType": true,
|
|
2173
|
+
"type": {
|
|
2174
|
+
"kind": "type-reference",
|
|
2175
|
+
"typeId": "PageTitleProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-title.d.ts",
|
|
2176
|
+
"typeString": "PageTitleProps"
|
|
2177
|
+
},
|
|
2178
|
+
"jsdoc": {
|
|
2179
|
+
"text": "The props type for [PageTitle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-title).",
|
|
2180
|
+
"tags": [
|
|
2181
|
+
{
|
|
2182
|
+
"name": "category",
|
|
2183
|
+
"text": "Component Props"
|
|
2184
|
+
}
|
|
2185
|
+
]
|
|
2186
|
+
}
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"kind": "export",
|
|
2190
|
+
"exportName": "RouteProps",
|
|
2191
|
+
"declarationKind": "interface",
|
|
2192
|
+
"isType": true,
|
|
2193
|
+
"type": {
|
|
2194
|
+
"kind": "type-reference",
|
|
2195
|
+
"typeId": "RouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
|
|
2196
|
+
"typeString": "RouteProps"
|
|
2197
|
+
},
|
|
2198
|
+
"jsdoc": {
|
|
2199
|
+
"text": "The props type for [PageRoutes.Route](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-route)."
|
|
2200
|
+
}
|
|
2201
|
+
}
|
|
2202
|
+
],
|
|
1916
2203
|
"./pages/home": [],
|
|
1917
2204
|
"./experimental": [
|
|
1918
2205
|
{
|
|
@@ -2980,7 +3267,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
2980
3267
|
},
|
|
2981
3268
|
"isOptional": true,
|
|
2982
3269
|
"jsdoc": {
|
|
2983
|
-
"text": "Include this prop to open a URL on click.
|
|
3270
|
+
"text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): 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.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
|
|
2984
3271
|
}
|
|
2985
3272
|
},
|
|
2986
3273
|
{
|
|
@@ -3520,6 +3807,42 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
3520
3807
|
}
|
|
3521
3808
|
]
|
|
3522
3809
|
},
|
|
3810
|
+
"BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
|
|
3811
|
+
"kind": "object",
|
|
3812
|
+
"properties": [
|
|
3813
|
+
{
|
|
3814
|
+
"kind": "property",
|
|
3815
|
+
"name": "component",
|
|
3816
|
+
"type": {
|
|
3817
|
+
"kind": "type-reference",
|
|
3818
|
+
"typeId": "ComponentType:@types/react@18.3.26:index.d.ts",
|
|
3819
|
+
"typeString": "ComponentType<EmptyProps>",
|
|
3820
|
+
"typeArguments": [
|
|
3821
|
+
{
|
|
3822
|
+
"kind": "type-reference",
|
|
3823
|
+
"typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
3824
|
+
"typeString": "EmptyProps"
|
|
3825
|
+
}
|
|
3826
|
+
]
|
|
3827
|
+
},
|
|
3828
|
+
"jsdoc": {
|
|
3829
|
+
"text": "The component to render when the route is matched."
|
|
3830
|
+
}
|
|
3831
|
+
},
|
|
3832
|
+
{
|
|
3833
|
+
"kind": "property",
|
|
3834
|
+
"name": "id",
|
|
3835
|
+
"type": {
|
|
3836
|
+
"kind": "primitive",
|
|
3837
|
+
"name": "string"
|
|
3838
|
+
},
|
|
3839
|
+
"isOptional": true,
|
|
3840
|
+
"jsdoc": {
|
|
3841
|
+
"text": "A unique identifier for the route."
|
|
3842
|
+
}
|
|
3843
|
+
}
|
|
3844
|
+
]
|
|
3845
|
+
},
|
|
3523
3846
|
"BaseSelectProps:@hubspot/ui-extensions:dist/shared/types/components/selects.d.ts": {
|
|
3524
3847
|
"kind": "object",
|
|
3525
3848
|
"properties": [
|
|
@@ -4037,7 +4360,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
4037
4360
|
},
|
|
4038
4361
|
"isOptional": true,
|
|
4039
4362
|
"jsdoc": {
|
|
4040
|
-
"text": "Include this prop to open a URL on click.
|
|
4363
|
+
"text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): 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.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
|
|
4041
4364
|
}
|
|
4042
4365
|
},
|
|
4043
4366
|
{
|
|
@@ -5827,11 +6150,32 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
5827
6150
|
}
|
|
5828
6151
|
]
|
|
5829
6152
|
},
|
|
5830
|
-
"
|
|
5831
|
-
"kind": "
|
|
5832
|
-
"
|
|
6153
|
+
"ComponentClass:@types/react@18.3.26:index.d.ts": {
|
|
6154
|
+
"kind": "external-type-reference",
|
|
6155
|
+
"typeName": "ComponentClass",
|
|
6156
|
+
"typeString": "ComponentClass",
|
|
6157
|
+
"packageName": "@types/react",
|
|
6158
|
+
"packageVersion": "18.3.26"
|
|
6159
|
+
},
|
|
6160
|
+
"ComponentType:@types/react@18.3.26:index.d.ts": {
|
|
6161
|
+
"kind": "external-type-reference",
|
|
6162
|
+
"typeName": "ComponentType",
|
|
6163
|
+
"typeString": "ComponentType<EmptyProps>",
|
|
6164
|
+
"packageName": "@types/react",
|
|
6165
|
+
"packageVersion": "18.3.26",
|
|
6166
|
+
"typeArguments": [
|
|
5833
6167
|
{
|
|
5834
|
-
"kind": "
|
|
6168
|
+
"kind": "type-reference",
|
|
6169
|
+
"typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
6170
|
+
"typeString": "EmptyProps"
|
|
6171
|
+
}
|
|
6172
|
+
]
|
|
6173
|
+
},
|
|
6174
|
+
"CrmActionButtonProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts": {
|
|
6175
|
+
"kind": "object",
|
|
6176
|
+
"properties": [
|
|
6177
|
+
{
|
|
6178
|
+
"kind": "property",
|
|
5835
6179
|
"name": "variant",
|
|
5836
6180
|
"type": {
|
|
5837
6181
|
"kind": "union",
|
|
@@ -8676,6 +9020,20 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
8676
9020
|
}
|
|
8677
9021
|
]
|
|
8678
9022
|
},
|
|
9023
|
+
"EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts": {
|
|
9024
|
+
"kind": "built-in-type-reference",
|
|
9025
|
+
"name": "Record",
|
|
9026
|
+
"typeArguments": [
|
|
9027
|
+
{
|
|
9028
|
+
"kind": "primitive",
|
|
9029
|
+
"name": "string"
|
|
9030
|
+
},
|
|
9031
|
+
{
|
|
9032
|
+
"kind": "unknown",
|
|
9033
|
+
"type": "never"
|
|
9034
|
+
}
|
|
9035
|
+
]
|
|
9036
|
+
},
|
|
8679
9037
|
"EmptyStateProps:@hubspot/ui-extensions:dist/shared/types/components/empty-state.d.ts": {
|
|
8680
9038
|
"kind": "object",
|
|
8681
9039
|
"properties": [
|
|
@@ -9842,6 +10200,13 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
9842
10200
|
}
|
|
9843
10201
|
]
|
|
9844
10202
|
},
|
|
10203
|
+
"FunctionComponent:@types/react@18.3.26:index.d.ts": {
|
|
10204
|
+
"kind": "external-type-reference",
|
|
10205
|
+
"typeName": "FunctionComponent",
|
|
10206
|
+
"typeString": "FunctionComponent",
|
|
10207
|
+
"packageName": "@types/react",
|
|
10208
|
+
"packageVersion": "18.3.26"
|
|
10209
|
+
},
|
|
9845
10210
|
"Gradient:@hubspot/ui-extensions:dist/shared/types/crm.d.ts": {
|
|
9846
10211
|
"kind": "object",
|
|
9847
10212
|
"properties": [
|
|
@@ -10331,7 +10696,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
10331
10696
|
},
|
|
10332
10697
|
"isOptional": true,
|
|
10333
10698
|
"jsdoc": {
|
|
10334
|
-
"text": "The color of the icon.",
|
|
10699
|
+
"text": "The color of the icon. See the [colors section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/icon#colors) for details.",
|
|
10335
10700
|
"tags": [
|
|
10336
10701
|
{
|
|
10337
10702
|
"name": "defaultValue",
|
|
@@ -11109,7 +11474,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11109
11474
|
]
|
|
11110
11475
|
},
|
|
11111
11476
|
"jsdoc": {
|
|
11112
|
-
"text": "Sets the icon to display."
|
|
11477
|
+
"text": "Sets the icon to display. See [all available icons](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/icon#available-icons)."
|
|
11113
11478
|
}
|
|
11114
11479
|
},
|
|
11115
11480
|
{
|
|
@@ -11518,7 +11883,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
11518
11883
|
},
|
|
11519
11884
|
"isOptional": true,
|
|
11520
11885
|
"jsdoc": {
|
|
11521
|
-
"text": "When provided, sets the URL that will open when the image is clicked.
|
|
11886
|
+
"text": "When provided, sets the URL that will open when the image is clicked. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab. By default:\n - Links to HubSpot app pages will open in the same tab.\n - Links to non-HubSpot app pages will open in a new tab.\n\nWhen an image includes both `href` and an `onClick` action, both will be executed on button click."
|
|
11522
11887
|
}
|
|
11523
11888
|
},
|
|
11524
11889
|
{
|
|
@@ -12237,7 +12602,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
12237
12602
|
"typeString": "HrefProp"
|
|
12238
12603
|
},
|
|
12239
12604
|
"jsdoc": {
|
|
12240
|
-
"text": "Sets the link's URL and open behavior.
|
|
12605
|
+
"text": "Sets the link's URL and open behavior. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): 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
12606
|
}
|
|
12242
12607
|
},
|
|
12243
12608
|
{
|
|
@@ -13351,7 +13716,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
13351
13716
|
},
|
|
13352
13717
|
"isOptional": true,
|
|
13353
13718
|
"jsdoc": {
|
|
13354
|
-
"text": "Include this prop to open a URL on click.
|
|
13719
|
+
"text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): 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.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
|
|
13355
13720
|
}
|
|
13356
13721
|
},
|
|
13357
13722
|
{
|
|
@@ -14438,6 +14803,33 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14438
14803
|
]
|
|
14439
14804
|
}
|
|
14440
14805
|
},
|
|
14806
|
+
{
|
|
14807
|
+
"kind": "property",
|
|
14808
|
+
"name": "textAlign",
|
|
14809
|
+
"type": {
|
|
14810
|
+
"kind": "union",
|
|
14811
|
+
"types": [
|
|
14812
|
+
{
|
|
14813
|
+
"kind": "literal",
|
|
14814
|
+
"value": "left"
|
|
14815
|
+
},
|
|
14816
|
+
{
|
|
14817
|
+
"kind": "literal",
|
|
14818
|
+
"value": "right"
|
|
14819
|
+
}
|
|
14820
|
+
]
|
|
14821
|
+
},
|
|
14822
|
+
"isOptional": true,
|
|
14823
|
+
"jsdoc": {
|
|
14824
|
+
"text": "Sets the horizontal alignment of the text in the input.",
|
|
14825
|
+
"tags": [
|
|
14826
|
+
{
|
|
14827
|
+
"name": "defaultValue",
|
|
14828
|
+
"text": "`\"left\"`"
|
|
14829
|
+
}
|
|
14830
|
+
]
|
|
14831
|
+
}
|
|
14832
|
+
},
|
|
14441
14833
|
{
|
|
14442
14834
|
"kind": "property",
|
|
14443
14835
|
"name": "error",
|
|
@@ -14814,25 +15206,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14814
15206
|
}
|
|
14815
15207
|
]
|
|
14816
15208
|
},
|
|
14817
|
-
"
|
|
14818
|
-
"kind": "function",
|
|
14819
|
-
"functionKind": "arrow",
|
|
14820
|
-
"parameters": [
|
|
14821
|
-
{
|
|
14822
|
-
"kind": "parameter",
|
|
14823
|
-
"name": "panelId",
|
|
14824
|
-
"type": {
|
|
14825
|
-
"kind": "primitive",
|
|
14826
|
-
"name": "string"
|
|
14827
|
-
}
|
|
14828
|
-
}
|
|
14829
|
-
],
|
|
14830
|
-
"returnType": {
|
|
14831
|
-
"kind": "primitive",
|
|
14832
|
-
"name": "void"
|
|
14833
|
-
}
|
|
14834
|
-
},
|
|
14835
|
-
"PanelBodyProps:@hubspot/ui-extensions:dist/shared/types/components/panel.d.ts": {
|
|
15209
|
+
"PageBreadcrumbsCurrentProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
|
|
14836
15210
|
"kind": "object",
|
|
14837
15211
|
"properties": [
|
|
14838
15212
|
{
|
|
@@ -14844,7 +15218,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14844
15218
|
"typeString": "ReactNode"
|
|
14845
15219
|
},
|
|
14846
15220
|
"jsdoc": {
|
|
14847
|
-
"text": "
|
|
15221
|
+
"text": "Label for the current location."
|
|
14848
15222
|
}
|
|
14849
15223
|
},
|
|
14850
15224
|
{
|
|
@@ -14867,9 +15241,42 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14867
15241
|
}
|
|
14868
15242
|
]
|
|
14869
15243
|
},
|
|
14870
|
-
"
|
|
15244
|
+
"PageBreadcrumbsPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
|
|
14871
15245
|
"kind": "object",
|
|
14872
15246
|
"properties": [
|
|
15247
|
+
{
|
|
15248
|
+
"kind": "property",
|
|
15249
|
+
"name": "to",
|
|
15250
|
+
"type": {
|
|
15251
|
+
"kind": "primitive",
|
|
15252
|
+
"name": "string"
|
|
15253
|
+
},
|
|
15254
|
+
"jsdoc": {
|
|
15255
|
+
"text": "The path to navigate to when the link is clicked. Supports path parameters (e.g. `/view-contact/:contactId`)."
|
|
15256
|
+
}
|
|
15257
|
+
},
|
|
15258
|
+
{
|
|
15259
|
+
"kind": "property",
|
|
15260
|
+
"name": "params",
|
|
15261
|
+
"type": {
|
|
15262
|
+
"kind": "built-in-type-reference",
|
|
15263
|
+
"name": "Record",
|
|
15264
|
+
"typeArguments": [
|
|
15265
|
+
{
|
|
15266
|
+
"kind": "primitive",
|
|
15267
|
+
"name": "string"
|
|
15268
|
+
},
|
|
15269
|
+
{
|
|
15270
|
+
"kind": "primitive",
|
|
15271
|
+
"name": "string"
|
|
15272
|
+
}
|
|
15273
|
+
]
|
|
15274
|
+
},
|
|
15275
|
+
"isOptional": true,
|
|
15276
|
+
"jsdoc": {
|
|
15277
|
+
"text": "Values for path parameters and query string entries.\nParameters matching `:paramName` tokens in `to` are substituted into the path.\nAny remaining parameters are appended as query string entries."
|
|
15278
|
+
}
|
|
15279
|
+
},
|
|
14873
15280
|
{
|
|
14874
15281
|
"kind": "property",
|
|
14875
15282
|
"name": "children",
|
|
@@ -14879,7 +15286,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14879
15286
|
"typeString": "ReactNode"
|
|
14880
15287
|
},
|
|
14881
15288
|
"jsdoc": {
|
|
14882
|
-
"text": "The
|
|
15289
|
+
"text": "The visible text of the breadcrumb link."
|
|
14883
15290
|
}
|
|
14884
15291
|
},
|
|
14885
15292
|
{
|
|
@@ -14902,21 +15309,9 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14902
15309
|
}
|
|
14903
15310
|
]
|
|
14904
15311
|
},
|
|
14905
|
-
"
|
|
15312
|
+
"PageBreadcrumbsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
|
|
14906
15313
|
"kind": "object",
|
|
14907
15314
|
"properties": [
|
|
14908
|
-
{
|
|
14909
|
-
"kind": "property",
|
|
14910
|
-
"name": "aria-label",
|
|
14911
|
-
"type": {
|
|
14912
|
-
"kind": "primitive",
|
|
14913
|
-
"name": "string"
|
|
14914
|
-
},
|
|
14915
|
-
"isOptional": true,
|
|
14916
|
-
"jsdoc": {
|
|
14917
|
-
"text": "The panel's accessibility label."
|
|
14918
|
-
}
|
|
14919
|
-
},
|
|
14920
15315
|
{
|
|
14921
15316
|
"kind": "property",
|
|
14922
15317
|
"name": "children",
|
|
@@ -14925,136 +15320,93 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
14925
15320
|
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
14926
15321
|
"typeString": "ReactNode"
|
|
14927
15322
|
},
|
|
14928
|
-
"isOptional": true,
|
|
14929
15323
|
"jsdoc": {
|
|
14930
|
-
"text": "The
|
|
15324
|
+
"text": "The links and text to render as breadcrumbs.\nUse `PageBreadcrumbs.PageLink` for navigable crumbs and `PageBreadcrumbs.Current` for the current page."
|
|
14931
15325
|
}
|
|
14932
15326
|
},
|
|
14933
15327
|
{
|
|
14934
15328
|
"kind": "property",
|
|
14935
|
-
"name": "
|
|
15329
|
+
"name": "testId",
|
|
14936
15330
|
"type": {
|
|
14937
15331
|
"kind": "primitive",
|
|
14938
15332
|
"name": "string"
|
|
14939
15333
|
},
|
|
14940
|
-
"jsdoc": {
|
|
14941
|
-
"text": "A unique ID for the panel."
|
|
14942
|
-
}
|
|
14943
|
-
},
|
|
14944
|
-
{
|
|
14945
|
-
"kind": "property",
|
|
14946
|
-
"name": "onOpen",
|
|
14947
|
-
"type": {
|
|
14948
|
-
"kind": "function",
|
|
14949
|
-
"functionKind": "arrow",
|
|
14950
|
-
"parameters": [],
|
|
14951
|
-
"returnType": {
|
|
14952
|
-
"kind": "primitive",
|
|
14953
|
-
"name": "void"
|
|
14954
|
-
}
|
|
14955
|
-
},
|
|
14956
15334
|
"isOptional": true,
|
|
14957
15335
|
"jsdoc": {
|
|
14958
|
-
"text": "
|
|
15336
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15337
|
+
"tags": [
|
|
15338
|
+
{
|
|
15339
|
+
"name": "see",
|
|
15340
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15341
|
+
}
|
|
15342
|
+
]
|
|
14959
15343
|
}
|
|
14960
|
-
}
|
|
15344
|
+
}
|
|
15345
|
+
]
|
|
15346
|
+
},
|
|
15347
|
+
"PageHeaderLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
|
|
15348
|
+
"kind": "object",
|
|
15349
|
+
"properties": [
|
|
14961
15350
|
{
|
|
14962
15351
|
"kind": "property",
|
|
14963
|
-
"name": "
|
|
15352
|
+
"name": "href",
|
|
14964
15353
|
"type": {
|
|
14965
|
-
"kind": "
|
|
14966
|
-
"
|
|
14967
|
-
"parameters": [],
|
|
14968
|
-
"returnType": {
|
|
14969
|
-
"kind": "primitive",
|
|
14970
|
-
"name": "void"
|
|
14971
|
-
}
|
|
15354
|
+
"kind": "primitive",
|
|
15355
|
+
"name": "string"
|
|
14972
15356
|
},
|
|
14973
15357
|
"isOptional": true,
|
|
14974
15358
|
"jsdoc": {
|
|
14975
|
-
"text": "A
|
|
15359
|
+
"text": "A URL that will be opened when the button is clicked. If the value is a URL external to `hubspot.com` it will be opened in a new tab."
|
|
14976
15360
|
}
|
|
14977
15361
|
},
|
|
14978
15362
|
{
|
|
14979
15363
|
"kind": "property",
|
|
14980
|
-
"name": "
|
|
15364
|
+
"name": "onClick",
|
|
14981
15365
|
"type": {
|
|
14982
|
-
"kind": "
|
|
14983
|
-
"
|
|
14984
|
-
|
|
14985
|
-
|
|
14986
|
-
"value": "sm"
|
|
14987
|
-
},
|
|
14988
|
-
{
|
|
14989
|
-
"kind": "literal",
|
|
14990
|
-
"value": "small"
|
|
14991
|
-
},
|
|
14992
|
-
{
|
|
14993
|
-
"kind": "literal",
|
|
14994
|
-
"value": "md"
|
|
14995
|
-
},
|
|
14996
|
-
{
|
|
14997
|
-
"kind": "literal",
|
|
14998
|
-
"value": "medium"
|
|
14999
|
-
},
|
|
15000
|
-
{
|
|
15001
|
-
"kind": "literal",
|
|
15002
|
-
"value": "lg"
|
|
15003
|
-
},
|
|
15366
|
+
"kind": "type-reference",
|
|
15367
|
+
"typeId": "ReactionsHandler:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts",
|
|
15368
|
+
"typeString": "ReactionsHandler<ExtensionEvent>",
|
|
15369
|
+
"typeArguments": [
|
|
15004
15370
|
{
|
|
15005
|
-
"kind": "
|
|
15006
|
-
"
|
|
15371
|
+
"kind": "type-reference",
|
|
15372
|
+
"typeId": "ExtensionEvent:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
15373
|
+
"typeString": "ExtensionEvent"
|
|
15007
15374
|
}
|
|
15008
15375
|
]
|
|
15009
15376
|
},
|
|
15010
15377
|
"isOptional": true,
|
|
15011
15378
|
"jsdoc": {
|
|
15012
|
-
"text": "
|
|
15379
|
+
"text": "A function that will be invoked when the button is clicked. Do not use this function for submitting a form; use Form's `onSubmit` function instead.",
|
|
15013
15380
|
"tags": [
|
|
15014
15381
|
{
|
|
15015
|
-
"name": "
|
|
15016
|
-
"text": "
|
|
15382
|
+
"name": "event",
|
|
15383
|
+
"text": ""
|
|
15017
15384
|
}
|
|
15018
15385
|
]
|
|
15019
15386
|
}
|
|
15020
15387
|
},
|
|
15021
15388
|
{
|
|
15022
15389
|
"kind": "property",
|
|
15023
|
-
"name": "
|
|
15390
|
+
"name": "disabled",
|
|
15024
15391
|
"type": {
|
|
15025
15392
|
"kind": "primitive",
|
|
15026
|
-
"name": "
|
|
15393
|
+
"name": "boolean"
|
|
15027
15394
|
},
|
|
15028
15395
|
"isOptional": true,
|
|
15029
15396
|
"jsdoc": {
|
|
15030
|
-
"text": "
|
|
15397
|
+
"text": "Determines whether or not the button should be disabled."
|
|
15031
15398
|
}
|
|
15032
15399
|
},
|
|
15033
15400
|
{
|
|
15034
15401
|
"kind": "property",
|
|
15035
|
-
"name": "
|
|
15402
|
+
"name": "children",
|
|
15036
15403
|
"type": {
|
|
15037
|
-
"kind": "
|
|
15038
|
-
"
|
|
15039
|
-
|
|
15040
|
-
"kind": "literal",
|
|
15041
|
-
"value": "default"
|
|
15042
|
-
},
|
|
15043
|
-
{
|
|
15044
|
-
"kind": "literal",
|
|
15045
|
-
"value": "modal"
|
|
15046
|
-
}
|
|
15047
|
-
]
|
|
15404
|
+
"kind": "type-reference",
|
|
15405
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15406
|
+
"typeString": "ReactNode"
|
|
15048
15407
|
},
|
|
15049
|
-
"isOptional": true,
|
|
15050
15408
|
"jsdoc": {
|
|
15051
|
-
"text": "The
|
|
15052
|
-
"tags": [
|
|
15053
|
-
{
|
|
15054
|
-
"name": "defaultValue",
|
|
15055
|
-
"text": "`\"default\"`"
|
|
15056
|
-
}
|
|
15057
|
-
]
|
|
15409
|
+
"text": "The visible label of the link button. This prop is passed implicitly by providing sub-components."
|
|
15058
15410
|
}
|
|
15059
15411
|
},
|
|
15060
15412
|
{
|
|
@@ -15077,25 +15429,40 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15077
15429
|
}
|
|
15078
15430
|
]
|
|
15079
15431
|
},
|
|
15080
|
-
"
|
|
15432
|
+
"PageHeaderPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
|
|
15081
15433
|
"kind": "object",
|
|
15082
15434
|
"properties": [
|
|
15083
15435
|
{
|
|
15084
15436
|
"kind": "property",
|
|
15085
|
-
"name": "
|
|
15437
|
+
"name": "to",
|
|
15086
15438
|
"type": {
|
|
15087
15439
|
"kind": "primitive",
|
|
15088
|
-
"name": "
|
|
15440
|
+
"name": "string"
|
|
15089
15441
|
},
|
|
15090
|
-
"isOptional": true,
|
|
15091
15442
|
"jsdoc": {
|
|
15092
|
-
"text": "
|
|
15093
|
-
|
|
15443
|
+
"text": "The path to navigate to when the link is clicked. Supports path parameters (e.g. `/view-contact/:contactId`)."
|
|
15444
|
+
}
|
|
15445
|
+
},
|
|
15446
|
+
{
|
|
15447
|
+
"kind": "property",
|
|
15448
|
+
"name": "params",
|
|
15449
|
+
"type": {
|
|
15450
|
+
"kind": "built-in-type-reference",
|
|
15451
|
+
"name": "Record",
|
|
15452
|
+
"typeArguments": [
|
|
15094
15453
|
{
|
|
15095
|
-
"
|
|
15096
|
-
"
|
|
15454
|
+
"kind": "primitive",
|
|
15455
|
+
"name": "string"
|
|
15456
|
+
},
|
|
15457
|
+
{
|
|
15458
|
+
"kind": "primitive",
|
|
15459
|
+
"name": "string"
|
|
15097
15460
|
}
|
|
15098
15461
|
]
|
|
15462
|
+
},
|
|
15463
|
+
"isOptional": true,
|
|
15464
|
+
"jsdoc": {
|
|
15465
|
+
"text": "Values for path parameters and query string entries.\nParameters matching `:paramName` tokens in `to` are substituted into the path.\nAny remaining parameters are appended as query string entries."
|
|
15099
15466
|
}
|
|
15100
15467
|
},
|
|
15101
15468
|
{
|
|
@@ -15107,7 +15474,7 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15107
15474
|
"typeString": "ReactNode"
|
|
15108
15475
|
},
|
|
15109
15476
|
"jsdoc": {
|
|
15110
|
-
"text": "The
|
|
15477
|
+
"text": "The visible label of the link button. This prop is passed implicitly by providing sub-components."
|
|
15111
15478
|
}
|
|
15112
15479
|
},
|
|
15113
15480
|
{
|
|
@@ -15130,12 +15497,618 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
15130
15497
|
}
|
|
15131
15498
|
]
|
|
15132
15499
|
},
|
|
15133
|
-
"
|
|
15500
|
+
"PageHeaderPrimaryActionProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
|
|
15134
15501
|
"kind": "object",
|
|
15135
15502
|
"properties": [
|
|
15136
15503
|
{
|
|
15137
15504
|
"kind": "property",
|
|
15138
|
-
"name": "
|
|
15505
|
+
"name": "children",
|
|
15506
|
+
"type": {
|
|
15507
|
+
"kind": "type-reference",
|
|
15508
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15509
|
+
"typeString": "ReactNode"
|
|
15510
|
+
},
|
|
15511
|
+
"jsdoc": {
|
|
15512
|
+
"text": "Must be a <code>PageHeader.PageLink</code> component (for internal app pages) or a <code>PageHeader.Link</code> component (for URLs outside your app). No other component types are supported."
|
|
15513
|
+
}
|
|
15514
|
+
},
|
|
15515
|
+
{
|
|
15516
|
+
"kind": "property",
|
|
15517
|
+
"name": "testId",
|
|
15518
|
+
"type": {
|
|
15519
|
+
"kind": "primitive",
|
|
15520
|
+
"name": "string"
|
|
15521
|
+
},
|
|
15522
|
+
"isOptional": true,
|
|
15523
|
+
"jsdoc": {
|
|
15524
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15525
|
+
"tags": [
|
|
15526
|
+
{
|
|
15527
|
+
"name": "see",
|
|
15528
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15529
|
+
}
|
|
15530
|
+
]
|
|
15531
|
+
}
|
|
15532
|
+
}
|
|
15533
|
+
]
|
|
15534
|
+
},
|
|
15535
|
+
"PageHeaderProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
|
|
15536
|
+
"kind": "object",
|
|
15537
|
+
"properties": [
|
|
15538
|
+
{
|
|
15539
|
+
"kind": "property",
|
|
15540
|
+
"name": "children",
|
|
15541
|
+
"type": {
|
|
15542
|
+
"kind": "union",
|
|
15543
|
+
"types": [
|
|
15544
|
+
{
|
|
15545
|
+
"kind": "type-reference",
|
|
15546
|
+
"typeId": "ReactElement:@types/react@18.3.26:index.d.ts",
|
|
15547
|
+
"typeString": "ReactElement"
|
|
15548
|
+
},
|
|
15549
|
+
{
|
|
15550
|
+
"kind": "type-reference",
|
|
15551
|
+
"typeId": "ReactElement:@types/react@18.3.26:index.d.ts",
|
|
15552
|
+
"typeString": "ReactElement"
|
|
15553
|
+
}
|
|
15554
|
+
]
|
|
15555
|
+
},
|
|
15556
|
+
"jsdoc": {
|
|
15557
|
+
"text": "Sets the content that will render inside the component. Can contain only <code>PageHeader.PrimaryAction</code> and/or <code>PageHeader.SecondaryActions</code> components."
|
|
15558
|
+
}
|
|
15559
|
+
},
|
|
15560
|
+
{
|
|
15561
|
+
"kind": "property",
|
|
15562
|
+
"name": "testId",
|
|
15563
|
+
"type": {
|
|
15564
|
+
"kind": "primitive",
|
|
15565
|
+
"name": "string"
|
|
15566
|
+
},
|
|
15567
|
+
"isOptional": true,
|
|
15568
|
+
"jsdoc": {
|
|
15569
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15570
|
+
"tags": [
|
|
15571
|
+
{
|
|
15572
|
+
"name": "see",
|
|
15573
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15574
|
+
}
|
|
15575
|
+
]
|
|
15576
|
+
}
|
|
15577
|
+
}
|
|
15578
|
+
]
|
|
15579
|
+
},
|
|
15580
|
+
"PageHeaderSecondaryActionsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
|
|
15581
|
+
"kind": "object",
|
|
15582
|
+
"properties": [
|
|
15583
|
+
{
|
|
15584
|
+
"kind": "property",
|
|
15585
|
+
"name": "children",
|
|
15586
|
+
"type": {
|
|
15587
|
+
"kind": "type-reference",
|
|
15588
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15589
|
+
"typeString": "ReactNode"
|
|
15590
|
+
},
|
|
15591
|
+
"jsdoc": {
|
|
15592
|
+
"text": "Must contain one or more <code>PageHeader.PageLink</code> component (for internal app pages) or a <code>PageHeader.Link</code> component (for URLs outside your app). No other component types are supported."
|
|
15593
|
+
}
|
|
15594
|
+
},
|
|
15595
|
+
{
|
|
15596
|
+
"kind": "property",
|
|
15597
|
+
"name": "testId",
|
|
15598
|
+
"type": {
|
|
15599
|
+
"kind": "primitive",
|
|
15600
|
+
"name": "string"
|
|
15601
|
+
},
|
|
15602
|
+
"isOptional": true,
|
|
15603
|
+
"jsdoc": {
|
|
15604
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15605
|
+
"tags": [
|
|
15606
|
+
{
|
|
15607
|
+
"name": "see",
|
|
15608
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15609
|
+
}
|
|
15610
|
+
]
|
|
15611
|
+
}
|
|
15612
|
+
}
|
|
15613
|
+
]
|
|
15614
|
+
},
|
|
15615
|
+
"PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts": {
|
|
15616
|
+
"kind": "object",
|
|
15617
|
+
"properties": [
|
|
15618
|
+
{
|
|
15619
|
+
"kind": "property",
|
|
15620
|
+
"name": "to",
|
|
15621
|
+
"type": {
|
|
15622
|
+
"kind": "primitive",
|
|
15623
|
+
"name": "string"
|
|
15624
|
+
},
|
|
15625
|
+
"jsdoc": {
|
|
15626
|
+
"text": "The path to navigate to. Can be a simple path (e.g., <code>\"/docs\"</code>) or a path with parameters\n(e.g., <code>\"/view-contact/:contactId\"</code>). When using path parameters, provide the parameter\nvalues in the <code>params</code> prop."
|
|
15627
|
+
}
|
|
15628
|
+
},
|
|
15629
|
+
{
|
|
15630
|
+
"kind": "property",
|
|
15631
|
+
"name": "params",
|
|
15632
|
+
"type": {
|
|
15633
|
+
"kind": "built-in-type-reference",
|
|
15634
|
+
"name": "Record",
|
|
15635
|
+
"typeArguments": [
|
|
15636
|
+
{
|
|
15637
|
+
"kind": "primitive",
|
|
15638
|
+
"name": "string"
|
|
15639
|
+
},
|
|
15640
|
+
{
|
|
15641
|
+
"kind": "primitive",
|
|
15642
|
+
"name": "string"
|
|
15643
|
+
}
|
|
15644
|
+
]
|
|
15645
|
+
},
|
|
15646
|
+
"isOptional": true,
|
|
15647
|
+
"jsdoc": {
|
|
15648
|
+
"text": "Values for path parameters and query string entries.\nParameters matching `:paramName` tokens in `to` are substituted into the path.\nAny remaining parameters are appended as query string entries."
|
|
15649
|
+
}
|
|
15650
|
+
},
|
|
15651
|
+
{
|
|
15652
|
+
"kind": "property",
|
|
15653
|
+
"name": "children",
|
|
15654
|
+
"type": {
|
|
15655
|
+
"kind": "type-reference",
|
|
15656
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15657
|
+
"typeString": "ReactNode"
|
|
15658
|
+
},
|
|
15659
|
+
"jsdoc": {
|
|
15660
|
+
"text": "The content to display inside the link."
|
|
15661
|
+
}
|
|
15662
|
+
},
|
|
15663
|
+
{
|
|
15664
|
+
"kind": "property",
|
|
15665
|
+
"name": "testId",
|
|
15666
|
+
"type": {
|
|
15667
|
+
"kind": "primitive",
|
|
15668
|
+
"name": "string"
|
|
15669
|
+
},
|
|
15670
|
+
"isOptional": true,
|
|
15671
|
+
"jsdoc": {
|
|
15672
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15673
|
+
"tags": [
|
|
15674
|
+
{
|
|
15675
|
+
"name": "see",
|
|
15676
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15677
|
+
}
|
|
15678
|
+
]
|
|
15679
|
+
}
|
|
15680
|
+
}
|
|
15681
|
+
]
|
|
15682
|
+
},
|
|
15683
|
+
"PageRouterProps:@hubspot/ui-extensions:dist/experimental/pages/types.d.ts": {
|
|
15684
|
+
"kind": "mapped-type",
|
|
15685
|
+
"declarationText": "EmptyProps"
|
|
15686
|
+
},
|
|
15687
|
+
"PageRoutesLayoutProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
|
|
15688
|
+
"kind": "object",
|
|
15689
|
+
"properties": [
|
|
15690
|
+
{
|
|
15691
|
+
"kind": "property",
|
|
15692
|
+
"name": "children",
|
|
15693
|
+
"type": {
|
|
15694
|
+
"kind": "type-reference",
|
|
15695
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15696
|
+
"typeString": "ReactNode"
|
|
15697
|
+
},
|
|
15698
|
+
"jsdoc": {
|
|
15699
|
+
"text": "The content to render inside the layout."
|
|
15700
|
+
}
|
|
15701
|
+
}
|
|
15702
|
+
]
|
|
15703
|
+
},
|
|
15704
|
+
"PageRoutesProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
|
|
15705
|
+
"kind": "object",
|
|
15706
|
+
"properties": [
|
|
15707
|
+
{
|
|
15708
|
+
"kind": "property",
|
|
15709
|
+
"name": "path",
|
|
15710
|
+
"type": {
|
|
15711
|
+
"kind": "primitive",
|
|
15712
|
+
"name": "string"
|
|
15713
|
+
},
|
|
15714
|
+
"isOptional": true,
|
|
15715
|
+
"jsdoc": {
|
|
15716
|
+
"text": "The path pattern of the route to include with all nested routes."
|
|
15717
|
+
}
|
|
15718
|
+
},
|
|
15719
|
+
{
|
|
15720
|
+
"kind": "property",
|
|
15721
|
+
"name": "layoutComponent",
|
|
15722
|
+
"type": {
|
|
15723
|
+
"kind": "union",
|
|
15724
|
+
"types": [
|
|
15725
|
+
{
|
|
15726
|
+
"kind": "type-reference",
|
|
15727
|
+
"typeId": "ComponentClass:@types/react@18.3.26:index.d.ts",
|
|
15728
|
+
"typeString": "ComponentClass"
|
|
15729
|
+
},
|
|
15730
|
+
{
|
|
15731
|
+
"kind": "type-reference",
|
|
15732
|
+
"typeId": "FunctionComponent:@types/react@18.3.26:index.d.ts",
|
|
15733
|
+
"typeString": "FunctionComponent"
|
|
15734
|
+
}
|
|
15735
|
+
]
|
|
15736
|
+
},
|
|
15737
|
+
"isOptional": true,
|
|
15738
|
+
"jsdoc": {
|
|
15739
|
+
"text": "The component to render for the layout of the page routes."
|
|
15740
|
+
}
|
|
15741
|
+
},
|
|
15742
|
+
{
|
|
15743
|
+
"kind": "property",
|
|
15744
|
+
"name": "children",
|
|
15745
|
+
"type": {
|
|
15746
|
+
"kind": "type-reference",
|
|
15747
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15748
|
+
"typeString": "ReactNode"
|
|
15749
|
+
},
|
|
15750
|
+
"jsdoc": {
|
|
15751
|
+
"text": "The nested route definitions."
|
|
15752
|
+
}
|
|
15753
|
+
}
|
|
15754
|
+
]
|
|
15755
|
+
},
|
|
15756
|
+
"PageTitleProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-title.d.ts": {
|
|
15757
|
+
"kind": "object",
|
|
15758
|
+
"properties": [
|
|
15759
|
+
{
|
|
15760
|
+
"kind": "property",
|
|
15761
|
+
"name": "children",
|
|
15762
|
+
"type": {
|
|
15763
|
+
"kind": "primitive",
|
|
15764
|
+
"name": "string"
|
|
15765
|
+
},
|
|
15766
|
+
"jsdoc": {
|
|
15767
|
+
"text": "The text to display as the page heading. Also sets the browser tab title."
|
|
15768
|
+
}
|
|
15769
|
+
},
|
|
15770
|
+
{
|
|
15771
|
+
"kind": "property",
|
|
15772
|
+
"name": "testId",
|
|
15773
|
+
"type": {
|
|
15774
|
+
"kind": "primitive",
|
|
15775
|
+
"name": "string"
|
|
15776
|
+
},
|
|
15777
|
+
"isOptional": true,
|
|
15778
|
+
"jsdoc": {
|
|
15779
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15780
|
+
"tags": [
|
|
15781
|
+
{
|
|
15782
|
+
"name": "see",
|
|
15783
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15784
|
+
}
|
|
15785
|
+
]
|
|
15786
|
+
}
|
|
15787
|
+
}
|
|
15788
|
+
]
|
|
15789
|
+
},
|
|
15790
|
+
"PanelAction:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts": {
|
|
15791
|
+
"kind": "function",
|
|
15792
|
+
"functionKind": "arrow",
|
|
15793
|
+
"parameters": [
|
|
15794
|
+
{
|
|
15795
|
+
"kind": "parameter",
|
|
15796
|
+
"name": "panelId",
|
|
15797
|
+
"type": {
|
|
15798
|
+
"kind": "primitive",
|
|
15799
|
+
"name": "string"
|
|
15800
|
+
}
|
|
15801
|
+
}
|
|
15802
|
+
],
|
|
15803
|
+
"returnType": {
|
|
15804
|
+
"kind": "primitive",
|
|
15805
|
+
"name": "void"
|
|
15806
|
+
}
|
|
15807
|
+
},
|
|
15808
|
+
"PanelBodyProps:@hubspot/ui-extensions:dist/shared/types/components/panel.d.ts": {
|
|
15809
|
+
"kind": "object",
|
|
15810
|
+
"properties": [
|
|
15811
|
+
{
|
|
15812
|
+
"kind": "property",
|
|
15813
|
+
"name": "children",
|
|
15814
|
+
"type": {
|
|
15815
|
+
"kind": "type-reference",
|
|
15816
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15817
|
+
"typeString": "ReactNode"
|
|
15818
|
+
},
|
|
15819
|
+
"jsdoc": {
|
|
15820
|
+
"text": "The main content of the body"
|
|
15821
|
+
}
|
|
15822
|
+
},
|
|
15823
|
+
{
|
|
15824
|
+
"kind": "property",
|
|
15825
|
+
"name": "testId",
|
|
15826
|
+
"type": {
|
|
15827
|
+
"kind": "primitive",
|
|
15828
|
+
"name": "string"
|
|
15829
|
+
},
|
|
15830
|
+
"isOptional": true,
|
|
15831
|
+
"jsdoc": {
|
|
15832
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15833
|
+
"tags": [
|
|
15834
|
+
{
|
|
15835
|
+
"name": "see",
|
|
15836
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15837
|
+
}
|
|
15838
|
+
]
|
|
15839
|
+
}
|
|
15840
|
+
}
|
|
15841
|
+
]
|
|
15842
|
+
},
|
|
15843
|
+
"PanelFooterProps:@hubspot/ui-extensions:dist/shared/types/components/panel.d.ts": {
|
|
15844
|
+
"kind": "object",
|
|
15845
|
+
"properties": [
|
|
15846
|
+
{
|
|
15847
|
+
"kind": "property",
|
|
15848
|
+
"name": "children",
|
|
15849
|
+
"type": {
|
|
15850
|
+
"kind": "type-reference",
|
|
15851
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15852
|
+
"typeString": "ReactNode"
|
|
15853
|
+
},
|
|
15854
|
+
"jsdoc": {
|
|
15855
|
+
"text": "The main content of the footer"
|
|
15856
|
+
}
|
|
15857
|
+
},
|
|
15858
|
+
{
|
|
15859
|
+
"kind": "property",
|
|
15860
|
+
"name": "testId",
|
|
15861
|
+
"type": {
|
|
15862
|
+
"kind": "primitive",
|
|
15863
|
+
"name": "string"
|
|
15864
|
+
},
|
|
15865
|
+
"isOptional": true,
|
|
15866
|
+
"jsdoc": {
|
|
15867
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
15868
|
+
"tags": [
|
|
15869
|
+
{
|
|
15870
|
+
"name": "see",
|
|
15871
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
15872
|
+
}
|
|
15873
|
+
]
|
|
15874
|
+
}
|
|
15875
|
+
}
|
|
15876
|
+
]
|
|
15877
|
+
},
|
|
15878
|
+
"PanelProps:@hubspot/ui-extensions:dist/shared/types/components/panel.d.ts": {
|
|
15879
|
+
"kind": "object",
|
|
15880
|
+
"properties": [
|
|
15881
|
+
{
|
|
15882
|
+
"kind": "property",
|
|
15883
|
+
"name": "aria-label",
|
|
15884
|
+
"type": {
|
|
15885
|
+
"kind": "primitive",
|
|
15886
|
+
"name": "string"
|
|
15887
|
+
},
|
|
15888
|
+
"isOptional": true,
|
|
15889
|
+
"jsdoc": {
|
|
15890
|
+
"text": "The panel's accessibility label."
|
|
15891
|
+
}
|
|
15892
|
+
},
|
|
15893
|
+
{
|
|
15894
|
+
"kind": "property",
|
|
15895
|
+
"name": "children",
|
|
15896
|
+
"type": {
|
|
15897
|
+
"kind": "type-reference",
|
|
15898
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
15899
|
+
"typeString": "ReactNode"
|
|
15900
|
+
},
|
|
15901
|
+
"isOptional": true,
|
|
15902
|
+
"jsdoc": {
|
|
15903
|
+
"text": "The main content of the panel when it opens."
|
|
15904
|
+
}
|
|
15905
|
+
},
|
|
15906
|
+
{
|
|
15907
|
+
"kind": "property",
|
|
15908
|
+
"name": "id",
|
|
15909
|
+
"type": {
|
|
15910
|
+
"kind": "primitive",
|
|
15911
|
+
"name": "string"
|
|
15912
|
+
},
|
|
15913
|
+
"jsdoc": {
|
|
15914
|
+
"text": "A unique ID for the panel."
|
|
15915
|
+
}
|
|
15916
|
+
},
|
|
15917
|
+
{
|
|
15918
|
+
"kind": "property",
|
|
15919
|
+
"name": "onOpen",
|
|
15920
|
+
"type": {
|
|
15921
|
+
"kind": "function",
|
|
15922
|
+
"functionKind": "arrow",
|
|
15923
|
+
"parameters": [],
|
|
15924
|
+
"returnType": {
|
|
15925
|
+
"kind": "primitive",
|
|
15926
|
+
"name": "void"
|
|
15927
|
+
}
|
|
15928
|
+
},
|
|
15929
|
+
"isOptional": true,
|
|
15930
|
+
"jsdoc": {
|
|
15931
|
+
"text": "A function that will be invoked when the panel has finished opening."
|
|
15932
|
+
}
|
|
15933
|
+
},
|
|
15934
|
+
{
|
|
15935
|
+
"kind": "property",
|
|
15936
|
+
"name": "onClose",
|
|
15937
|
+
"type": {
|
|
15938
|
+
"kind": "function",
|
|
15939
|
+
"functionKind": "arrow",
|
|
15940
|
+
"parameters": [],
|
|
15941
|
+
"returnType": {
|
|
15942
|
+
"kind": "primitive",
|
|
15943
|
+
"name": "void"
|
|
15944
|
+
}
|
|
15945
|
+
},
|
|
15946
|
+
"isOptional": true,
|
|
15947
|
+
"jsdoc": {
|
|
15948
|
+
"text": "A function that will be invoked when the panel has finished closing."
|
|
15949
|
+
}
|
|
15950
|
+
},
|
|
15951
|
+
{
|
|
15952
|
+
"kind": "property",
|
|
15953
|
+
"name": "width",
|
|
15954
|
+
"type": {
|
|
15955
|
+
"kind": "union",
|
|
15956
|
+
"types": [
|
|
15957
|
+
{
|
|
15958
|
+
"kind": "literal",
|
|
15959
|
+
"value": "sm"
|
|
15960
|
+
},
|
|
15961
|
+
{
|
|
15962
|
+
"kind": "literal",
|
|
15963
|
+
"value": "small"
|
|
15964
|
+
},
|
|
15965
|
+
{
|
|
15966
|
+
"kind": "literal",
|
|
15967
|
+
"value": "md"
|
|
15968
|
+
},
|
|
15969
|
+
{
|
|
15970
|
+
"kind": "literal",
|
|
15971
|
+
"value": "medium"
|
|
15972
|
+
},
|
|
15973
|
+
{
|
|
15974
|
+
"kind": "literal",
|
|
15975
|
+
"value": "lg"
|
|
15976
|
+
},
|
|
15977
|
+
{
|
|
15978
|
+
"kind": "literal",
|
|
15979
|
+
"value": "large"
|
|
15980
|
+
}
|
|
15981
|
+
]
|
|
15982
|
+
},
|
|
15983
|
+
"isOptional": true,
|
|
15984
|
+
"jsdoc": {
|
|
15985
|
+
"text": "The width of the panel.",
|
|
15986
|
+
"tags": [
|
|
15987
|
+
{
|
|
15988
|
+
"name": "defaultValue",
|
|
15989
|
+
"text": "`\"sm\"`"
|
|
15990
|
+
}
|
|
15991
|
+
]
|
|
15992
|
+
}
|
|
15993
|
+
},
|
|
15994
|
+
{
|
|
15995
|
+
"kind": "property",
|
|
15996
|
+
"name": "title",
|
|
15997
|
+
"type": {
|
|
15998
|
+
"kind": "primitive",
|
|
15999
|
+
"name": "string"
|
|
16000
|
+
},
|
|
16001
|
+
"isOptional": true,
|
|
16002
|
+
"jsdoc": {
|
|
16003
|
+
"text": "The text that displays at the top of the panel."
|
|
16004
|
+
}
|
|
16005
|
+
},
|
|
16006
|
+
{
|
|
16007
|
+
"kind": "property",
|
|
16008
|
+
"name": "variant",
|
|
16009
|
+
"type": {
|
|
16010
|
+
"kind": "union",
|
|
16011
|
+
"types": [
|
|
16012
|
+
{
|
|
16013
|
+
"kind": "literal",
|
|
16014
|
+
"value": "default"
|
|
16015
|
+
},
|
|
16016
|
+
{
|
|
16017
|
+
"kind": "literal",
|
|
16018
|
+
"value": "modal"
|
|
16019
|
+
}
|
|
16020
|
+
]
|
|
16021
|
+
},
|
|
16022
|
+
"isOptional": true,
|
|
16023
|
+
"jsdoc": {
|
|
16024
|
+
"text": "The panel variant. The `modal` variant includes better screen reader focus on the panel and is recommended for visual and motor accessibility and tab navigation. See [variants](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/panel#variants) for more information.",
|
|
16025
|
+
"tags": [
|
|
16026
|
+
{
|
|
16027
|
+
"name": "defaultValue",
|
|
16028
|
+
"text": "`\"default\"`"
|
|
16029
|
+
}
|
|
16030
|
+
]
|
|
16031
|
+
}
|
|
16032
|
+
},
|
|
16033
|
+
{
|
|
16034
|
+
"kind": "property",
|
|
16035
|
+
"name": "testId",
|
|
16036
|
+
"type": {
|
|
16037
|
+
"kind": "primitive",
|
|
16038
|
+
"name": "string"
|
|
16039
|
+
},
|
|
16040
|
+
"isOptional": true,
|
|
16041
|
+
"jsdoc": {
|
|
16042
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
16043
|
+
"tags": [
|
|
16044
|
+
{
|
|
16045
|
+
"name": "see",
|
|
16046
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
16047
|
+
}
|
|
16048
|
+
]
|
|
16049
|
+
}
|
|
16050
|
+
}
|
|
16051
|
+
]
|
|
16052
|
+
},
|
|
16053
|
+
"PanelSectionProps:@hubspot/ui-extensions:dist/shared/types/components/panel.d.ts": {
|
|
16054
|
+
"kind": "object",
|
|
16055
|
+
"properties": [
|
|
16056
|
+
{
|
|
16057
|
+
"kind": "property",
|
|
16058
|
+
"name": "flush",
|
|
16059
|
+
"type": {
|
|
16060
|
+
"kind": "primitive",
|
|
16061
|
+
"name": "boolean"
|
|
16062
|
+
},
|
|
16063
|
+
"isOptional": true,
|
|
16064
|
+
"jsdoc": {
|
|
16065
|
+
"text": "When set to `true`, the section will have no bottom margin.",
|
|
16066
|
+
"tags": [
|
|
16067
|
+
{
|
|
16068
|
+
"name": "defaultValue",
|
|
16069
|
+
"text": "`false`"
|
|
16070
|
+
}
|
|
16071
|
+
]
|
|
16072
|
+
}
|
|
16073
|
+
},
|
|
16074
|
+
{
|
|
16075
|
+
"kind": "property",
|
|
16076
|
+
"name": "children",
|
|
16077
|
+
"type": {
|
|
16078
|
+
"kind": "type-reference",
|
|
16079
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
16080
|
+
"typeString": "ReactNode"
|
|
16081
|
+
},
|
|
16082
|
+
"jsdoc": {
|
|
16083
|
+
"text": "The main content of the section."
|
|
16084
|
+
}
|
|
16085
|
+
},
|
|
16086
|
+
{
|
|
16087
|
+
"kind": "property",
|
|
16088
|
+
"name": "testId",
|
|
16089
|
+
"type": {
|
|
16090
|
+
"kind": "primitive",
|
|
16091
|
+
"name": "string"
|
|
16092
|
+
},
|
|
16093
|
+
"isOptional": true,
|
|
16094
|
+
"jsdoc": {
|
|
16095
|
+
"text": "Used by `findByTestId()` to locate this component in tests.",
|
|
16096
|
+
"tags": [
|
|
16097
|
+
{
|
|
16098
|
+
"name": "see",
|
|
16099
|
+
"text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
|
|
16100
|
+
}
|
|
16101
|
+
]
|
|
16102
|
+
}
|
|
16103
|
+
}
|
|
16104
|
+
]
|
|
16105
|
+
},
|
|
16106
|
+
"PercentileMetricItem:@hubspot/ui-extensions:dist/shared/types/crm.d.ts": {
|
|
16107
|
+
"kind": "object",
|
|
16108
|
+
"properties": [
|
|
16109
|
+
{
|
|
16110
|
+
"kind": "property",
|
|
16111
|
+
"name": "statisticType",
|
|
15139
16112
|
"type": {
|
|
15140
16113
|
"kind": "literal",
|
|
15141
16114
|
"value": "PERCENTILES"
|
|
@@ -16193,6 +17166,28 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16193
17166
|
}
|
|
16194
17167
|
]
|
|
16195
17168
|
},
|
|
17169
|
+
"ReactElement:@types/react@18.3.26:index.d.ts": {
|
|
17170
|
+
"kind": "external-type-reference",
|
|
17171
|
+
"typeName": "ReactElement",
|
|
17172
|
+
"typeString": "ReactElement",
|
|
17173
|
+
"packageName": "@types/react",
|
|
17174
|
+
"packageVersion": "18.3.26"
|
|
17175
|
+
},
|
|
17176
|
+
"ReactFragmentProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts": {
|
|
17177
|
+
"kind": "object",
|
|
17178
|
+
"properties": [
|
|
17179
|
+
{
|
|
17180
|
+
"kind": "property",
|
|
17181
|
+
"name": "children",
|
|
17182
|
+
"type": {
|
|
17183
|
+
"kind": "type-reference",
|
|
17184
|
+
"typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
|
|
17185
|
+
"typeString": "ReactNode"
|
|
17186
|
+
},
|
|
17187
|
+
"isOptional": true
|
|
17188
|
+
}
|
|
17189
|
+
]
|
|
17190
|
+
},
|
|
16196
17191
|
"ReactNode:@types/react@18.3.26:index.d.ts": {
|
|
16197
17192
|
"kind": "external-type-reference",
|
|
16198
17193
|
"typeName": "ReactNode",
|
|
@@ -16323,6 +17318,53 @@ export const componentPropsReader = createAnalyzeResultReader({
|
|
|
16323
17318
|
}
|
|
16324
17319
|
]
|
|
16325
17320
|
},
|
|
17321
|
+
"RouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
|
|
17322
|
+
"kind": "object",
|
|
17323
|
+
"properties": [
|
|
17324
|
+
{
|
|
17325
|
+
"kind": "property",
|
|
17326
|
+
"name": "path",
|
|
17327
|
+
"type": {
|
|
17328
|
+
"kind": "primitive",
|
|
17329
|
+
"name": "string"
|
|
17330
|
+
},
|
|
17331
|
+
"jsdoc": {
|
|
17332
|
+
"text": "The path pattern of the route to match."
|
|
17333
|
+
}
|
|
17334
|
+
},
|
|
17335
|
+
{
|
|
17336
|
+
"kind": "property",
|
|
17337
|
+
"name": "component",
|
|
17338
|
+
"type": {
|
|
17339
|
+
"kind": "type-reference",
|
|
17340
|
+
"typeId": "ComponentType:@types/react@18.3.26:index.d.ts",
|
|
17341
|
+
"typeString": "ComponentType<EmptyProps>",
|
|
17342
|
+
"typeArguments": [
|
|
17343
|
+
{
|
|
17344
|
+
"kind": "type-reference",
|
|
17345
|
+
"typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
|
|
17346
|
+
"typeString": "EmptyProps"
|
|
17347
|
+
}
|
|
17348
|
+
]
|
|
17349
|
+
},
|
|
17350
|
+
"jsdoc": {
|
|
17351
|
+
"text": "The component to render when the route is matched."
|
|
17352
|
+
}
|
|
17353
|
+
},
|
|
17354
|
+
{
|
|
17355
|
+
"kind": "property",
|
|
17356
|
+
"name": "id",
|
|
17357
|
+
"type": {
|
|
17358
|
+
"kind": "primitive",
|
|
17359
|
+
"name": "string"
|
|
17360
|
+
},
|
|
17361
|
+
"isOptional": true,
|
|
17362
|
+
"jsdoc": {
|
|
17363
|
+
"text": "A unique identifier for the route."
|
|
17364
|
+
}
|
|
17365
|
+
}
|
|
17366
|
+
]
|
|
17367
|
+
},
|
|
16326
17368
|
"ScoreProps:@hubspot/ui-extensions:dist/shared/types/components/score.d.ts": {
|
|
16327
17369
|
"kind": "object",
|
|
16328
17370
|
"properties": [
|