@nuxt/scripts 1.0.0-beta.29 → 1.0.0-beta.30
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/client/200.html +1 -1
- package/dist/client/404.html +1 -1
- package/dist/client/_nuxt/builds/latest.json +1 -1
- package/dist/client/_nuxt/builds/meta/f0b4dd20-8496-4003-b7a3-05cbae515923.json +1 -0
- package/dist/client/index.html +1 -1
- package/dist/module.json +1 -1
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsAdvancedMarkerElement.d.vue.ts +16 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsAdvancedMarkerElement.vue.d.ts +16 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsCircle.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsCircle.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsGeoJson.d.vue.ts +8 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsGeoJson.vue.d.ts +8 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsHeatmapLayer.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsHeatmapLayer.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsInfoWindow.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsInfoWindow.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarker.d.vue.ts +16 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarker.vue.d.ts +16 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.d.vue.ts +8 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.vue +18 -8
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsMarkerClusterer.vue.d.ts +8 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsOverlayView.d.vue.ts +23 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsOverlayView.vue.d.ts +23 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPinElement.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPinElement.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolygon.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolygon.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolyline.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsPolyline.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsRectangle.d.vue.ts +4 -0
- package/dist/runtime/components/GoogleMaps/ScriptGoogleMapsRectangle.vue.d.ts +4 -0
- package/dist/runtime/components/GoogleMaps/useGoogleMapsResource.js +14 -9
- package/dist/types-source.mjs +377 -188
- package/package.json +2 -2
- package/dist/client/_nuxt/builds/meta/05eb1abd-7d1c-43e9-b78e-dc8ec287cc6f.json +0 -1
package/dist/types-source.mjs
CHANGED
|
@@ -211,7 +211,7 @@ const types = {
|
|
|
211
211
|
{
|
|
212
212
|
name: "ScriptGoogleMapsAdvancedMarkerElementProps",
|
|
213
213
|
kind: "interface",
|
|
214
|
-
code: "interface ScriptGoogleMapsAdvancedMarkerElementProps {\n position?: google.maps.LatLngLiteral | google.maps.LatLng\n options?: Omit<google.maps.marker.AdvancedMarkerElementOptions, 'map'>\n}"
|
|
214
|
+
code: "interface ScriptGoogleMapsAdvancedMarkerElementProps {\n /**\n * The position of the marker on the map.\n * @see https://developers.google.com/maps/documentation/javascript/reference/advanced-markers#AdvancedMarkerElementOptions.position\n */\n position?: google.maps.LatLngLiteral | google.maps.LatLng\n /**\n * Configuration options for the advanced marker.\n * @see https://developers.google.com/maps/documentation/javascript/reference/advanced-markers#AdvancedMarkerElementOptions\n */\n options?: Omit<google.maps.marker.AdvancedMarkerElementOptions, 'map'>\n}"
|
|
215
215
|
},
|
|
216
216
|
{
|
|
217
217
|
name: "ScriptGoogleMapsAdvancedMarkerElementEvents",
|
|
@@ -221,7 +221,7 @@ const types = {
|
|
|
221
221
|
{
|
|
222
222
|
name: "ScriptGoogleMapsCircleProps",
|
|
223
223
|
kind: "interface",
|
|
224
|
-
code: "interface ScriptGoogleMapsCircleProps {\n options?: Omit<google.maps.CircleOptions, 'map'>\n}"
|
|
224
|
+
code: "interface ScriptGoogleMapsCircleProps {\n /**\n * Configuration options for the circle overlay.\n * @see https://developers.google.com/maps/documentation/javascript/reference/polygon#CircleOptions\n */\n options?: Omit<google.maps.CircleOptions, 'map'>\n}"
|
|
225
225
|
},
|
|
226
226
|
{
|
|
227
227
|
name: "ScriptGoogleMapsCircleEvents",
|
|
@@ -231,7 +231,7 @@ const types = {
|
|
|
231
231
|
{
|
|
232
232
|
name: "ScriptGoogleMapsGeoJsonProps",
|
|
233
233
|
kind: "interface",
|
|
234
|
-
code: "interface ScriptGoogleMapsGeoJsonProps {\n src: string | object\n style?: google.maps.Data.StylingFunction | google.maps.Data.StyleOptions\n}"
|
|
234
|
+
code: "interface ScriptGoogleMapsGeoJsonProps {\n /**\n * The GeoJSON source. Can be a URL string or a GeoJSON object.\n * @see https://developers.google.com/maps/documentation/javascript/datalayer#load_geojson\n */\n src: string | object\n /**\n * Styling options or a function that computes styles per feature.\n * @see https://developers.google.com/maps/documentation/javascript/datalayer#style_geojson_data\n */\n style?: google.maps.Data.StylingFunction | google.maps.Data.StyleOptions\n}"
|
|
235
235
|
},
|
|
236
236
|
{
|
|
237
237
|
name: "ScriptGoogleMapsGeoJsonEvents",
|
|
@@ -241,12 +241,12 @@ const types = {
|
|
|
241
241
|
{
|
|
242
242
|
name: "ScriptGoogleMapsHeatmapLayerProps",
|
|
243
243
|
kind: "interface",
|
|
244
|
-
code: "interface ScriptGoogleMapsHeatmapLayerProps {\n options?: Omit<google.maps.visualization.HeatmapLayerOptions, 'map'>\n}"
|
|
244
|
+
code: "interface ScriptGoogleMapsHeatmapLayerProps {\n /**\n * Configuration options for the heatmap layer visualization.\n * @see https://developers.google.com/maps/documentation/javascript/reference/visualization#HeatmapLayerOptions\n */\n options?: Omit<google.maps.visualization.HeatmapLayerOptions, 'map'>\n}"
|
|
245
245
|
},
|
|
246
246
|
{
|
|
247
247
|
name: "ScriptGoogleMapsInfoWindowProps",
|
|
248
248
|
kind: "interface",
|
|
249
|
-
code: "interface ScriptGoogleMapsInfoWindowProps {\n options?: google.maps.InfoWindowOptions\n}"
|
|
249
|
+
code: "interface ScriptGoogleMapsInfoWindowProps {\n /**\n * Configuration options for the info window.\n * @see https://developers.google.com/maps/documentation/javascript/reference/info-window#InfoWindowOptions\n */\n options?: google.maps.InfoWindowOptions\n}"
|
|
250
250
|
},
|
|
251
251
|
{
|
|
252
252
|
name: "ScriptGoogleMapsInfoWindowEvents",
|
|
@@ -256,7 +256,7 @@ const types = {
|
|
|
256
256
|
{
|
|
257
257
|
name: "ScriptGoogleMapsMarkerProps",
|
|
258
258
|
kind: "interface",
|
|
259
|
-
code: "interface ScriptGoogleMapsMarkerProps {\n position?: google.maps.LatLngLiteral | google.maps.LatLng\n options?: Omit<google.maps.MarkerOptions, 'map'>\n}"
|
|
259
|
+
code: "interface ScriptGoogleMapsMarkerProps {\n /**\n * The position of the marker on the map.\n * @see https://developers.google.com/maps/documentation/javascript/reference/marker#MarkerOptions.position\n */\n position?: google.maps.LatLngLiteral | google.maps.LatLng\n /**\n * Configuration options for the legacy marker. Deprecated: use ScriptGoogleMapsAdvancedMarkerElement instead.\n * @see https://developers.google.com/maps/documentation/javascript/reference/marker#MarkerOptions\n */\n options?: Omit<google.maps.MarkerOptions, 'map'>\n}"
|
|
260
260
|
},
|
|
261
261
|
{
|
|
262
262
|
name: "ScriptGoogleMapsMarkerEvents",
|
|
@@ -266,7 +266,7 @@ const types = {
|
|
|
266
266
|
{
|
|
267
267
|
name: "ScriptGoogleMapsMarkerClustererProps",
|
|
268
268
|
kind: "interface",
|
|
269
|
-
code: "interface ScriptGoogleMapsMarkerClustererProps {\n options?: Omit<MarkerClustererOptions, 'map'>\n}"
|
|
269
|
+
code: "interface ScriptGoogleMapsMarkerClustererProps {\n /**\n * Configuration options for the marker clusterer.\n * @see https://googlemaps.github.io/js-markerclusterer/interfaces/MarkerClustererOptions.html\n */\n options?: Omit<MarkerClustererOptions, 'map'>\n}"
|
|
270
270
|
},
|
|
271
271
|
{
|
|
272
272
|
name: "ScriptGoogleMapsMarkerClustererEvents",
|
|
@@ -276,17 +276,17 @@ const types = {
|
|
|
276
276
|
{
|
|
277
277
|
name: "ScriptGoogleMapsOverlayViewProps",
|
|
278
278
|
kind: "interface",
|
|
279
|
-
code: "interface ScriptGoogleMapsOverlayViewProps {\n position?: google.maps.LatLngLiteral\n anchor?: OverlayAnchor\n offset?: { x: number, y: number }\n pane?: OverlayPane\n zIndex?: number\n blockMapInteraction?: boolean\n}"
|
|
279
|
+
code: "interface ScriptGoogleMapsOverlayViewProps {\n /**\n * Geographic position for the overlay. Falls back to parent marker position if omitted.\n * @see https://developers.google.com/maps/documentation/javascript/reference/overlay-view#OverlayView\n */\n position?: google.maps.LatLngLiteral\n /**\n * Anchor point of the overlay relative to its position.\n * @default 'bottom-center'\n */\n anchor?: OverlayAnchor\n /**\n * Pixel offset from the anchor position.\n */\n offset?: { x: number, y: number }\n /**\n * The map pane on which to render the overlay.\n * @default 'floatPane'\n * @see https://developers.google.com/maps/documentation/javascript/reference/overlay-view#MapPanes\n */\n pane?: OverlayPane\n /**\n * CSS z-index for the overlay element.\n */\n zIndex?: number\n /**\n * Whether to block map click and gesture events from passing through the overlay.\n * @default true\n */\n blockMapInteraction?: boolean\n}"
|
|
280
280
|
},
|
|
281
281
|
{
|
|
282
282
|
name: "ScriptGoogleMapsPinElementProps",
|
|
283
283
|
kind: "interface",
|
|
284
|
-
code: "interface ScriptGoogleMapsPinElementProps {\n options?: Omit<google.maps.marker.PinElementOptions, 'map'>\n}"
|
|
284
|
+
code: "interface ScriptGoogleMapsPinElementProps {\n /**\n * Configuration options for the pin element that customizes the visual appearance of the marker.\n * @see https://developers.google.com/maps/documentation/javascript/reference/advanced-markers#PinElementOptions\n */\n options?: Omit<google.maps.marker.PinElementOptions, 'map'>\n}"
|
|
285
285
|
},
|
|
286
286
|
{
|
|
287
287
|
name: "ScriptGoogleMapsPolygonProps",
|
|
288
288
|
kind: "interface",
|
|
289
|
-
code: "interface ScriptGoogleMapsPolygonProps {\n options?: Omit<google.maps.PolygonOptions, 'map'>\n}"
|
|
289
|
+
code: "interface ScriptGoogleMapsPolygonProps {\n /**\n * Configuration options for the polygon overlay.\n * @see https://developers.google.com/maps/documentation/javascript/reference/polygon#PolygonOptions\n */\n options?: Omit<google.maps.PolygonOptions, 'map'>\n}"
|
|
290
290
|
},
|
|
291
291
|
{
|
|
292
292
|
name: "ScriptGoogleMapsPolygonEvents",
|
|
@@ -296,7 +296,7 @@ const types = {
|
|
|
296
296
|
{
|
|
297
297
|
name: "ScriptGoogleMapsPolylineProps",
|
|
298
298
|
kind: "interface",
|
|
299
|
-
code: "interface ScriptGoogleMapsPolylineProps {\n options?: Omit<google.maps.PolylineOptions, 'map'>\n}"
|
|
299
|
+
code: "interface ScriptGoogleMapsPolylineProps {\n /**\n * Configuration options for the polyline overlay.\n * @see https://developers.google.com/maps/documentation/javascript/reference/polygon#PolylineOptions\n */\n options?: Omit<google.maps.PolylineOptions, 'map'>\n}"
|
|
300
300
|
},
|
|
301
301
|
{
|
|
302
302
|
name: "ScriptGoogleMapsPolylineEvents",
|
|
@@ -306,7 +306,7 @@ const types = {
|
|
|
306
306
|
{
|
|
307
307
|
name: "ScriptGoogleMapsRectangleProps",
|
|
308
308
|
kind: "interface",
|
|
309
|
-
code: "interface ScriptGoogleMapsRectangleProps {\n options?: Omit<google.maps.RectangleOptions, 'map'>\n}"
|
|
309
|
+
code: "interface ScriptGoogleMapsRectangleProps {\n /**\n * Configuration options for the rectangle overlay.\n * @see https://developers.google.com/maps/documentation/javascript/reference/polygon#RectangleOptions\n */\n options?: Omit<google.maps.RectangleOptions, 'map'>\n}"
|
|
310
310
|
},
|
|
311
311
|
{
|
|
312
312
|
name: "ScriptGoogleMapsRectangleEvents",
|
|
@@ -2073,527 +2073,629 @@ const schemaFields = {
|
|
|
2073
2073
|
{
|
|
2074
2074
|
name: "trigger",
|
|
2075
2075
|
type: "ElementScriptTrigger",
|
|
2076
|
-
required: false
|
|
2076
|
+
required: false,
|
|
2077
|
+
description: "Defines the trigger event to load the script."
|
|
2077
2078
|
},
|
|
2078
2079
|
{
|
|
2079
2080
|
name: "aboveTheFold",
|
|
2080
2081
|
type: "boolean",
|
|
2081
|
-
required: false
|
|
2082
|
+
required: false,
|
|
2083
|
+
description: "Is Google Maps being rendered above the fold? This will load the placeholder image with higher priority."
|
|
2082
2084
|
},
|
|
2083
2085
|
{
|
|
2084
2086
|
name: "apiKey",
|
|
2085
2087
|
type: "string",
|
|
2086
|
-
required: false
|
|
2088
|
+
required: false,
|
|
2089
|
+
description: "Defines the Google Maps API key. Must have access to the Static Maps API as well."
|
|
2087
2090
|
},
|
|
2088
2091
|
{
|
|
2089
2092
|
name: "center",
|
|
2090
2093
|
type: "google.maps.LatLng | google.maps.LatLngLiteral | `${string},${string}`",
|
|
2091
|
-
required: false
|
|
2094
|
+
required: false,
|
|
2095
|
+
description: "A latitude / longitude of where to focus the map."
|
|
2092
2096
|
},
|
|
2093
2097
|
{
|
|
2094
2098
|
name: "zoom",
|
|
2095
2099
|
type: "number",
|
|
2096
|
-
required: false
|
|
2100
|
+
required: false,
|
|
2101
|
+
description: "Zoom level for the map (0-21). Reactive: changing this will update the map. Takes precedence over mapOptions.zoom when provided."
|
|
2097
2102
|
},
|
|
2098
2103
|
{
|
|
2099
2104
|
name: "centerMarker",
|
|
2100
2105
|
type: "boolean",
|
|
2101
|
-
required: false
|
|
2106
|
+
required: false,
|
|
2107
|
+
description: "Should a marker be displayed on the map where the centre is."
|
|
2102
2108
|
},
|
|
2103
2109
|
{
|
|
2104
2110
|
name: "mapOptions",
|
|
2105
2111
|
type: "google.maps.MapOptions",
|
|
2106
|
-
required: false
|
|
2112
|
+
required: false,
|
|
2113
|
+
description: "Options for the map."
|
|
2107
2114
|
},
|
|
2108
2115
|
{
|
|
2109
2116
|
name: "region",
|
|
2110
2117
|
type: "string",
|
|
2111
|
-
required: false
|
|
2118
|
+
required: false,
|
|
2119
|
+
description: "Defines the region of the map."
|
|
2112
2120
|
},
|
|
2113
2121
|
{
|
|
2114
2122
|
name: "language",
|
|
2115
2123
|
type: "string",
|
|
2116
|
-
required: false
|
|
2124
|
+
required: false,
|
|
2125
|
+
description: "Defines the language of the map"
|
|
2117
2126
|
},
|
|
2118
2127
|
{
|
|
2119
2128
|
name: "version",
|
|
2120
2129
|
type: "string",
|
|
2121
|
-
required: false
|
|
2130
|
+
required: false,
|
|
2131
|
+
description: "Defines the version of google maps js API"
|
|
2122
2132
|
},
|
|
2123
2133
|
{
|
|
2124
2134
|
name: "width",
|
|
2125
2135
|
type: "number | string",
|
|
2126
|
-
required: false
|
|
2136
|
+
required: false,
|
|
2137
|
+
description: "Defines the width of the map."
|
|
2127
2138
|
},
|
|
2128
2139
|
{
|
|
2129
2140
|
name: "height",
|
|
2130
2141
|
type: "number | string",
|
|
2131
|
-
required: false
|
|
2142
|
+
required: false,
|
|
2143
|
+
description: "Defines the height of the map"
|
|
2132
2144
|
},
|
|
2133
2145
|
{
|
|
2134
2146
|
name: "placeholderOptions",
|
|
2135
2147
|
type: "PlaceholderOptions",
|
|
2136
|
-
required: false
|
|
2148
|
+
required: false,
|
|
2149
|
+
description: "Customize the placeholder image attributes."
|
|
2137
2150
|
},
|
|
2138
2151
|
{
|
|
2139
2152
|
name: "placeholderAttrs",
|
|
2140
2153
|
type: "ImgHTMLAttributes & ReservedProps & Record<string, unknown>",
|
|
2141
|
-
required: false
|
|
2154
|
+
required: false,
|
|
2155
|
+
description: "Customize the placeholder image attributes."
|
|
2142
2156
|
},
|
|
2143
2157
|
{
|
|
2144
2158
|
name: "rootAttrs",
|
|
2145
2159
|
type: "HTMLAttributes & ReservedProps & Record<string, unknown>",
|
|
2146
|
-
required: false
|
|
2160
|
+
required: false,
|
|
2161
|
+
description: "Customize the root element attributes."
|
|
2147
2162
|
},
|
|
2148
2163
|
{
|
|
2149
2164
|
name: "markers",
|
|
2150
2165
|
type: "(`${string},${string}` | google.maps.marker.AdvancedMarkerElementOptions)[]",
|
|
2151
|
-
required: false
|
|
2166
|
+
required: false,
|
|
2167
|
+
description: "Extra Markers to add to the map."
|
|
2152
2168
|
},
|
|
2153
2169
|
{
|
|
2154
2170
|
name: "mapIds",
|
|
2155
2171
|
type: "{ light?: string, dark?: string }",
|
|
2156
|
-
required: false
|
|
2172
|
+
required: false,
|
|
2173
|
+
description: "Map IDs for light and dark color modes. When provided, the map will automatically switch styles based on color mode. Requires @nuxtjs/color-mode or manual colorMode prop."
|
|
2157
2174
|
},
|
|
2158
2175
|
{
|
|
2159
2176
|
name: "colorMode",
|
|
2160
2177
|
type: "'light' | 'dark'",
|
|
2161
|
-
required: false
|
|
2178
|
+
required: false,
|
|
2179
|
+
description: "Manual color mode control. When provided, overrides auto-detection from @nuxtjs/color-mode. Accepts 'light', 'dark', or a reactive ref."
|
|
2162
2180
|
}
|
|
2163
2181
|
],
|
|
2164
2182
|
ScriptGoogleMapsEvents: [
|
|
2165
2183
|
{
|
|
2166
2184
|
name: "ready",
|
|
2167
2185
|
type: "typeof googleMaps",
|
|
2168
|
-
required: false
|
|
2186
|
+
required: false,
|
|
2187
|
+
description: "Fired when the Google Maps instance is fully loaded and ready to use. Provides access to the maps API."
|
|
2169
2188
|
},
|
|
2170
2189
|
{
|
|
2171
2190
|
name: "error",
|
|
2172
2191
|
type: "-",
|
|
2173
|
-
required: false
|
|
2192
|
+
required: false,
|
|
2193
|
+
description: "Fired when the Google Maps script fails to load."
|
|
2174
2194
|
}
|
|
2175
2195
|
],
|
|
2176
2196
|
ScriptGoogleMapsAdvancedMarkerElementProps: [
|
|
2177
2197
|
{
|
|
2178
2198
|
name: "position",
|
|
2179
2199
|
type: "google.maps.LatLngLiteral | google.maps.LatLng",
|
|
2180
|
-
required: false
|
|
2200
|
+
required: false,
|
|
2201
|
+
description: "The position of the marker on the map."
|
|
2181
2202
|
},
|
|
2182
2203
|
{
|
|
2183
2204
|
name: "options",
|
|
2184
2205
|
type: "Omit<google.maps.marker.AdvancedMarkerElementOptions, 'map'>",
|
|
2185
|
-
required: false
|
|
2206
|
+
required: false,
|
|
2207
|
+
description: "Configuration options for the advanced marker."
|
|
2186
2208
|
}
|
|
2187
2209
|
],
|
|
2188
2210
|
ScriptGoogleMapsAdvancedMarkerElementEvents: [
|
|
2189
2211
|
{
|
|
2190
2212
|
name: "click",
|
|
2191
2213
|
type: "google.maps.MapMouseEvent",
|
|
2192
|
-
required: false
|
|
2214
|
+
required: false,
|
|
2215
|
+
description: "Fired when the marker is clicked."
|
|
2193
2216
|
},
|
|
2194
2217
|
{
|
|
2195
2218
|
name: "drag",
|
|
2196
2219
|
type: "google.maps.MapMouseEvent",
|
|
2197
|
-
required: false
|
|
2220
|
+
required: false,
|
|
2221
|
+
description: "Fired repeatedly while the user drags the marker."
|
|
2198
2222
|
},
|
|
2199
2223
|
{
|
|
2200
2224
|
name: "dragend",
|
|
2201
2225
|
type: "google.maps.MapMouseEvent",
|
|
2202
|
-
required: false
|
|
2226
|
+
required: false,
|
|
2227
|
+
description: "Fired when the user stops dragging the marker."
|
|
2203
2228
|
},
|
|
2204
2229
|
{
|
|
2205
2230
|
name: "dragstart",
|
|
2206
2231
|
type: "google.maps.MapMouseEvent",
|
|
2207
|
-
required: false
|
|
2232
|
+
required: false,
|
|
2233
|
+
description: "Fired when the user starts dragging the marker."
|
|
2208
2234
|
}
|
|
2209
2235
|
],
|
|
2210
2236
|
ScriptGoogleMapsCircleProps: [
|
|
2211
2237
|
{
|
|
2212
2238
|
name: "options",
|
|
2213
2239
|
type: "Omit<google.maps.CircleOptions, 'map'>",
|
|
2214
|
-
required: false
|
|
2240
|
+
required: false,
|
|
2241
|
+
description: "Configuration options for the circle overlay."
|
|
2215
2242
|
}
|
|
2216
2243
|
],
|
|
2217
2244
|
ScriptGoogleMapsCircleEvents: [
|
|
2218
2245
|
{
|
|
2219
2246
|
name: "center_changed",
|
|
2220
2247
|
type: "-",
|
|
2221
|
-
required: false
|
|
2248
|
+
required: false,
|
|
2249
|
+
description: "Fired when the circle's center is changed."
|
|
2222
2250
|
},
|
|
2223
2251
|
{
|
|
2224
2252
|
name: "radius_changed",
|
|
2225
2253
|
type: "-",
|
|
2226
|
-
required: false
|
|
2254
|
+
required: false,
|
|
2255
|
+
description: "Fired when the circle's radius is changed."
|
|
2227
2256
|
},
|
|
2228
2257
|
{
|
|
2229
2258
|
name: "click",
|
|
2230
2259
|
type: "google.maps.MapMouseEvent",
|
|
2231
|
-
required: false
|
|
2260
|
+
required: false,
|
|
2261
|
+
description: "Fired when the circle is clicked."
|
|
2232
2262
|
},
|
|
2233
2263
|
{
|
|
2234
2264
|
name: "dblclick",
|
|
2235
2265
|
type: "google.maps.MapMouseEvent",
|
|
2236
|
-
required: false
|
|
2266
|
+
required: false,
|
|
2267
|
+
description: "Fired when the circle is double clicked."
|
|
2237
2268
|
},
|
|
2238
2269
|
{
|
|
2239
2270
|
name: "drag",
|
|
2240
2271
|
type: "google.maps.MapMouseEvent",
|
|
2241
|
-
required: false
|
|
2272
|
+
required: false,
|
|
2273
|
+
description: "Fired repeatedly while the user drags the circle."
|
|
2242
2274
|
},
|
|
2243
2275
|
{
|
|
2244
2276
|
name: "dragend",
|
|
2245
2277
|
type: "google.maps.MapMouseEvent",
|
|
2246
|
-
required: false
|
|
2278
|
+
required: false,
|
|
2279
|
+
description: "Fired when the user stops dragging the circle."
|
|
2247
2280
|
},
|
|
2248
2281
|
{
|
|
2249
2282
|
name: "dragstart",
|
|
2250
2283
|
type: "google.maps.MapMouseEvent",
|
|
2251
|
-
required: false
|
|
2284
|
+
required: false,
|
|
2285
|
+
description: "Fired when the user starts dragging the circle."
|
|
2252
2286
|
},
|
|
2253
2287
|
{
|
|
2254
2288
|
name: "mousedown",
|
|
2255
2289
|
type: "google.maps.MapMouseEvent",
|
|
2256
|
-
required: false
|
|
2290
|
+
required: false,
|
|
2291
|
+
description: "Fired when the DOM mousedown event is fired on the circle."
|
|
2257
2292
|
},
|
|
2258
2293
|
{
|
|
2259
2294
|
name: "mousemove",
|
|
2260
2295
|
type: "google.maps.MapMouseEvent",
|
|
2261
|
-
required: false
|
|
2296
|
+
required: false,
|
|
2297
|
+
description: "Fired when the DOM mousemove event is fired on the circle."
|
|
2262
2298
|
},
|
|
2263
2299
|
{
|
|
2264
2300
|
name: "mouseout",
|
|
2265
2301
|
type: "google.maps.MapMouseEvent",
|
|
2266
|
-
required: false
|
|
2302
|
+
required: false,
|
|
2303
|
+
description: "Fired when the mouse leaves the area of the circle."
|
|
2267
2304
|
},
|
|
2268
2305
|
{
|
|
2269
2306
|
name: "mouseover",
|
|
2270
2307
|
type: "google.maps.MapMouseEvent",
|
|
2271
|
-
required: false
|
|
2308
|
+
required: false,
|
|
2309
|
+
description: "Fired when the mouse enters the area of the circle."
|
|
2272
2310
|
},
|
|
2273
2311
|
{
|
|
2274
2312
|
name: "mouseup",
|
|
2275
2313
|
type: "google.maps.MapMouseEvent",
|
|
2276
|
-
required: false
|
|
2314
|
+
required: false,
|
|
2315
|
+
description: "Fired when the DOM mouseup event is fired on the circle."
|
|
2277
2316
|
},
|
|
2278
2317
|
{
|
|
2279
2318
|
name: "rightclick",
|
|
2280
2319
|
type: "google.maps.MapMouseEvent",
|
|
2281
|
-
required: false
|
|
2320
|
+
required: false,
|
|
2321
|
+
description: "Fired when the circle is right clicked."
|
|
2282
2322
|
}
|
|
2283
2323
|
],
|
|
2284
2324
|
ScriptGoogleMapsGeoJsonProps: [
|
|
2285
2325
|
{
|
|
2286
2326
|
name: "src",
|
|
2287
2327
|
type: "string | object",
|
|
2288
|
-
required: true
|
|
2328
|
+
required: true,
|
|
2329
|
+
description: "The GeoJSON source. Can be a URL string or a GeoJSON object."
|
|
2289
2330
|
},
|
|
2290
2331
|
{
|
|
2291
2332
|
name: "style",
|
|
2292
2333
|
type: "google.maps.Data.StylingFunction | google.maps.Data.StyleOptions",
|
|
2293
|
-
required: false
|
|
2334
|
+
required: false,
|
|
2335
|
+
description: "Styling options or a function that computes styles per feature."
|
|
2294
2336
|
}
|
|
2295
2337
|
],
|
|
2296
2338
|
ScriptGoogleMapsGeoJsonEvents: [
|
|
2297
2339
|
{
|
|
2298
2340
|
name: "click",
|
|
2299
2341
|
type: "google.maps.Data.MouseEvent",
|
|
2300
|
-
required: false
|
|
2342
|
+
required: false,
|
|
2343
|
+
description: "Fired when a feature in the data layer is clicked."
|
|
2301
2344
|
},
|
|
2302
2345
|
{
|
|
2303
2346
|
name: "contextmenu",
|
|
2304
2347
|
type: "google.maps.Data.MouseEvent",
|
|
2305
|
-
required: false
|
|
2348
|
+
required: false,
|
|
2349
|
+
description: "Fired when the DOM contextmenu event is fired on a feature."
|
|
2306
2350
|
},
|
|
2307
2351
|
{
|
|
2308
2352
|
name: "dblclick",
|
|
2309
2353
|
type: "google.maps.Data.MouseEvent",
|
|
2310
|
-
required: false
|
|
2354
|
+
required: false,
|
|
2355
|
+
description: "Fired when a feature is double clicked."
|
|
2311
2356
|
},
|
|
2312
2357
|
{
|
|
2313
2358
|
name: "mousedown",
|
|
2314
2359
|
type: "google.maps.Data.MouseEvent",
|
|
2315
|
-
required: false
|
|
2360
|
+
required: false,
|
|
2361
|
+
description: "Fired when the DOM mousedown event is fired on a feature."
|
|
2316
2362
|
},
|
|
2317
2363
|
{
|
|
2318
2364
|
name: "mousemove",
|
|
2319
2365
|
type: "google.maps.Data.MouseEvent",
|
|
2320
|
-
required: false
|
|
2366
|
+
required: false,
|
|
2367
|
+
description: "Fired when the DOM mousemove event is fired on a feature."
|
|
2321
2368
|
},
|
|
2322
2369
|
{
|
|
2323
2370
|
name: "mouseout",
|
|
2324
2371
|
type: "google.maps.Data.MouseEvent",
|
|
2325
|
-
required: false
|
|
2372
|
+
required: false,
|
|
2373
|
+
description: "Fired when the mouse leaves the area of a feature."
|
|
2326
2374
|
},
|
|
2327
2375
|
{
|
|
2328
2376
|
name: "mouseover",
|
|
2329
2377
|
type: "google.maps.Data.MouseEvent",
|
|
2330
|
-
required: false
|
|
2378
|
+
required: false,
|
|
2379
|
+
description: "Fired when the mouse enters the area of a feature."
|
|
2331
2380
|
},
|
|
2332
2381
|
{
|
|
2333
2382
|
name: "mouseup",
|
|
2334
2383
|
type: "google.maps.Data.MouseEvent",
|
|
2335
|
-
required: false
|
|
2384
|
+
required: false,
|
|
2385
|
+
description: "Fired when the DOM mouseup event is fired on a feature."
|
|
2336
2386
|
},
|
|
2337
2387
|
{
|
|
2338
2388
|
name: "addfeature",
|
|
2339
2389
|
type: "google.maps.Data.AddFeatureEvent",
|
|
2340
|
-
required: false
|
|
2390
|
+
required: false,
|
|
2391
|
+
description: "Fired when a feature is added to the data layer."
|
|
2341
2392
|
},
|
|
2342
2393
|
{
|
|
2343
2394
|
name: "removefeature",
|
|
2344
2395
|
type: "google.maps.Data.RemoveFeatureEvent",
|
|
2345
|
-
required: false
|
|
2396
|
+
required: false,
|
|
2397
|
+
description: "Fired when a feature is removed from the data layer."
|
|
2346
2398
|
},
|
|
2347
2399
|
{
|
|
2348
2400
|
name: "setgeometry",
|
|
2349
2401
|
type: "google.maps.Data.SetGeometryEvent",
|
|
2350
|
-
required: false
|
|
2402
|
+
required: false,
|
|
2403
|
+
description: "Fired when a feature's geometry is set."
|
|
2351
2404
|
},
|
|
2352
2405
|
{
|
|
2353
2406
|
name: "setproperty",
|
|
2354
2407
|
type: "google.maps.Data.SetPropertyEvent",
|
|
2355
|
-
required: false
|
|
2408
|
+
required: false,
|
|
2409
|
+
description: "Fired when a feature's property is set."
|
|
2356
2410
|
},
|
|
2357
2411
|
{
|
|
2358
2412
|
name: "removeproperty",
|
|
2359
2413
|
type: "google.maps.Data.RemovePropertyEvent",
|
|
2360
|
-
required: false
|
|
2414
|
+
required: false,
|
|
2415
|
+
description: "Fired when a feature's property is removed."
|
|
2361
2416
|
}
|
|
2362
2417
|
],
|
|
2363
2418
|
ScriptGoogleMapsHeatmapLayerProps: [
|
|
2364
2419
|
{
|
|
2365
2420
|
name: "options",
|
|
2366
2421
|
type: "Omit<google.maps.visualization.HeatmapLayerOptions, 'map'>",
|
|
2367
|
-
required: false
|
|
2422
|
+
required: false,
|
|
2423
|
+
description: "Configuration options for the heatmap layer visualization."
|
|
2368
2424
|
}
|
|
2369
2425
|
],
|
|
2370
2426
|
ScriptGoogleMapsInfoWindowProps: [
|
|
2371
2427
|
{
|
|
2372
2428
|
name: "options",
|
|
2373
2429
|
type: "google.maps.InfoWindowOptions",
|
|
2374
|
-
required: false
|
|
2430
|
+
required: false,
|
|
2431
|
+
description: "Configuration options for the info window."
|
|
2375
2432
|
}
|
|
2376
2433
|
],
|
|
2377
2434
|
ScriptGoogleMapsInfoWindowEvents: [
|
|
2378
2435
|
{
|
|
2379
2436
|
name: "close",
|
|
2380
2437
|
type: "-",
|
|
2381
|
-
required: false
|
|
2438
|
+
required: false,
|
|
2439
|
+
description: "Fired when the info window is closed. Includes both user and programmatic close actions."
|
|
2382
2440
|
},
|
|
2383
2441
|
{
|
|
2384
2442
|
name: "closeclick",
|
|
2385
2443
|
type: "-",
|
|
2386
|
-
required: false
|
|
2444
|
+
required: false,
|
|
2445
|
+
description: "Fired when the close button is clicked."
|
|
2387
2446
|
},
|
|
2388
2447
|
{
|
|
2389
2448
|
name: "content_changed",
|
|
2390
2449
|
type: "-",
|
|
2391
|
-
required: false
|
|
2450
|
+
required: false,
|
|
2451
|
+
description: "Fired when the content of the info window changes."
|
|
2392
2452
|
},
|
|
2393
2453
|
{
|
|
2394
2454
|
name: "domready",
|
|
2395
2455
|
type: "-",
|
|
2396
|
-
required: false
|
|
2456
|
+
required: false,
|
|
2457
|
+
description: "Fired when the info window's `<div>` is attached to the DOM. Useful for computing dynamic content sizing."
|
|
2397
2458
|
},
|
|
2398
2459
|
{
|
|
2399
2460
|
name: "headercontent_changed",
|
|
2400
2461
|
type: "-",
|
|
2401
|
-
required: false
|
|
2462
|
+
required: false,
|
|
2463
|
+
description: "Fired when the header content of the info window changes."
|
|
2402
2464
|
},
|
|
2403
2465
|
{
|
|
2404
2466
|
name: "headerdisabled_changed",
|
|
2405
2467
|
type: "-",
|
|
2406
|
-
required: false
|
|
2468
|
+
required: false,
|
|
2469
|
+
description: "Fired when the header disabled state changes."
|
|
2407
2470
|
},
|
|
2408
2471
|
{
|
|
2409
2472
|
name: "position_changed",
|
|
2410
2473
|
type: "-",
|
|
2411
|
-
required: false
|
|
2474
|
+
required: false,
|
|
2475
|
+
description: "Fired when the info window position changes."
|
|
2412
2476
|
},
|
|
2413
2477
|
{
|
|
2414
2478
|
name: "visible",
|
|
2415
2479
|
type: "-",
|
|
2416
|
-
required: false
|
|
2480
|
+
required: false,
|
|
2481
|
+
description: "Fired when the info window becomes visible."
|
|
2417
2482
|
},
|
|
2418
2483
|
{
|
|
2419
2484
|
name: "zindex_changed",
|
|
2420
2485
|
type: "-",
|
|
2421
|
-
required: false
|
|
2486
|
+
required: false,
|
|
2487
|
+
description: "Fired when the z-index of the info window changes."
|
|
2422
2488
|
}
|
|
2423
2489
|
],
|
|
2424
2490
|
ScriptGoogleMapsMarkerProps: [
|
|
2425
2491
|
{
|
|
2426
2492
|
name: "position",
|
|
2427
2493
|
type: "google.maps.LatLngLiteral | google.maps.LatLng",
|
|
2428
|
-
required: false
|
|
2494
|
+
required: false,
|
|
2495
|
+
description: "The position of the marker on the map."
|
|
2429
2496
|
},
|
|
2430
2497
|
{
|
|
2431
2498
|
name: "options",
|
|
2432
2499
|
type: "Omit<google.maps.MarkerOptions, 'map'>",
|
|
2433
|
-
required: false
|
|
2500
|
+
required: false,
|
|
2501
|
+
description: "Configuration options for the legacy marker. Deprecated: use ScriptGoogleMapsAdvancedMarkerElement instead."
|
|
2434
2502
|
}
|
|
2435
2503
|
],
|
|
2436
2504
|
ScriptGoogleMapsMarkerEvents: [
|
|
2437
2505
|
{
|
|
2438
2506
|
name: "animation_changed",
|
|
2439
2507
|
type: "-",
|
|
2440
|
-
required: false
|
|
2508
|
+
required: false,
|
|
2509
|
+
description: "Fired when the marker's animation property changes."
|
|
2441
2510
|
},
|
|
2442
2511
|
{
|
|
2443
2512
|
name: "clickable_changed",
|
|
2444
2513
|
type: "-",
|
|
2445
|
-
required: false
|
|
2514
|
+
required: false,
|
|
2515
|
+
description: "Fired when the marker's clickable property changes."
|
|
2446
2516
|
},
|
|
2447
2517
|
{
|
|
2448
2518
|
name: "cursor_changed",
|
|
2449
2519
|
type: "-",
|
|
2450
|
-
required: false
|
|
2520
|
+
required: false,
|
|
2521
|
+
description: "Fired when the marker's cursor property changes."
|
|
2451
2522
|
},
|
|
2452
2523
|
{
|
|
2453
2524
|
name: "draggable_changed",
|
|
2454
2525
|
type: "-",
|
|
2455
|
-
required: false
|
|
2526
|
+
required: false,
|
|
2527
|
+
description: "Fired when the marker's draggable property changes."
|
|
2456
2528
|
},
|
|
2457
2529
|
{
|
|
2458
2530
|
name: "flat_changed",
|
|
2459
2531
|
type: "-",
|
|
2460
|
-
required: false
|
|
2532
|
+
required: false,
|
|
2533
|
+
description: "Fired when the marker's flat property changes."
|
|
2461
2534
|
},
|
|
2462
2535
|
{
|
|
2463
2536
|
name: "icon_changed",
|
|
2464
2537
|
type: "-",
|
|
2465
|
-
required: false
|
|
2538
|
+
required: false,
|
|
2539
|
+
description: "Fired when the marker's icon property changes."
|
|
2466
2540
|
},
|
|
2467
2541
|
{
|
|
2468
2542
|
name: "position_changed",
|
|
2469
2543
|
type: "-",
|
|
2470
|
-
required: false
|
|
2544
|
+
required: false,
|
|
2545
|
+
description: "Fired when the marker's position property changes."
|
|
2471
2546
|
},
|
|
2472
2547
|
{
|
|
2473
2548
|
name: "shape_changed",
|
|
2474
2549
|
type: "-",
|
|
2475
|
-
required: false
|
|
2550
|
+
required: false,
|
|
2551
|
+
description: "Fired when the marker's shape property changes."
|
|
2476
2552
|
},
|
|
2477
2553
|
{
|
|
2478
2554
|
name: "title_changed",
|
|
2479
2555
|
type: "-",
|
|
2480
|
-
required: false
|
|
2556
|
+
required: false,
|
|
2557
|
+
description: "Fired when the marker's title property changes."
|
|
2481
2558
|
},
|
|
2482
2559
|
{
|
|
2483
2560
|
name: "visible_changed",
|
|
2484
2561
|
type: "-",
|
|
2485
|
-
required: false
|
|
2562
|
+
required: false,
|
|
2563
|
+
description: "Fired when the marker's visible property changes."
|
|
2486
2564
|
},
|
|
2487
2565
|
{
|
|
2488
2566
|
name: "zindex_changed",
|
|
2489
2567
|
type: "-",
|
|
2490
|
-
required: false
|
|
2568
|
+
required: false,
|
|
2569
|
+
description: "Fired when the marker's zIndex property changes."
|
|
2491
2570
|
},
|
|
2492
2571
|
{
|
|
2493
2572
|
name: "click",
|
|
2494
2573
|
type: "google.maps.MapMouseEvent",
|
|
2495
|
-
required: false
|
|
2574
|
+
required: false,
|
|
2575
|
+
description: "Fired when the marker is clicked."
|
|
2496
2576
|
},
|
|
2497
2577
|
{
|
|
2498
2578
|
name: "contextmenu",
|
|
2499
2579
|
type: "google.maps.MapMouseEvent",
|
|
2500
|
-
required: false
|
|
2580
|
+
required: false,
|
|
2581
|
+
description: "Fired when the DOM contextmenu event is fired on the marker."
|
|
2501
2582
|
},
|
|
2502
2583
|
{
|
|
2503
2584
|
name: "dblclick",
|
|
2504
2585
|
type: "google.maps.MapMouseEvent",
|
|
2505
|
-
required: false
|
|
2586
|
+
required: false,
|
|
2587
|
+
description: "Fired when the marker is double clicked."
|
|
2506
2588
|
},
|
|
2507
2589
|
{
|
|
2508
2590
|
name: "drag",
|
|
2509
2591
|
type: "google.maps.MapMouseEvent",
|
|
2510
|
-
required: false
|
|
2592
|
+
required: false,
|
|
2593
|
+
description: "Fired repeatedly while the user drags the marker."
|
|
2511
2594
|
},
|
|
2512
2595
|
{
|
|
2513
2596
|
name: "dragend",
|
|
2514
2597
|
type: "google.maps.MapMouseEvent",
|
|
2515
|
-
required: false
|
|
2598
|
+
required: false,
|
|
2599
|
+
description: "Fired when the user stops dragging the marker."
|
|
2516
2600
|
},
|
|
2517
2601
|
{
|
|
2518
2602
|
name: "dragstart",
|
|
2519
2603
|
type: "google.maps.MapMouseEvent",
|
|
2520
|
-
required: false
|
|
2604
|
+
required: false,
|
|
2605
|
+
description: "Fired when the user starts dragging the marker."
|
|
2521
2606
|
},
|
|
2522
2607
|
{
|
|
2523
2608
|
name: "mousedown",
|
|
2524
2609
|
type: "google.maps.MapMouseEvent",
|
|
2525
|
-
required: false
|
|
2610
|
+
required: false,
|
|
2611
|
+
description: "Fired when the DOM mousedown event is fired on the marker."
|
|
2526
2612
|
},
|
|
2527
2613
|
{
|
|
2528
2614
|
name: "mouseout",
|
|
2529
2615
|
type: "google.maps.MapMouseEvent",
|
|
2530
|
-
required: false
|
|
2616
|
+
required: false,
|
|
2617
|
+
description: "Fired when the mouse leaves the area of the marker."
|
|
2531
2618
|
},
|
|
2532
2619
|
{
|
|
2533
2620
|
name: "mouseover",
|
|
2534
2621
|
type: "google.maps.MapMouseEvent",
|
|
2535
|
-
required: false
|
|
2622
|
+
required: false,
|
|
2623
|
+
description: "Fired when the mouse enters the area of the marker."
|
|
2536
2624
|
},
|
|
2537
2625
|
{
|
|
2538
2626
|
name: "mouseup",
|
|
2539
2627
|
type: "google.maps.MapMouseEvent",
|
|
2540
|
-
required: false
|
|
2628
|
+
required: false,
|
|
2629
|
+
description: "Fired when the DOM mouseup event is fired on the marker."
|
|
2541
2630
|
}
|
|
2542
2631
|
],
|
|
2543
2632
|
ScriptGoogleMapsMarkerClustererProps: [
|
|
2544
2633
|
{
|
|
2545
2634
|
name: "options",
|
|
2546
2635
|
type: "Omit<MarkerClustererOptions, 'map'>",
|
|
2547
|
-
required: false
|
|
2636
|
+
required: false,
|
|
2637
|
+
description: "Configuration options for the marker clusterer."
|
|
2548
2638
|
}
|
|
2549
2639
|
],
|
|
2550
2640
|
ScriptGoogleMapsMarkerClustererEvents: [
|
|
2551
2641
|
{
|
|
2552
2642
|
name: "click",
|
|
2553
2643
|
type: "MarkerClustererInstance",
|
|
2554
|
-
required: false
|
|
2644
|
+
required: false,
|
|
2645
|
+
description: "Fired when a cluster is clicked."
|
|
2555
2646
|
},
|
|
2556
2647
|
{
|
|
2557
2648
|
name: "clusteringbegin",
|
|
2558
2649
|
type: "MarkerClustererInstance",
|
|
2559
|
-
required: false
|
|
2650
|
+
required: false,
|
|
2651
|
+
description: "Fired when the clusterer begins clustering markers."
|
|
2560
2652
|
},
|
|
2561
2653
|
{
|
|
2562
2654
|
name: "clusteringend",
|
|
2563
2655
|
type: "MarkerClustererInstance",
|
|
2564
|
-
required: false
|
|
2656
|
+
required: false,
|
|
2657
|
+
description: "Fired when the clusterer finishes clustering markers."
|
|
2565
2658
|
}
|
|
2566
2659
|
],
|
|
2567
2660
|
ScriptGoogleMapsOverlayViewProps: [
|
|
2568
2661
|
{
|
|
2569
2662
|
name: "position",
|
|
2570
2663
|
type: "google.maps.LatLngLiteral",
|
|
2571
|
-
required: false
|
|
2664
|
+
required: false,
|
|
2665
|
+
description: "Geographic position for the overlay. Falls back to parent marker position if omitted."
|
|
2572
2666
|
},
|
|
2573
2667
|
{
|
|
2574
2668
|
name: "anchor",
|
|
2575
2669
|
type: "OverlayAnchor",
|
|
2576
|
-
required: false
|
|
2670
|
+
required: false,
|
|
2671
|
+
description: "Anchor point of the overlay relative to its position.",
|
|
2672
|
+
defaultValue: "'bottom-center'"
|
|
2577
2673
|
},
|
|
2578
2674
|
{
|
|
2579
2675
|
name: "offset",
|
|
2580
2676
|
type: "{ x: number, y: number }",
|
|
2581
|
-
required: false
|
|
2677
|
+
required: false,
|
|
2678
|
+
description: "Pixel offset from the anchor position."
|
|
2582
2679
|
},
|
|
2583
2680
|
{
|
|
2584
2681
|
name: "pane",
|
|
2585
2682
|
type: "OverlayPane",
|
|
2586
|
-
required: false
|
|
2683
|
+
required: false,
|
|
2684
|
+
description: "The map pane on which to render the overlay.",
|
|
2685
|
+
defaultValue: "'floatPane'"
|
|
2587
2686
|
},
|
|
2588
2687
|
{
|
|
2589
2688
|
name: "zIndex",
|
|
2590
2689
|
type: "number",
|
|
2591
|
-
required: false
|
|
2690
|
+
required: false,
|
|
2691
|
+
description: "CSS z-index for the overlay element."
|
|
2592
2692
|
},
|
|
2593
2693
|
{
|
|
2594
2694
|
name: "blockMapInteraction",
|
|
2595
2695
|
type: "boolean",
|
|
2596
|
-
required: false
|
|
2696
|
+
required: false,
|
|
2697
|
+
description: "Whether to block map click and gesture events from passing through the overlay.",
|
|
2698
|
+
defaultValue: "true"
|
|
2597
2699
|
},
|
|
2598
2700
|
{
|
|
2599
2701
|
name: "v-model:open",
|
|
@@ -2605,226 +2707,270 @@ const schemaFields = {
|
|
|
2605
2707
|
{
|
|
2606
2708
|
name: "options",
|
|
2607
2709
|
type: "Omit<google.maps.marker.PinElementOptions, 'map'>",
|
|
2608
|
-
required: false
|
|
2710
|
+
required: false,
|
|
2711
|
+
description: "Configuration options for the pin element that customizes the visual appearance of the marker."
|
|
2609
2712
|
}
|
|
2610
2713
|
],
|
|
2611
2714
|
ScriptGoogleMapsPolygonProps: [
|
|
2612
2715
|
{
|
|
2613
2716
|
name: "options",
|
|
2614
2717
|
type: "Omit<google.maps.PolygonOptions, 'map'>",
|
|
2615
|
-
required: false
|
|
2718
|
+
required: false,
|
|
2719
|
+
description: "Configuration options for the polygon overlay."
|
|
2616
2720
|
}
|
|
2617
2721
|
],
|
|
2618
2722
|
ScriptGoogleMapsPolygonEvents: [
|
|
2619
2723
|
{
|
|
2620
2724
|
name: "click",
|
|
2621
2725
|
type: "google.maps.PolyMouseEvent",
|
|
2622
|
-
required: false
|
|
2726
|
+
required: false,
|
|
2727
|
+
description: "Fired when the polygon is clicked."
|
|
2623
2728
|
},
|
|
2624
2729
|
{
|
|
2625
2730
|
name: "contextmenu",
|
|
2626
2731
|
type: "google.maps.PolyMouseEvent",
|
|
2627
|
-
required: false
|
|
2732
|
+
required: false,
|
|
2733
|
+
description: "Fired when the DOM contextmenu event is fired on the polygon."
|
|
2628
2734
|
},
|
|
2629
2735
|
{
|
|
2630
2736
|
name: "dblclick",
|
|
2631
2737
|
type: "google.maps.PolyMouseEvent",
|
|
2632
|
-
required: false
|
|
2738
|
+
required: false,
|
|
2739
|
+
description: "Fired when the polygon is double clicked."
|
|
2633
2740
|
},
|
|
2634
2741
|
{
|
|
2635
2742
|
name: "mousedown",
|
|
2636
2743
|
type: "google.maps.PolyMouseEvent",
|
|
2637
|
-
required: false
|
|
2744
|
+
required: false,
|
|
2745
|
+
description: "Fired when the DOM mousedown event is fired on the polygon."
|
|
2638
2746
|
},
|
|
2639
2747
|
{
|
|
2640
2748
|
name: "mousemove",
|
|
2641
2749
|
type: "google.maps.PolyMouseEvent",
|
|
2642
|
-
required: false
|
|
2750
|
+
required: false,
|
|
2751
|
+
description: "Fired when the DOM mousemove event is fired on the polygon."
|
|
2643
2752
|
},
|
|
2644
2753
|
{
|
|
2645
2754
|
name: "mouseout",
|
|
2646
2755
|
type: "google.maps.PolyMouseEvent",
|
|
2647
|
-
required: false
|
|
2756
|
+
required: false,
|
|
2757
|
+
description: "Fired when the mouse leaves the area of the polygon."
|
|
2648
2758
|
},
|
|
2649
2759
|
{
|
|
2650
2760
|
name: "mouseover",
|
|
2651
2761
|
type: "google.maps.PolyMouseEvent",
|
|
2652
|
-
required: false
|
|
2762
|
+
required: false,
|
|
2763
|
+
description: "Fired when the mouse enters the area of the polygon."
|
|
2653
2764
|
},
|
|
2654
2765
|
{
|
|
2655
2766
|
name: "mouseup",
|
|
2656
2767
|
type: "google.maps.PolyMouseEvent",
|
|
2657
|
-
required: false
|
|
2768
|
+
required: false,
|
|
2769
|
+
description: "Fired when the DOM mouseup event is fired on the polygon."
|
|
2658
2770
|
},
|
|
2659
2771
|
{
|
|
2660
2772
|
name: "drag",
|
|
2661
2773
|
type: "google.maps.MapMouseEvent",
|
|
2662
|
-
required: false
|
|
2774
|
+
required: false,
|
|
2775
|
+
description: "Fired repeatedly while the user drags the polygon."
|
|
2663
2776
|
},
|
|
2664
2777
|
{
|
|
2665
2778
|
name: "dragend",
|
|
2666
2779
|
type: "google.maps.MapMouseEvent",
|
|
2667
|
-
required: false
|
|
2780
|
+
required: false,
|
|
2781
|
+
description: "Fired when the user stops dragging the polygon."
|
|
2668
2782
|
},
|
|
2669
2783
|
{
|
|
2670
2784
|
name: "dragstart",
|
|
2671
2785
|
type: "google.maps.MapMouseEvent",
|
|
2672
|
-
required: false
|
|
2786
|
+
required: false,
|
|
2787
|
+
description: "Fired when the user starts dragging the polygon."
|
|
2673
2788
|
}
|
|
2674
2789
|
],
|
|
2675
2790
|
ScriptGoogleMapsPolylineProps: [
|
|
2676
2791
|
{
|
|
2677
2792
|
name: "options",
|
|
2678
2793
|
type: "Omit<google.maps.PolylineOptions, 'map'>",
|
|
2679
|
-
required: false
|
|
2794
|
+
required: false,
|
|
2795
|
+
description: "Configuration options for the polyline overlay."
|
|
2680
2796
|
}
|
|
2681
2797
|
],
|
|
2682
2798
|
ScriptGoogleMapsPolylineEvents: [
|
|
2683
2799
|
{
|
|
2684
2800
|
name: "click",
|
|
2685
2801
|
type: "google.maps.PolyMouseEvent",
|
|
2686
|
-
required: false
|
|
2802
|
+
required: false,
|
|
2803
|
+
description: "Fired when the polyline is clicked."
|
|
2687
2804
|
},
|
|
2688
2805
|
{
|
|
2689
2806
|
name: "contextmenu",
|
|
2690
2807
|
type: "google.maps.PolyMouseEvent",
|
|
2691
|
-
required: false
|
|
2808
|
+
required: false,
|
|
2809
|
+
description: "Fired when the DOM contextmenu event is fired on the polyline."
|
|
2692
2810
|
},
|
|
2693
2811
|
{
|
|
2694
2812
|
name: "dblclick",
|
|
2695
2813
|
type: "google.maps.PolyMouseEvent",
|
|
2696
|
-
required: false
|
|
2814
|
+
required: false,
|
|
2815
|
+
description: "Fired when the polyline is double clicked."
|
|
2697
2816
|
},
|
|
2698
2817
|
{
|
|
2699
2818
|
name: "mousedown",
|
|
2700
2819
|
type: "google.maps.PolyMouseEvent",
|
|
2701
|
-
required: false
|
|
2820
|
+
required: false,
|
|
2821
|
+
description: "Fired when the DOM mousedown event is fired on the polyline."
|
|
2702
2822
|
},
|
|
2703
2823
|
{
|
|
2704
2824
|
name: "mousemove",
|
|
2705
2825
|
type: "google.maps.PolyMouseEvent",
|
|
2706
|
-
required: false
|
|
2826
|
+
required: false,
|
|
2827
|
+
description: "Fired when the DOM mousemove event is fired on the polyline."
|
|
2707
2828
|
},
|
|
2708
2829
|
{
|
|
2709
2830
|
name: "mouseout",
|
|
2710
2831
|
type: "google.maps.PolyMouseEvent",
|
|
2711
|
-
required: false
|
|
2832
|
+
required: false,
|
|
2833
|
+
description: "Fired when the mouse leaves the area of the polyline."
|
|
2712
2834
|
},
|
|
2713
2835
|
{
|
|
2714
2836
|
name: "mouseover",
|
|
2715
2837
|
type: "google.maps.PolyMouseEvent",
|
|
2716
|
-
required: false
|
|
2838
|
+
required: false,
|
|
2839
|
+
description: "Fired when the mouse enters the area of the polyline."
|
|
2717
2840
|
},
|
|
2718
2841
|
{
|
|
2719
2842
|
name: "mouseup",
|
|
2720
2843
|
type: "google.maps.PolyMouseEvent",
|
|
2721
|
-
required: false
|
|
2844
|
+
required: false,
|
|
2845
|
+
description: "Fired when the DOM mouseup event is fired on the polyline."
|
|
2722
2846
|
},
|
|
2723
2847
|
{
|
|
2724
2848
|
name: "drag",
|
|
2725
2849
|
type: "google.maps.MapMouseEvent",
|
|
2726
|
-
required: false
|
|
2850
|
+
required: false,
|
|
2851
|
+
description: "Fired repeatedly while the user drags the polyline."
|
|
2727
2852
|
},
|
|
2728
2853
|
{
|
|
2729
2854
|
name: "dragend",
|
|
2730
2855
|
type: "google.maps.MapMouseEvent",
|
|
2731
|
-
required: false
|
|
2856
|
+
required: false,
|
|
2857
|
+
description: "Fired when the user stops dragging the polyline."
|
|
2732
2858
|
},
|
|
2733
2859
|
{
|
|
2734
2860
|
name: "dragstart",
|
|
2735
2861
|
type: "google.maps.MapMouseEvent",
|
|
2736
|
-
required: false
|
|
2862
|
+
required: false,
|
|
2863
|
+
description: "Fired when the user starts dragging the polyline."
|
|
2737
2864
|
}
|
|
2738
2865
|
],
|
|
2739
2866
|
ScriptGoogleMapsRectangleProps: [
|
|
2740
2867
|
{
|
|
2741
2868
|
name: "options",
|
|
2742
2869
|
type: "Omit<google.maps.RectangleOptions, 'map'>",
|
|
2743
|
-
required: false
|
|
2870
|
+
required: false,
|
|
2871
|
+
description: "Configuration options for the rectangle overlay."
|
|
2744
2872
|
}
|
|
2745
2873
|
],
|
|
2746
2874
|
ScriptGoogleMapsRectangleEvents: [
|
|
2747
2875
|
{
|
|
2748
2876
|
name: "bounds_changed",
|
|
2749
2877
|
type: "-",
|
|
2750
|
-
required: false
|
|
2878
|
+
required: false,
|
|
2879
|
+
description: "Fired when the rectangle's bounds are changed."
|
|
2751
2880
|
},
|
|
2752
2881
|
{
|
|
2753
2882
|
name: "click",
|
|
2754
2883
|
type: "google.maps.MapMouseEvent",
|
|
2755
|
-
required: false
|
|
2884
|
+
required: false,
|
|
2885
|
+
description: "Fired when the rectangle is clicked."
|
|
2756
2886
|
},
|
|
2757
2887
|
{
|
|
2758
2888
|
name: "contextmenu",
|
|
2759
2889
|
type: "google.maps.MapMouseEvent",
|
|
2760
|
-
required: false
|
|
2890
|
+
required: false,
|
|
2891
|
+
description: "Fired when the DOM contextmenu event is fired on the rectangle."
|
|
2761
2892
|
},
|
|
2762
2893
|
{
|
|
2763
2894
|
name: "dblclick",
|
|
2764
2895
|
type: "google.maps.MapMouseEvent",
|
|
2765
|
-
required: false
|
|
2896
|
+
required: false,
|
|
2897
|
+
description: "Fired when the rectangle is double clicked."
|
|
2766
2898
|
},
|
|
2767
2899
|
{
|
|
2768
2900
|
name: "drag",
|
|
2769
2901
|
type: "google.maps.MapMouseEvent",
|
|
2770
|
-
required: false
|
|
2902
|
+
required: false,
|
|
2903
|
+
description: "Fired repeatedly while the user drags the rectangle."
|
|
2771
2904
|
},
|
|
2772
2905
|
{
|
|
2773
2906
|
name: "dragend",
|
|
2774
2907
|
type: "google.maps.MapMouseEvent",
|
|
2775
|
-
required: false
|
|
2908
|
+
required: false,
|
|
2909
|
+
description: "Fired when the user stops dragging the rectangle."
|
|
2776
2910
|
},
|
|
2777
2911
|
{
|
|
2778
2912
|
name: "dragstart",
|
|
2779
2913
|
type: "google.maps.MapMouseEvent",
|
|
2780
|
-
required: false
|
|
2914
|
+
required: false,
|
|
2915
|
+
description: "Fired when the user starts dragging the rectangle."
|
|
2781
2916
|
},
|
|
2782
2917
|
{
|
|
2783
2918
|
name: "mousedown",
|
|
2784
2919
|
type: "google.maps.MapMouseEvent",
|
|
2785
|
-
required: false
|
|
2920
|
+
required: false,
|
|
2921
|
+
description: "Fired when the DOM mousedown event is fired on the rectangle."
|
|
2786
2922
|
},
|
|
2787
2923
|
{
|
|
2788
2924
|
name: "mousemove",
|
|
2789
2925
|
type: "google.maps.MapMouseEvent",
|
|
2790
|
-
required: false
|
|
2926
|
+
required: false,
|
|
2927
|
+
description: "Fired when the DOM mousemove event is fired on the rectangle."
|
|
2791
2928
|
},
|
|
2792
2929
|
{
|
|
2793
2930
|
name: "mouseout",
|
|
2794
2931
|
type: "google.maps.MapMouseEvent",
|
|
2795
|
-
required: false
|
|
2932
|
+
required: false,
|
|
2933
|
+
description: "Fired when the mouse leaves the area of the rectangle."
|
|
2796
2934
|
},
|
|
2797
2935
|
{
|
|
2798
2936
|
name: "mouseover",
|
|
2799
2937
|
type: "google.maps.MapMouseEvent",
|
|
2800
|
-
required: false
|
|
2938
|
+
required: false,
|
|
2939
|
+
description: "Fired when the mouse enters the area of the rectangle."
|
|
2801
2940
|
},
|
|
2802
2941
|
{
|
|
2803
2942
|
name: "mouseup",
|
|
2804
2943
|
type: "google.maps.MapMouseEvent",
|
|
2805
|
-
required: false
|
|
2944
|
+
required: false,
|
|
2945
|
+
description: "Fired when the DOM mouseup event is fired on the rectangle."
|
|
2806
2946
|
}
|
|
2807
2947
|
],
|
|
2808
2948
|
ScriptBlueskyEmbedProps: [
|
|
2809
2949
|
{
|
|
2810
2950
|
name: "postUrl",
|
|
2811
2951
|
type: "string",
|
|
2812
|
-
required: true
|
|
2952
|
+
required: true,
|
|
2953
|
+
description: "The Bluesky post URL to embed"
|
|
2813
2954
|
},
|
|
2814
2955
|
{
|
|
2815
2956
|
name: "apiEndpoint",
|
|
2816
2957
|
type: "string",
|
|
2817
|
-
required: false
|
|
2958
|
+
required: false,
|
|
2959
|
+
description: "Custom API endpoint for fetching post data",
|
|
2960
|
+
defaultValue: "'/_scripts/embed/bluesky'"
|
|
2818
2961
|
},
|
|
2819
2962
|
{
|
|
2820
2963
|
name: "imageProxyEndpoint",
|
|
2821
2964
|
type: "string",
|
|
2822
|
-
required: false
|
|
2965
|
+
required: false,
|
|
2966
|
+
description: "Custom image proxy endpoint",
|
|
2967
|
+
defaultValue: "'/_scripts/embed/bluesky-image'"
|
|
2823
2968
|
},
|
|
2824
2969
|
{
|
|
2825
2970
|
name: "rootAttrs",
|
|
2826
2971
|
type: "HTMLAttributes",
|
|
2827
|
-
required: false
|
|
2972
|
+
required: false,
|
|
2973
|
+
description: "Root element attributes"
|
|
2828
2974
|
}
|
|
2829
2975
|
],
|
|
2830
2976
|
ScriptCarbonAdsProps: [
|
|
@@ -2846,7 +2992,8 @@ const schemaFields = {
|
|
|
2846
2992
|
{
|
|
2847
2993
|
name: "trigger",
|
|
2848
2994
|
type: "ElementScriptTrigger",
|
|
2849
|
-
required: false
|
|
2995
|
+
required: false,
|
|
2996
|
+
description: "Defines the trigger event to load the script."
|
|
2850
2997
|
}
|
|
2851
2998
|
],
|
|
2852
2999
|
ScriptCarbonAdsEvents: [
|
|
@@ -2865,7 +3012,8 @@ const schemaFields = {
|
|
|
2865
3012
|
{
|
|
2866
3013
|
name: "trigger",
|
|
2867
3014
|
type: "ElementScriptTrigger",
|
|
2868
|
-
required: false
|
|
3015
|
+
required: false,
|
|
3016
|
+
description: "Defines the trigger event to load the script."
|
|
2869
3017
|
},
|
|
2870
3018
|
{
|
|
2871
3019
|
name: "id",
|
|
@@ -2934,7 +3082,8 @@ const schemaFields = {
|
|
|
2934
3082
|
{
|
|
2935
3083
|
name: "trigger",
|
|
2936
3084
|
type: "ElementScriptTrigger",
|
|
2937
|
-
required: false
|
|
3085
|
+
required: false,
|
|
3086
|
+
description: "Defines the trigger event to load the script."
|
|
2938
3087
|
}
|
|
2939
3088
|
],
|
|
2940
3089
|
ScriptGoogleAdsenseEvents: [
|
|
@@ -2953,22 +3102,28 @@ const schemaFields = {
|
|
|
2953
3102
|
{
|
|
2954
3103
|
name: "postUrl",
|
|
2955
3104
|
type: "string",
|
|
2956
|
-
required: true
|
|
3105
|
+
required: true,
|
|
3106
|
+
description: "The Instagram post URL to embed e.g., https://www.instagram.com/p/ABC123/"
|
|
2957
3107
|
},
|
|
2958
3108
|
{
|
|
2959
3109
|
name: "captions",
|
|
2960
3110
|
type: "boolean",
|
|
2961
|
-
required: false
|
|
3111
|
+
required: false,
|
|
3112
|
+
description: "Whether to include captions in the embed",
|
|
3113
|
+
defaultValue: "true"
|
|
2962
3114
|
},
|
|
2963
3115
|
{
|
|
2964
3116
|
name: "apiEndpoint",
|
|
2965
3117
|
type: "string",
|
|
2966
|
-
required: false
|
|
3118
|
+
required: false,
|
|
3119
|
+
description: "Custom API endpoint for fetching embed HTML",
|
|
3120
|
+
defaultValue: "'/_scripts/embed/instagram'"
|
|
2967
3121
|
},
|
|
2968
3122
|
{
|
|
2969
3123
|
name: "rootAttrs",
|
|
2970
3124
|
type: "HTMLAttributes",
|
|
2971
|
-
required: false
|
|
3125
|
+
required: false,
|
|
3126
|
+
description: "Root element attributes"
|
|
2972
3127
|
}
|
|
2973
3128
|
],
|
|
2974
3129
|
ScriptIntercomProps: [
|
|
@@ -3015,7 +3170,8 @@ const schemaFields = {
|
|
|
3015
3170
|
{
|
|
3016
3171
|
name: "trigger",
|
|
3017
3172
|
type: "ElementScriptTrigger",
|
|
3018
|
-
required: false
|
|
3173
|
+
required: false,
|
|
3174
|
+
description: "Defines the trigger event to load the script."
|
|
3019
3175
|
}
|
|
3020
3176
|
],
|
|
3021
3177
|
ScriptIntercomEvents: [
|
|
@@ -3053,52 +3209,63 @@ const schemaFields = {
|
|
|
3053
3209
|
{
|
|
3054
3210
|
name: "rootAttrs",
|
|
3055
3211
|
type: "HTMLAttributes & ReservedProps & Record<string, unknown>",
|
|
3056
|
-
required: false
|
|
3212
|
+
required: false,
|
|
3213
|
+
description: "Customize the root element attributes."
|
|
3057
3214
|
},
|
|
3058
3215
|
{
|
|
3059
3216
|
name: "trigger",
|
|
3060
3217
|
type: "ElementScriptTrigger",
|
|
3061
|
-
required: false
|
|
3218
|
+
required: false,
|
|
3219
|
+
description: "Defines the trigger event to load the script."
|
|
3062
3220
|
},
|
|
3063
3221
|
{
|
|
3064
3222
|
name: "clientId",
|
|
3065
3223
|
type: "string",
|
|
3066
|
-
required: false
|
|
3224
|
+
required: false,
|
|
3225
|
+
description: "Client ID or client token for PayPal SDK v6 authentication."
|
|
3067
3226
|
},
|
|
3068
3227
|
{
|
|
3069
3228
|
name: "clientToken",
|
|
3070
3229
|
type: "string",
|
|
3071
|
-
required: false
|
|
3230
|
+
required: false,
|
|
3231
|
+
description: "Server-generated client token for SDK v6."
|
|
3072
3232
|
},
|
|
3073
3233
|
{
|
|
3074
3234
|
name: "components",
|
|
3075
3235
|
type: "Components[]",
|
|
3076
|
-
required: false
|
|
3236
|
+
required: false,
|
|
3237
|
+
description: "The v6 SDK components to load.",
|
|
3238
|
+
defaultValue: "['paypal-payments']"
|
|
3077
3239
|
},
|
|
3078
3240
|
{
|
|
3079
3241
|
name: "pageType",
|
|
3080
3242
|
type: "PageTypes",
|
|
3081
|
-
required: false
|
|
3243
|
+
required: false,
|
|
3244
|
+
description: "The page type context hint."
|
|
3082
3245
|
},
|
|
3083
3246
|
{
|
|
3084
3247
|
name: "locale",
|
|
3085
3248
|
type: "string",
|
|
3086
|
-
required: false
|
|
3249
|
+
required: false,
|
|
3250
|
+
description: "The locale for the SDK (BCP-47 code)."
|
|
3087
3251
|
},
|
|
3088
3252
|
{
|
|
3089
3253
|
name: "merchantId",
|
|
3090
3254
|
type: "string | string[]",
|
|
3091
|
-
required: false
|
|
3255
|
+
required: false,
|
|
3256
|
+
description: "The merchant ID(s)."
|
|
3092
3257
|
},
|
|
3093
3258
|
{
|
|
3094
3259
|
name: "partnerAttributionId",
|
|
3095
3260
|
type: "string",
|
|
3096
|
-
required: false
|
|
3261
|
+
required: false,
|
|
3262
|
+
description: "Partner attribution ID for revenue sharing."
|
|
3097
3263
|
},
|
|
3098
3264
|
{
|
|
3099
3265
|
name: "paypalScriptOptions",
|
|
3100
3266
|
type: "Partial<PayPalInput>",
|
|
3101
|
-
required: false
|
|
3267
|
+
required: false,
|
|
3268
|
+
description: "The paypal script options."
|
|
3102
3269
|
}
|
|
3103
3270
|
],
|
|
3104
3271
|
ScriptPayPalButtonsEvents: [
|
|
@@ -3117,52 +3284,62 @@ const schemaFields = {
|
|
|
3117
3284
|
{
|
|
3118
3285
|
name: "rootAttrs",
|
|
3119
3286
|
type: "HTMLAttributes & ReservedProps & Record<string, unknown>",
|
|
3120
|
-
required: false
|
|
3287
|
+
required: false,
|
|
3288
|
+
description: "Customize the root element attributes."
|
|
3121
3289
|
},
|
|
3122
3290
|
{
|
|
3123
3291
|
name: "trigger",
|
|
3124
3292
|
type: "ElementScriptTrigger",
|
|
3125
|
-
required: false
|
|
3293
|
+
required: false,
|
|
3294
|
+
description: "Defines the trigger event to load the script."
|
|
3126
3295
|
},
|
|
3127
3296
|
{
|
|
3128
3297
|
name: "clientId",
|
|
3129
3298
|
type: "string",
|
|
3130
|
-
required: false
|
|
3299
|
+
required: false,
|
|
3300
|
+
description: "Client ID or client token for PayPal SDK v6 authentication."
|
|
3131
3301
|
},
|
|
3132
3302
|
{
|
|
3133
3303
|
name: "clientToken",
|
|
3134
3304
|
type: "string",
|
|
3135
|
-
required: false
|
|
3305
|
+
required: false,
|
|
3306
|
+
description: "Server-generated client token for SDK v6."
|
|
3136
3307
|
},
|
|
3137
3308
|
{
|
|
3138
3309
|
name: "merchantId",
|
|
3139
3310
|
type: "string | string[]",
|
|
3140
|
-
required: false
|
|
3311
|
+
required: false,
|
|
3312
|
+
description: "The merchant ID for the paypal script."
|
|
3141
3313
|
},
|
|
3142
3314
|
{
|
|
3143
3315
|
name: "partnerAttributionId",
|
|
3144
3316
|
type: "string",
|
|
3145
|
-
required: false
|
|
3317
|
+
required: false,
|
|
3318
|
+
description: "The partner attribution ID."
|
|
3146
3319
|
},
|
|
3147
3320
|
{
|
|
3148
3321
|
name: "pageType",
|
|
3149
3322
|
type: "PageTypes",
|
|
3150
|
-
required: false
|
|
3323
|
+
required: false,
|
|
3324
|
+
description: "The page type context hint."
|
|
3151
3325
|
},
|
|
3152
3326
|
{
|
|
3153
3327
|
name: "locale",
|
|
3154
3328
|
type: "string",
|
|
3155
|
-
required: false
|
|
3329
|
+
required: false,
|
|
3330
|
+
description: "The locale for the SDK (BCP-47 code)."
|
|
3156
3331
|
},
|
|
3157
3332
|
{
|
|
3158
3333
|
name: "messagesOptions",
|
|
3159
3334
|
type: "PayPalMessagesOptions",
|
|
3160
|
-
required: false
|
|
3335
|
+
required: false,
|
|
3336
|
+
description: "Options for the PayPal Messages session."
|
|
3161
3337
|
},
|
|
3162
3338
|
{
|
|
3163
3339
|
name: "paypalScriptOptions",
|
|
3164
3340
|
type: "Partial<PayPalInput>",
|
|
3165
|
-
required: false
|
|
3341
|
+
required: false,
|
|
3342
|
+
description: "The paypal script options."
|
|
3166
3343
|
}
|
|
3167
3344
|
],
|
|
3168
3345
|
ScriptPayPalMessagesEvents: [
|
|
@@ -3265,29 +3442,37 @@ const schemaFields = {
|
|
|
3265
3442
|
{
|
|
3266
3443
|
name: "placeholderObjectFit",
|
|
3267
3444
|
type: "'cover' | 'contain' | 'fill' | 'none' | 'scale-down'",
|
|
3268
|
-
required: false
|
|
3445
|
+
required: false,
|
|
3446
|
+
description: "Object-fit for the placeholder image.",
|
|
3447
|
+
defaultValue: "'contain'"
|
|
3269
3448
|
}
|
|
3270
3449
|
],
|
|
3271
3450
|
ScriptXEmbedProps: [
|
|
3272
3451
|
{
|
|
3273
3452
|
name: "tweetId",
|
|
3274
3453
|
type: "string",
|
|
3275
|
-
required: true
|
|
3454
|
+
required: true,
|
|
3455
|
+
description: "The tweet ID to embed"
|
|
3276
3456
|
},
|
|
3277
3457
|
{
|
|
3278
3458
|
name: "apiEndpoint",
|
|
3279
3459
|
type: "string",
|
|
3280
|
-
required: false
|
|
3460
|
+
required: false,
|
|
3461
|
+
description: "Custom API endpoint for fetching tweet data",
|
|
3462
|
+
defaultValue: "'/_scripts/embed/x'"
|
|
3281
3463
|
},
|
|
3282
3464
|
{
|
|
3283
3465
|
name: "imageProxyEndpoint",
|
|
3284
3466
|
type: "string",
|
|
3285
|
-
required: false
|
|
3467
|
+
required: false,
|
|
3468
|
+
description: "Custom image proxy endpoint",
|
|
3469
|
+
defaultValue: "'/_scripts/embed/x-image'"
|
|
3286
3470
|
},
|
|
3287
3471
|
{
|
|
3288
3472
|
name: "rootAttrs",
|
|
3289
3473
|
type: "HTMLAttributes",
|
|
3290
|
-
required: false
|
|
3474
|
+
required: false,
|
|
3475
|
+
description: "Root element attributes"
|
|
3291
3476
|
}
|
|
3292
3477
|
],
|
|
3293
3478
|
ScriptYouTubePlayerProps: [
|
|
@@ -3339,7 +3524,9 @@ const schemaFields = {
|
|
|
3339
3524
|
{
|
|
3340
3525
|
name: "cookies",
|
|
3341
3526
|
type: "boolean",
|
|
3342
|
-
required: false
|
|
3527
|
+
required: false,
|
|
3528
|
+
description: "Whether to use youtube-nocookie.com for embedding.",
|
|
3529
|
+
defaultValue: "false"
|
|
3343
3530
|
},
|
|
3344
3531
|
{
|
|
3345
3532
|
name: "playerOptions",
|
|
@@ -3359,7 +3546,9 @@ const schemaFields = {
|
|
|
3359
3546
|
{
|
|
3360
3547
|
name: "placeholderObjectFit",
|
|
3361
3548
|
type: "'cover' | 'contain' | 'fill' | 'none' | 'scale-down'",
|
|
3362
|
-
required: false
|
|
3549
|
+
required: false,
|
|
3550
|
+
description: "Object-fit for the placeholder image.",
|
|
3551
|
+
defaultValue: "'cover'"
|
|
3363
3552
|
}
|
|
3364
3553
|
],
|
|
3365
3554
|
ScriptYouTubePlayerEvents: [
|