@feltmaps/js-sdk 1.7.0-next.10 → 1.7.0-next.12

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.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { z as zInfer, U as UiControlsOptions, V as ViewportCenterZoom, F as FeltController } from './controller-Dfbw7Li5.cjs';
2
- export { au as AggregatedGridConfig, av as AggregationConfig, aw as AggregationMethod, C as CircleElementCreate, a as CircleElementRead, b as CircleElementUpdate, b8 as CircleToolSettings, b9 as ConfigurableToolType, ax as CountGridConfig, bp as CreateActionTriggerParams, K as CreateLayersFromGeoJsonParams, bq as CreatePanelElementsParams, br as CreatePanelParams, O as DataOnlyLayer, bs as DeletePanelElementsParams, E as Element, c as ElementChangeCallbackParams, d as ElementCreate, e as ElementGroup, f as ElementGroupChangeCallbackParams, aM as ElementGroupNode, aN as ElementNode, g as ElementUpdate, B as ElementsController, aO as EntityNode, aP as FeatureNode, aQ as FeatureSelection, aU as FeltBoundary, Q as FeltTiledVectorSource, aV as FeltZoom, an as FilterExpression, ao as FilterLogicGate, ap as FilterTernary, aq as Filters, R as GeoJsonDataVectorSource, aW as GeoJsonFeature, S as GeoJsonFileVectorSource, aX as GeoJsonGeometry, aY as GeoJsonProperties, W as GeoJsonUrlVectorSource, ar as GeometryFilter, G as GetElementGroupsConstraint, h as GetElementsConstraint, ay as GetLayerCalculationParams, az as GetLayerCategoriesGroup, aA as GetLayerCategoriesParams, X as GetLayerGroupsConstraint, aB as GetLayerHistogramBin, aC as GetLayerHistogramParams, aD as GetLayerPrecomputedCalculationParams, Y as GetLayersConstraint, Z as GetRenderedFeaturesConstraint, aE as GridConfig, aF as GridType, H as HighlighterElementCreate, i as HighlighterElementRead, j as HighlighterElementUpdate, ba as HighlighterToolSettings, I as ImageElementCreate, k as ImageElementRead, l as ImageElementUpdate, bb as InputToolSettings, J as InteractionsController, aZ as LatLng, _ as Layer, as as LayerBoundaries, $ as LayerChangeCallbackParams, a0 as LayerCommon, ad as LayerFeature, at as LayerFilters, a1 as LayerGroup, a2 as LayerGroupChangeCallbackParams, aR as LayerGroupNode, aS as LayerNode, a3 as LayerProcessingStatus, af as LayerSchema, ag as LayerSchemaAttribute, ah as LayerSchemaBooleanAttribute, ai as LayerSchemaCommonAttribute, aj as LayerSchemaDateAttribute, ak as LayerSchemaDateTimeAttribute, al as LayerSchemaNumericAttribute, am as LayerSchemaTextAttribute, aJ as LayersController, a4 as LegendItem, a5 as LegendItemChangeCallbackParams, a6 as LegendItemIdentifier, a7 as LegendItemsConstraint, a_ as LineStringGeometry, bc as LineToolSettings, L as LinkElementRead, a$ as LngLatTuple, aK as MapDetails, D as MapInteractionEvent, M as MarkerElementCreate, m as MarkerElementRead, n as MarkerElementUpdate, bd as MarkerToolSettings, aL as MiscController, aG as MultiAggregationConfig, b0 as MultiLineStringGeometry, b1 as MultiPointGeometry, b2 as MultiPolygonGeometry, N as NoteElementCreate, o as NoteElementRead, p as NoteElementUpdate, be as NoteToolSettings, bt as OnMapInteractionsOptions, P as PathElementCreate, q as PathElementRead, r as PathElementUpdate, bf as PinToolSettings, s as PlaceElementCreate, t as PlaceElementRead, u as PlaceElementUpdate, bg as PlaceFrame, bh as PlaceSymbol, bx as PlacementForUIElement, b3 as PointGeometry, v as PolygonElementCreate, w as PolygonElementRead, x as PolygonElementUpdate, b4 as PolygonGeometry, bi as PolygonToolSettings, aH as PrecomputedAggregationMethod, a8 as RasterBand, a9 as RasterLayer, aa as RasterLayerSource, ae as RasterValue, bj as RouteToolSettings, aT as SelectionController, b_ as SetViewportCenterZoomParams, b5 as SetVisibilityRequest, b6 as SortConfig, b7 as SortDirection, T as TextElementCreate, y as TextElementRead, A as TextElementUpdate, bk as TextToolSettings, bl as ToolSettingsChangeEvent, bm as ToolSettingsMap, bn as ToolType, bo as ToolsController, bY as UIActionTriggerCreate, bA as UIButtonElement, bB as UIButtonElementCreate, bC as UIButtonElementUpdate, bG as UIButtonGroupElement, bH as UIButtonGroupElementCreate, bI as UIButtonGroupElementUpdate, bM as UIDividerElement, bN as UIDividerElementCreate, bO as UIDividerElementUpdate, bJ as UIFlexibleSpaceElement, bK as UIFlexibleSpaceElementCreate, bL as UIFlexibleSpaceElementUpdate, by as UIPanel, bz as UIPanelCreate, bV as UIPanelElements, bW as UIPanelElementsCreate, bX as UIPanelElementsUpdate, bS as UISelectElement, bT as UISelectElementCreate, bU as UISelectElementUpdate, bD as UITextElement, bE as UITextElementCreate, bF as UITextElementUpdate, bP as UITextInputElement, bQ as UITextInputElementCreate, bR as UITextInputElementUpdate, bZ as UiController, bu as UpdateActionTriggerParams, ab as UpdateLayerParams, bv as UpdatePanelElementsParams, bw as UpdatePanelParams, aI as ValueConfiguration, ac as VectorLayer, b$ as ViewportConstraints, c2 as ViewportController, c0 as ViewportFitBoundsParams, c1 as ViewportState } from './controller-Dfbw7Li5.cjs';
1
+ import { z as zInfer, U as UiControlsOptions, V as ViewportCenterZoom, F as FeltController } from './controller-g5AHQrRU.cjs';
2
+ export { au as AggregatedGridConfig, av as AggregationConfig, aw as AggregationMethod, C as CircleElementCreate, a as CircleElementRead, b as CircleElementUpdate, b8 as CircleToolSettings, b9 as ConfigurableToolType, ax as CountGridConfig, bp as CreateActionTriggerParams, K as CreateLayersFromGeoJsonParams, bq as CreatePanelElementsParams, br as CreatePanelParams, O as DataOnlyLayer, bs as DeletePanelElementsParams, E as Element, c as ElementChangeCallbackParams, d as ElementCreate, e as ElementGroup, f as ElementGroupChangeCallbackParams, aM as ElementGroupNode, aN as ElementNode, g as ElementUpdate, B as ElementsController, aO as EntityNode, aP as FeatureNode, aQ as FeatureSelection, aU as FeltBoundary, Q as FeltTiledVectorSource, aV as FeltZoom, an as FilterExpression, ao as FilterLogicGate, ap as FilterTernary, aq as Filters, R as GeoJsonDataVectorSource, aW as GeoJsonFeature, S as GeoJsonFileVectorSource, aX as GeoJsonGeometry, aY as GeoJsonProperties, W as GeoJsonUrlVectorSource, ar as GeometryFilter, G as GetElementGroupsConstraint, h as GetElementsConstraint, ay as GetLayerCalculationParams, az as GetLayerCategoriesGroup, aA as GetLayerCategoriesParams, X as GetLayerGroupsConstraint, aB as GetLayerHistogramBin, aC as GetLayerHistogramParams, aD as GetLayerPrecomputedCalculationParams, Y as GetLayersConstraint, Z as GetRenderedFeaturesConstraint, aE as GridConfig, aF as GridType, H as HighlighterElementCreate, i as HighlighterElementRead, j as HighlighterElementUpdate, ba as HighlighterToolSettings, I as ImageElementCreate, k as ImageElementRead, l as ImageElementUpdate, bb as InputToolSettings, J as InteractionsController, aZ as LatLng, _ as Layer, as as LayerBoundaries, $ as LayerChangeCallbackParams, a0 as LayerCommon, ad as LayerFeature, at as LayerFilters, a1 as LayerGroup, a2 as LayerGroupChangeCallbackParams, aR as LayerGroupNode, aS as LayerNode, a3 as LayerProcessingStatus, af as LayerSchema, ag as LayerSchemaAttribute, ah as LayerSchemaBooleanAttribute, ai as LayerSchemaCommonAttribute, aj as LayerSchemaDateAttribute, ak as LayerSchemaDateTimeAttribute, al as LayerSchemaNumericAttribute, am as LayerSchemaTextAttribute, aJ as LayersController, a4 as LegendItem, a5 as LegendItemChangeCallbackParams, a6 as LegendItemIdentifier, a7 as LegendItemsConstraint, a_ as LineStringGeometry, bc as LineToolSettings, L as LinkElementRead, a$ as LngLatTuple, aK as MapDetails, D as MapInteractionEvent, M as MarkerElementCreate, m as MarkerElementRead, n as MarkerElementUpdate, bd as MarkerToolSettings, aL as MiscController, aG as MultiAggregationConfig, b0 as MultiLineStringGeometry, b1 as MultiPointGeometry, b2 as MultiPolygonGeometry, N as NoteElementCreate, o as NoteElementRead, p as NoteElementUpdate, be as NoteToolSettings, bt as OnMapInteractionsOptions, P as PathElementCreate, q as PathElementRead, r as PathElementUpdate, bf as PinToolSettings, s as PlaceElementCreate, t as PlaceElementRead, u as PlaceElementUpdate, bg as PlaceFrame, bh as PlaceSymbol, bx as PlacementForUIElement, b3 as PointGeometry, v as PolygonElementCreate, w as PolygonElementRead, x as PolygonElementUpdate, b4 as PolygonGeometry, bi as PolygonToolSettings, aH as PrecomputedAggregationMethod, a8 as RasterBand, a9 as RasterLayer, aa as RasterLayerSource, ae as RasterValue, bj as RouteToolSettings, aT as SelectionController, b_ as SetViewportCenterZoomParams, b5 as SetVisibilityRequest, b6 as SortConfig, b7 as SortDirection, T as TextElementCreate, y as TextElementRead, A as TextElementUpdate, bk as TextToolSettings, bl as ToolSettingsChangeEvent, bm as ToolSettingsMap, bn as ToolType, bo as ToolsController, bY as UIActionTriggerCreate, bA as UIButtonElement, bB as UIButtonElementCreate, bC as UIButtonElementUpdate, bG as UIButtonGroupElement, bH as UIButtonGroupElementCreate, bI as UIButtonGroupElementUpdate, bM as UIDividerElement, bN as UIDividerElementCreate, bO as UIDividerElementUpdate, bJ as UIFlexibleSpaceElement, bK as UIFlexibleSpaceElementCreate, bL as UIFlexibleSpaceElementUpdate, by as UIPanel, bz as UIPanelCreate, bV as UIPanelElements, bW as UIPanelElementsCreate, bX as UIPanelElementsUpdate, bS as UISelectElement, bT as UISelectElementCreate, bU as UISelectElementUpdate, bD as UITextElement, bE as UITextElementCreate, bF as UITextElementUpdate, bP as UITextInputElement, bQ as UITextInputElementCreate, bR as UITextInputElementUpdate, bZ as UiController, bu as UpdateActionTriggerParams, ab as UpdateLayerParams, bv as UpdatePanelElementsParams, bw as UpdatePanelParams, aI as ValueConfiguration, ac as VectorLayer, b$ as ViewportConstraints, c2 as ViewportController, c0 as ViewportFitBoundsParams, c1 as ViewportState } from './controller-g5AHQrRU.cjs';
3
3
  import { z } from 'zod';
4
4
 
5
5
  /**
package/dist/client.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { z as zInfer, U as UiControlsOptions, V as ViewportCenterZoom, F as FeltController } from './controller-Dfbw7Li5.js';
2
- export { au as AggregatedGridConfig, av as AggregationConfig, aw as AggregationMethod, C as CircleElementCreate, a as CircleElementRead, b as CircleElementUpdate, b8 as CircleToolSettings, b9 as ConfigurableToolType, ax as CountGridConfig, bp as CreateActionTriggerParams, K as CreateLayersFromGeoJsonParams, bq as CreatePanelElementsParams, br as CreatePanelParams, O as DataOnlyLayer, bs as DeletePanelElementsParams, E as Element, c as ElementChangeCallbackParams, d as ElementCreate, e as ElementGroup, f as ElementGroupChangeCallbackParams, aM as ElementGroupNode, aN as ElementNode, g as ElementUpdate, B as ElementsController, aO as EntityNode, aP as FeatureNode, aQ as FeatureSelection, aU as FeltBoundary, Q as FeltTiledVectorSource, aV as FeltZoom, an as FilterExpression, ao as FilterLogicGate, ap as FilterTernary, aq as Filters, R as GeoJsonDataVectorSource, aW as GeoJsonFeature, S as GeoJsonFileVectorSource, aX as GeoJsonGeometry, aY as GeoJsonProperties, W as GeoJsonUrlVectorSource, ar as GeometryFilter, G as GetElementGroupsConstraint, h as GetElementsConstraint, ay as GetLayerCalculationParams, az as GetLayerCategoriesGroup, aA as GetLayerCategoriesParams, X as GetLayerGroupsConstraint, aB as GetLayerHistogramBin, aC as GetLayerHistogramParams, aD as GetLayerPrecomputedCalculationParams, Y as GetLayersConstraint, Z as GetRenderedFeaturesConstraint, aE as GridConfig, aF as GridType, H as HighlighterElementCreate, i as HighlighterElementRead, j as HighlighterElementUpdate, ba as HighlighterToolSettings, I as ImageElementCreate, k as ImageElementRead, l as ImageElementUpdate, bb as InputToolSettings, J as InteractionsController, aZ as LatLng, _ as Layer, as as LayerBoundaries, $ as LayerChangeCallbackParams, a0 as LayerCommon, ad as LayerFeature, at as LayerFilters, a1 as LayerGroup, a2 as LayerGroupChangeCallbackParams, aR as LayerGroupNode, aS as LayerNode, a3 as LayerProcessingStatus, af as LayerSchema, ag as LayerSchemaAttribute, ah as LayerSchemaBooleanAttribute, ai as LayerSchemaCommonAttribute, aj as LayerSchemaDateAttribute, ak as LayerSchemaDateTimeAttribute, al as LayerSchemaNumericAttribute, am as LayerSchemaTextAttribute, aJ as LayersController, a4 as LegendItem, a5 as LegendItemChangeCallbackParams, a6 as LegendItemIdentifier, a7 as LegendItemsConstraint, a_ as LineStringGeometry, bc as LineToolSettings, L as LinkElementRead, a$ as LngLatTuple, aK as MapDetails, D as MapInteractionEvent, M as MarkerElementCreate, m as MarkerElementRead, n as MarkerElementUpdate, bd as MarkerToolSettings, aL as MiscController, aG as MultiAggregationConfig, b0 as MultiLineStringGeometry, b1 as MultiPointGeometry, b2 as MultiPolygonGeometry, N as NoteElementCreate, o as NoteElementRead, p as NoteElementUpdate, be as NoteToolSettings, bt as OnMapInteractionsOptions, P as PathElementCreate, q as PathElementRead, r as PathElementUpdate, bf as PinToolSettings, s as PlaceElementCreate, t as PlaceElementRead, u as PlaceElementUpdate, bg as PlaceFrame, bh as PlaceSymbol, bx as PlacementForUIElement, b3 as PointGeometry, v as PolygonElementCreate, w as PolygonElementRead, x as PolygonElementUpdate, b4 as PolygonGeometry, bi as PolygonToolSettings, aH as PrecomputedAggregationMethod, a8 as RasterBand, a9 as RasterLayer, aa as RasterLayerSource, ae as RasterValue, bj as RouteToolSettings, aT as SelectionController, b_ as SetViewportCenterZoomParams, b5 as SetVisibilityRequest, b6 as SortConfig, b7 as SortDirection, T as TextElementCreate, y as TextElementRead, A as TextElementUpdate, bk as TextToolSettings, bl as ToolSettingsChangeEvent, bm as ToolSettingsMap, bn as ToolType, bo as ToolsController, bY as UIActionTriggerCreate, bA as UIButtonElement, bB as UIButtonElementCreate, bC as UIButtonElementUpdate, bG as UIButtonGroupElement, bH as UIButtonGroupElementCreate, bI as UIButtonGroupElementUpdate, bM as UIDividerElement, bN as UIDividerElementCreate, bO as UIDividerElementUpdate, bJ as UIFlexibleSpaceElement, bK as UIFlexibleSpaceElementCreate, bL as UIFlexibleSpaceElementUpdate, by as UIPanel, bz as UIPanelCreate, bV as UIPanelElements, bW as UIPanelElementsCreate, bX as UIPanelElementsUpdate, bS as UISelectElement, bT as UISelectElementCreate, bU as UISelectElementUpdate, bD as UITextElement, bE as UITextElementCreate, bF as UITextElementUpdate, bP as UITextInputElement, bQ as UITextInputElementCreate, bR as UITextInputElementUpdate, bZ as UiController, bu as UpdateActionTriggerParams, ab as UpdateLayerParams, bv as UpdatePanelElementsParams, bw as UpdatePanelParams, aI as ValueConfiguration, ac as VectorLayer, b$ as ViewportConstraints, c2 as ViewportController, c0 as ViewportFitBoundsParams, c1 as ViewportState } from './controller-Dfbw7Li5.js';
1
+ import { z as zInfer, U as UiControlsOptions, V as ViewportCenterZoom, F as FeltController } from './controller-g5AHQrRU.js';
2
+ export { au as AggregatedGridConfig, av as AggregationConfig, aw as AggregationMethod, C as CircleElementCreate, a as CircleElementRead, b as CircleElementUpdate, b8 as CircleToolSettings, b9 as ConfigurableToolType, ax as CountGridConfig, bp as CreateActionTriggerParams, K as CreateLayersFromGeoJsonParams, bq as CreatePanelElementsParams, br as CreatePanelParams, O as DataOnlyLayer, bs as DeletePanelElementsParams, E as Element, c as ElementChangeCallbackParams, d as ElementCreate, e as ElementGroup, f as ElementGroupChangeCallbackParams, aM as ElementGroupNode, aN as ElementNode, g as ElementUpdate, B as ElementsController, aO as EntityNode, aP as FeatureNode, aQ as FeatureSelection, aU as FeltBoundary, Q as FeltTiledVectorSource, aV as FeltZoom, an as FilterExpression, ao as FilterLogicGate, ap as FilterTernary, aq as Filters, R as GeoJsonDataVectorSource, aW as GeoJsonFeature, S as GeoJsonFileVectorSource, aX as GeoJsonGeometry, aY as GeoJsonProperties, W as GeoJsonUrlVectorSource, ar as GeometryFilter, G as GetElementGroupsConstraint, h as GetElementsConstraint, ay as GetLayerCalculationParams, az as GetLayerCategoriesGroup, aA as GetLayerCategoriesParams, X as GetLayerGroupsConstraint, aB as GetLayerHistogramBin, aC as GetLayerHistogramParams, aD as GetLayerPrecomputedCalculationParams, Y as GetLayersConstraint, Z as GetRenderedFeaturesConstraint, aE as GridConfig, aF as GridType, H as HighlighterElementCreate, i as HighlighterElementRead, j as HighlighterElementUpdate, ba as HighlighterToolSettings, I as ImageElementCreate, k as ImageElementRead, l as ImageElementUpdate, bb as InputToolSettings, J as InteractionsController, aZ as LatLng, _ as Layer, as as LayerBoundaries, $ as LayerChangeCallbackParams, a0 as LayerCommon, ad as LayerFeature, at as LayerFilters, a1 as LayerGroup, a2 as LayerGroupChangeCallbackParams, aR as LayerGroupNode, aS as LayerNode, a3 as LayerProcessingStatus, af as LayerSchema, ag as LayerSchemaAttribute, ah as LayerSchemaBooleanAttribute, ai as LayerSchemaCommonAttribute, aj as LayerSchemaDateAttribute, ak as LayerSchemaDateTimeAttribute, al as LayerSchemaNumericAttribute, am as LayerSchemaTextAttribute, aJ as LayersController, a4 as LegendItem, a5 as LegendItemChangeCallbackParams, a6 as LegendItemIdentifier, a7 as LegendItemsConstraint, a_ as LineStringGeometry, bc as LineToolSettings, L as LinkElementRead, a$ as LngLatTuple, aK as MapDetails, D as MapInteractionEvent, M as MarkerElementCreate, m as MarkerElementRead, n as MarkerElementUpdate, bd as MarkerToolSettings, aL as MiscController, aG as MultiAggregationConfig, b0 as MultiLineStringGeometry, b1 as MultiPointGeometry, b2 as MultiPolygonGeometry, N as NoteElementCreate, o as NoteElementRead, p as NoteElementUpdate, be as NoteToolSettings, bt as OnMapInteractionsOptions, P as PathElementCreate, q as PathElementRead, r as PathElementUpdate, bf as PinToolSettings, s as PlaceElementCreate, t as PlaceElementRead, u as PlaceElementUpdate, bg as PlaceFrame, bh as PlaceSymbol, bx as PlacementForUIElement, b3 as PointGeometry, v as PolygonElementCreate, w as PolygonElementRead, x as PolygonElementUpdate, b4 as PolygonGeometry, bi as PolygonToolSettings, aH as PrecomputedAggregationMethod, a8 as RasterBand, a9 as RasterLayer, aa as RasterLayerSource, ae as RasterValue, bj as RouteToolSettings, aT as SelectionController, b_ as SetViewportCenterZoomParams, b5 as SetVisibilityRequest, b6 as SortConfig, b7 as SortDirection, T as TextElementCreate, y as TextElementRead, A as TextElementUpdate, bk as TextToolSettings, bl as ToolSettingsChangeEvent, bm as ToolSettingsMap, bn as ToolType, bo as ToolsController, bY as UIActionTriggerCreate, bA as UIButtonElement, bB as UIButtonElementCreate, bC as UIButtonElementUpdate, bG as UIButtonGroupElement, bH as UIButtonGroupElementCreate, bI as UIButtonGroupElementUpdate, bM as UIDividerElement, bN as UIDividerElementCreate, bO as UIDividerElementUpdate, bJ as UIFlexibleSpaceElement, bK as UIFlexibleSpaceElementCreate, bL as UIFlexibleSpaceElementUpdate, by as UIPanel, bz as UIPanelCreate, bV as UIPanelElements, bW as UIPanelElementsCreate, bX as UIPanelElementsUpdate, bS as UISelectElement, bT as UISelectElementCreate, bU as UISelectElementUpdate, bD as UITextElement, bE as UITextElementCreate, bF as UITextElementUpdate, bP as UITextInputElement, bQ as UITextInputElementCreate, bR as UITextInputElementUpdate, bZ as UiController, bu as UpdateActionTriggerParams, ab as UpdateLayerParams, bv as UpdatePanelElementsParams, bw as UpdatePanelParams, aI as ValueConfiguration, ac as VectorLayer, b$ as ViewportConstraints, c2 as ViewportController, c0 as ViewportFitBoundsParams, c1 as ViewportState } from './controller-g5AHQrRU.js';
3
3
  import { z } from 'zod';
4
4
 
5
5
  /**
@@ -8978,6 +8978,14 @@ interface SelectionController {
8978
8978
 
8979
8979
  type ToolType = "circle" | "highlighter" | "line" | "link" | "marker" | "note" | "pin" | "polygon" | "route" | "text";
8980
8980
  type ConfigurableToolType = Exclude<ToolType, "link">;
8981
+ interface ShowToolInspectorSettings {
8982
+ /**
8983
+ * Whether to show the tool inspector.
8984
+ *
8985
+ * @defaultValue `false`
8986
+ */
8987
+ showInspector: boolean;
8988
+ }
8981
8989
  declare const PinToolSettingsSchema: ZodObject<{
8982
8990
  symbol: ZodString;
8983
8991
  color: ZodString;
@@ -8994,7 +9002,7 @@ declare const PinToolSettingsSchema: ZodObject<{
8994
9002
  frame: "frame-circle" | "frame-square" | null;
8995
9003
  afterCreation: "enter name" | "add another" | "select";
8996
9004
  }>;
8997
- interface PinToolSettings extends zInfer<typeof PinToolSettingsSchema> {
9005
+ interface PinToolSettings extends zInfer<typeof PinToolSettingsSchema>, ShowToolInspectorSettings {
8998
9006
  symbol: PlaceSymbol;
8999
9007
  /**
9000
9008
  * What to do after creating the Place element.
@@ -9026,7 +9034,7 @@ declare const LineToolSettingsSchema: ZodObject<{
9026
9034
  strokeStyle: "solid" | "dashed" | "dotted";
9027
9035
  distanceMarker: boolean;
9028
9036
  }>;
9029
- interface LineToolSettings extends zInfer<typeof LineToolSettingsSchema> {
9037
+ interface LineToolSettings extends zInfer<typeof LineToolSettingsSchema>, ShowToolInspectorSettings {
9030
9038
  }
9031
9039
  declare const RouteToolSettingsSchema: ZodObject<{
9032
9040
  color: ZodString;
@@ -9053,7 +9061,7 @@ declare const RouteToolSettingsSchema: ZodObject<{
9053
9061
  routingMode: "driving" | "cycling" | "walking" | "flying" | null;
9054
9062
  endCaps: boolean;
9055
9063
  }>;
9056
- interface RouteToolSettings extends zInfer<typeof RouteToolSettingsSchema> {
9064
+ interface RouteToolSettings extends zInfer<typeof RouteToolSettingsSchema>, ShowToolInspectorSettings {
9057
9065
  }
9058
9066
  declare const PolygonToolSettingsSchema: ZodObject<{
9059
9067
  color: ZodString;
@@ -9077,7 +9085,7 @@ declare const PolygonToolSettingsSchema: ZodObject<{
9077
9085
  fillOpacity: number;
9078
9086
  areaMarker: boolean;
9079
9087
  }>;
9080
- interface PolygonToolSettings extends zInfer<typeof PolygonToolSettingsSchema> {
9088
+ interface PolygonToolSettings extends zInfer<typeof PolygonToolSettingsSchema>, ShowToolInspectorSettings {
9081
9089
  }
9082
9090
  declare const CircleToolSettingsSchema: ZodObject<{
9083
9091
  color: ZodString;
@@ -9101,7 +9109,7 @@ declare const CircleToolSettingsSchema: ZodObject<{
9101
9109
  fillOpacity: number;
9102
9110
  radiusMarker: boolean;
9103
9111
  }>;
9104
- interface CircleToolSettings extends zInfer<typeof CircleToolSettingsSchema> {
9112
+ interface CircleToolSettings extends zInfer<typeof CircleToolSettingsSchema>, ShowToolInspectorSettings {
9105
9113
  }
9106
9114
  declare const MarkerToolSettingsSchema: ZodObject<{
9107
9115
  color: ZodString;
@@ -9116,7 +9124,7 @@ declare const MarkerToolSettingsSchema: ZodObject<{
9116
9124
  opacity: number;
9117
9125
  size: number;
9118
9126
  }>;
9119
- interface MarkerToolSettings extends zInfer<typeof MarkerToolSettingsSchema> {
9127
+ interface MarkerToolSettings extends zInfer<typeof MarkerToolSettingsSchema>, ShowToolInspectorSettings {
9120
9128
  }
9121
9129
  declare const HighlighterToolSettingsSchema: ZodObject<{
9122
9130
  color: ZodString;
@@ -9134,7 +9142,7 @@ declare const HighlighterToolSettingsSchema: ZodObject<{
9134
9142
  size: number;
9135
9143
  renderHoles: boolean;
9136
9144
  }>;
9137
- interface HighlighterToolSettings extends zInfer<typeof HighlighterToolSettingsSchema> {
9145
+ interface HighlighterToolSettings extends zInfer<typeof HighlighterToolSettingsSchema>, ShowToolInspectorSettings {
9138
9146
  }
9139
9147
  declare const TextToolSettingsSchema: ZodObject<{
9140
9148
  color: ZodString;
@@ -9149,7 +9157,7 @@ declare const TextToolSettingsSchema: ZodObject<{
9149
9157
  align: "center" | "left" | "right";
9150
9158
  style: "italic" | "light" | "regular" | "caps";
9151
9159
  }>;
9152
- interface TextToolSettings extends zInfer<typeof TextToolSettingsSchema> {
9160
+ interface TextToolSettings extends zInfer<typeof TextToolSettingsSchema>, ShowToolInspectorSettings {
9153
9161
  }
9154
9162
  declare const NoteToolSettingsSchema: ZodObject<{
9155
9163
  color: ZodString;
@@ -9164,7 +9172,7 @@ declare const NoteToolSettingsSchema: ZodObject<{
9164
9172
  align: "center" | "left" | "right";
9165
9173
  style: "italic" | "light" | "regular" | "caps";
9166
9174
  }>;
9167
- interface NoteToolSettings extends zInfer<typeof NoteToolSettingsSchema> {
9175
+ interface NoteToolSettings extends zInfer<typeof NoteToolSettingsSchema>, ShowToolInspectorSettings {
9168
9176
  }
9169
9177
  /**
9170
9178
  * The parameters for changing the settings of each tool.
@@ -11059,7 +11067,7 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11059
11067
  placeholder?: string | undefined;
11060
11068
  search?: boolean | undefined;
11061
11069
  }>]>, "many">>;
11062
- onClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
11070
+ onClickClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
11063
11071
  }>, "strip", ZodTypeAny, {
11064
11072
  type: "Panel";
11065
11073
  id: string;
@@ -11228,7 +11236,7 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11228
11236
  placeholder?: string | undefined;
11229
11237
  search?: boolean | undefined;
11230
11238
  })[] | undefined;
11231
- onClose?: ((...args: unknown[]) => void) | undefined;
11239
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
11232
11240
  }, {
11233
11241
  type: "Panel";
11234
11242
  id: string;
@@ -11397,7 +11405,7 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11397
11405
  placeholder?: string | undefined;
11398
11406
  search?: boolean | undefined;
11399
11407
  })[] | undefined;
11400
- onClose?: ((...args: unknown[]) => void) | undefined;
11408
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
11401
11409
  }>;
11402
11410
  /**
11403
11411
  * Represents a panel in the UI.
@@ -11407,7 +11415,11 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11407
11415
  * It can have a title, a body, a footer as well as a close button.
11408
11416
  *
11409
11417
  * The body and footer are arrays of UI elements and turn into vertical stacks of elements.
11410
- * The close button is a button that can be used to close the panel.
11418
+ *
11419
+ * The close button is a button rendered in the top right corner of the panel that can be
11420
+ * used to close the panel and is only visible if `onClickClose` is provided.
11421
+ * Usually, you want to call {@link UiController.deletePanel} when the close button is clicked,
11422
+ * e.g. `onClickClose: () => felt.deletePanel("my-panel")`.
11411
11423
  *
11412
11424
  * #### Body
11413
11425
  * Body is the main content of the panel. It is scrollable which means
@@ -11426,10 +11438,19 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11426
11438
  * body: [
11427
11439
  * { type: "Text", text: "Hello" },
11428
11440
  * ],
11429
- * });
11441
+ * }
11430
11442
  * ```
11431
11443
  *
11432
11444
  * @example
11445
+ * #### closable
11446
+ * ```typescript
11447
+ * {
11448
+ * id: "my-panel",
11449
+ * title: "My Panel",
11450
+ * onClickClose: () => felt.deletePanel("my-panel"),
11451
+ * }
11452
+ *
11453
+ * @example
11433
11454
  * #### form
11434
11455
  * ```typescript
11435
11456
  * {
@@ -11445,11 +11466,11 @@ declare const uiPanelSchema: ZodObject<objectUtil.extendShape<objectUtil.extendS
11445
11466
  * { type: "Button", label: "Save", onClick: () => alert("Save") },
11446
11467
  * ] },
11447
11468
  * ],
11448
- * });
11469
+ * }
11449
11470
  * ```
11450
11471
  *
11451
11472
  */
11452
- interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onClose" | "body" | "footer" | "onCreate" | "onDestroy"> {
11473
+ interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onClickClose" | "body" | "footer" | "onCreate" | "onDestroy"> {
11453
11474
  /**
11454
11475
  * The elements to add to the panel body.
11455
11476
  */
@@ -11461,7 +11482,7 @@ interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onC
11461
11482
  /**
11462
11483
  * A function to call when panel's close button is clicked.
11463
11484
  */
11464
- onClose?: () => void;
11485
+ onClickClose?: () => void;
11465
11486
  }
11466
11487
  declare const uiPanelCreateSchema: {
11467
11488
  params: ZodObject<objectUtil.extendShape<Omit<{
@@ -12116,7 +12137,7 @@ declare const uiPanelCreateSchema: {
12116
12137
  placeholder?: string | undefined;
12117
12138
  search?: boolean | undefined;
12118
12139
  }>]>, "many">>;
12119
- onClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
12140
+ onClickClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
12120
12141
  }, "body" | "footer">, {
12121
12142
  body: ZodArray<ZodDiscriminatedUnion<"type", [ZodObject<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<{
12122
12143
  onCreate: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
@@ -13144,7 +13165,7 @@ declare const uiPanelCreateSchema: {
13144
13165
  placeholder?: string | undefined;
13145
13166
  search?: boolean | undefined;
13146
13167
  })[] | undefined;
13147
- onClose?: ((...args: unknown[]) => void) | undefined;
13168
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
13148
13169
  }, {
13149
13170
  body: ({
13150
13171
  type: "Button";
@@ -13313,7 +13334,7 @@ declare const uiPanelCreateSchema: {
13313
13334
  placeholder?: string | undefined;
13314
13335
  search?: boolean | undefined;
13315
13336
  })[] | undefined;
13316
- onClose?: ((...args: unknown[]) => void) | undefined;
13337
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
13317
13338
  }>;
13318
13339
  clonable: ZodObject<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<Omit<{
13319
13340
  type: ZodOptional<ZodLiteral<"Panel">>;
@@ -13967,7 +13988,7 @@ declare const uiPanelCreateSchema: {
13967
13988
  placeholder?: string | undefined;
13968
13989
  search?: boolean | undefined;
13969
13990
  }>]>, "many">>;
13970
- onClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
13991
+ onClickClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
13971
13992
  }, "body" | "footer">, {
13972
13993
  body: ZodArray<ZodDiscriminatedUnion<"type", [ZodObject<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<{
13973
13994
  onCreate: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
@@ -14835,7 +14856,7 @@ declare const uiPanelCreateSchema: {
14835
14856
  onCreate: ZodOptional<ZodString>;
14836
14857
  onDestroy: ZodOptional<ZodString>;
14837
14858
  }>>, {
14838
- onClose: ZodOptional<ZodString>;
14859
+ onClickClose: ZodOptional<ZodString>;
14839
14860
  body: ZodArray<ZodDiscriminatedUnion<"type", [ZodObject<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<{
14840
14861
  onCreate: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
14841
14862
  onDestroy: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
@@ -16136,7 +16157,7 @@ declare const uiPanelCreateSchema: {
16136
16157
  placeholder?: string | undefined;
16137
16158
  search?: boolean | undefined;
16138
16159
  })[] | undefined;
16139
- onClose?: string | undefined;
16160
+ onClickClose?: string | undefined;
16140
16161
  }, {
16141
16162
  body: ({
16142
16163
  type: "Button";
@@ -16289,7 +16310,7 @@ declare const uiPanelCreateSchema: {
16289
16310
  placeholder?: string | undefined;
16290
16311
  search?: boolean | undefined;
16291
16312
  })[] | undefined;
16292
- onClose?: string | undefined;
16313
+ onClickClose?: string | undefined;
16293
16314
  }>;
16294
16315
  };
16295
16316
  /**
@@ -17084,7 +17105,7 @@ declare const CreatePanelParamsSchema: ZodObject<{
17084
17105
  placeholder?: string | undefined;
17085
17106
  search?: boolean | undefined;
17086
17107
  }>]>, "many">>;
17087
- onClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
17108
+ onClickClose: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
17088
17109
  }, "body" | "footer">, {
17089
17110
  body: ZodArray<ZodDiscriminatedUnion<"type", [ZodObject<objectUtil.extendShape<objectUtil.extendShape<objectUtil.extendShape<{
17090
17111
  onCreate: ZodOptional<ZodFunction<ZodTuple<[], ZodUnknown>, ZodVoid>>;
@@ -18112,7 +18133,7 @@ declare const CreatePanelParamsSchema: ZodObject<{
18112
18133
  placeholder?: string | undefined;
18113
18134
  search?: boolean | undefined;
18114
18135
  })[] | undefined;
18115
- onClose?: ((...args: unknown[]) => void) | undefined;
18136
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
18116
18137
  }, {
18117
18138
  body: ({
18118
18139
  type: "Button";
@@ -18281,7 +18302,7 @@ declare const CreatePanelParamsSchema: ZodObject<{
18281
18302
  placeholder?: string | undefined;
18282
18303
  search?: boolean | undefined;
18283
18304
  })[] | undefined;
18284
- onClose?: ((...args: unknown[]) => void) | undefined;
18305
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
18285
18306
  }>;
18286
18307
  placement: ZodOptional<ZodUnion<[ZodObject<{
18287
18308
  after: ZodString;
@@ -18471,7 +18492,7 @@ declare const CreatePanelParamsSchema: ZodObject<{
18471
18492
  placeholder?: string | undefined;
18472
18493
  search?: boolean | undefined;
18473
18494
  })[] | undefined;
18474
- onClose?: ((...args: unknown[]) => void) | undefined;
18495
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
18475
18496
  };
18476
18497
  placement?: {
18477
18498
  after: string;
@@ -18649,7 +18670,7 @@ declare const CreatePanelParamsSchema: ZodObject<{
18649
18670
  placeholder?: string | undefined;
18650
18671
  search?: boolean | undefined;
18651
18672
  })[] | undefined;
18652
- onClose?: ((...args: unknown[]) => void) | undefined;
18673
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
18653
18674
  };
18654
18675
  placement?: {
18655
18676
  after: string;
@@ -7870,6 +7870,14 @@ interface SelectionController {
7870
7870
 
7871
7871
  type ToolType = "circle" | "highlighter" | "line" | "link" | "marker" | "note" | "pin" | "polygon" | "route" | "text";
7872
7872
  type ConfigurableToolType = Exclude<ToolType, "link">;
7873
+ interface ShowToolInspectorSettings {
7874
+ /**
7875
+ * Whether to show the tool inspector.
7876
+ *
7877
+ * @defaultValue `false`
7878
+ */
7879
+ showInspector: boolean;
7880
+ }
7873
7881
  declare const PinToolSettingsSchema: z.ZodObject<{
7874
7882
  symbol: z.ZodString;
7875
7883
  color: z.ZodString;
@@ -7886,7 +7894,7 @@ declare const PinToolSettingsSchema: z.ZodObject<{
7886
7894
  frame: "frame-circle" | "frame-square" | null;
7887
7895
  afterCreation: "enter name" | "add another" | "select";
7888
7896
  }>;
7889
- interface PinToolSettings extends zInfer<typeof PinToolSettingsSchema> {
7897
+ interface PinToolSettings extends zInfer<typeof PinToolSettingsSchema>, ShowToolInspectorSettings {
7890
7898
  symbol: PlaceSymbol;
7891
7899
  /**
7892
7900
  * What to do after creating the Place element.
@@ -7918,7 +7926,7 @@ declare const LineToolSettingsSchema: z.ZodObject<{
7918
7926
  strokeStyle: "solid" | "dashed" | "dotted";
7919
7927
  distanceMarker: boolean;
7920
7928
  }>;
7921
- interface LineToolSettings extends zInfer<typeof LineToolSettingsSchema> {
7929
+ interface LineToolSettings extends zInfer<typeof LineToolSettingsSchema>, ShowToolInspectorSettings {
7922
7930
  }
7923
7931
  declare const RouteToolSettingsSchema: z.ZodObject<{
7924
7932
  color: z.ZodString;
@@ -7945,7 +7953,7 @@ declare const RouteToolSettingsSchema: z.ZodObject<{
7945
7953
  routingMode: "driving" | "cycling" | "walking" | "flying" | null;
7946
7954
  endCaps: boolean;
7947
7955
  }>;
7948
- interface RouteToolSettings extends zInfer<typeof RouteToolSettingsSchema> {
7956
+ interface RouteToolSettings extends zInfer<typeof RouteToolSettingsSchema>, ShowToolInspectorSettings {
7949
7957
  }
7950
7958
  declare const PolygonToolSettingsSchema: z.ZodObject<{
7951
7959
  color: z.ZodString;
@@ -7969,7 +7977,7 @@ declare const PolygonToolSettingsSchema: z.ZodObject<{
7969
7977
  fillOpacity: number;
7970
7978
  areaMarker: boolean;
7971
7979
  }>;
7972
- interface PolygonToolSettings extends zInfer<typeof PolygonToolSettingsSchema> {
7980
+ interface PolygonToolSettings extends zInfer<typeof PolygonToolSettingsSchema>, ShowToolInspectorSettings {
7973
7981
  }
7974
7982
  declare const CircleToolSettingsSchema: z.ZodObject<{
7975
7983
  color: z.ZodString;
@@ -7993,7 +8001,7 @@ declare const CircleToolSettingsSchema: z.ZodObject<{
7993
8001
  fillOpacity: number;
7994
8002
  radiusMarker: boolean;
7995
8003
  }>;
7996
- interface CircleToolSettings extends zInfer<typeof CircleToolSettingsSchema> {
8004
+ interface CircleToolSettings extends zInfer<typeof CircleToolSettingsSchema>, ShowToolInspectorSettings {
7997
8005
  }
7998
8006
  declare const MarkerToolSettingsSchema: z.ZodObject<{
7999
8007
  color: z.ZodString;
@@ -8008,7 +8016,7 @@ declare const MarkerToolSettingsSchema: z.ZodObject<{
8008
8016
  opacity: number;
8009
8017
  size: number;
8010
8018
  }>;
8011
- interface MarkerToolSettings extends zInfer<typeof MarkerToolSettingsSchema> {
8019
+ interface MarkerToolSettings extends zInfer<typeof MarkerToolSettingsSchema>, ShowToolInspectorSettings {
8012
8020
  }
8013
8021
  declare const HighlighterToolSettingsSchema: z.ZodObject<{
8014
8022
  color: z.ZodString;
@@ -8026,7 +8034,7 @@ declare const HighlighterToolSettingsSchema: z.ZodObject<{
8026
8034
  size: number;
8027
8035
  renderHoles: boolean;
8028
8036
  }>;
8029
- interface HighlighterToolSettings extends zInfer<typeof HighlighterToolSettingsSchema> {
8037
+ interface HighlighterToolSettings extends zInfer<typeof HighlighterToolSettingsSchema>, ShowToolInspectorSettings {
8030
8038
  }
8031
8039
  declare const TextToolSettingsSchema: z.ZodObject<{
8032
8040
  color: z.ZodString;
@@ -8041,7 +8049,7 @@ declare const TextToolSettingsSchema: z.ZodObject<{
8041
8049
  align: "center" | "left" | "right";
8042
8050
  style: "italic" | "light" | "regular" | "caps";
8043
8051
  }>;
8044
- interface TextToolSettings extends zInfer<typeof TextToolSettingsSchema> {
8052
+ interface TextToolSettings extends zInfer<typeof TextToolSettingsSchema>, ShowToolInspectorSettings {
8045
8053
  }
8046
8054
  declare const NoteToolSettingsSchema: z.ZodObject<{
8047
8055
  color: z.ZodString;
@@ -8056,7 +8064,7 @@ declare const NoteToolSettingsSchema: z.ZodObject<{
8056
8064
  align: "center" | "left" | "right";
8057
8065
  style: "italic" | "light" | "regular" | "caps";
8058
8066
  }>;
8059
- interface NoteToolSettings extends zInfer<typeof NoteToolSettingsSchema> {
8067
+ interface NoteToolSettings extends zInfer<typeof NoteToolSettingsSchema>, ShowToolInspectorSettings {
8060
8068
  }
8061
8069
  /**
8062
8070
  * The parameters for changing the settings of each tool.
@@ -9951,7 +9959,7 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
9951
9959
  placeholder?: string | undefined;
9952
9960
  search?: boolean | undefined;
9953
9961
  }>]>, "many">>;
9954
- onClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
9962
+ onClickClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
9955
9963
  }>, "strip", z.ZodTypeAny, {
9956
9964
  type: "Panel";
9957
9965
  id: string;
@@ -10120,7 +10128,7 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
10120
10128
  placeholder?: string | undefined;
10121
10129
  search?: boolean | undefined;
10122
10130
  })[] | undefined;
10123
- onClose?: ((...args: unknown[]) => void) | undefined;
10131
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
10124
10132
  }, {
10125
10133
  type: "Panel";
10126
10134
  id: string;
@@ -10289,7 +10297,7 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
10289
10297
  placeholder?: string | undefined;
10290
10298
  search?: boolean | undefined;
10291
10299
  })[] | undefined;
10292
- onClose?: ((...args: unknown[]) => void) | undefined;
10300
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
10293
10301
  }>;
10294
10302
  /**
10295
10303
  * Represents a panel in the UI.
@@ -10299,7 +10307,11 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
10299
10307
  * It can have a title, a body, a footer as well as a close button.
10300
10308
  *
10301
10309
  * The body and footer are arrays of UI elements and turn into vertical stacks of elements.
10302
- * The close button is a button that can be used to close the panel.
10310
+ *
10311
+ * The close button is a button rendered in the top right corner of the panel that can be
10312
+ * used to close the panel and is only visible if `onClickClose` is provided.
10313
+ * Usually, you want to call {@link UiController.deletePanel} when the close button is clicked,
10314
+ * e.g. `onClickClose: () => felt.deletePanel("my-panel")`.
10303
10315
  *
10304
10316
  * #### Body
10305
10317
  * Body is the main content of the panel. It is scrollable which means
@@ -10318,10 +10330,19 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
10318
10330
  * body: [
10319
10331
  * { type: "Text", text: "Hello" },
10320
10332
  * ],
10321
- * });
10333
+ * }
10322
10334
  * ```
10323
10335
  *
10324
10336
  * @example
10337
+ * #### closable
10338
+ * ```typescript
10339
+ * {
10340
+ * id: "my-panel",
10341
+ * title: "My Panel",
10342
+ * onClickClose: () => felt.deletePanel("my-panel"),
10343
+ * }
10344
+ *
10345
+ * @example
10325
10346
  * #### form
10326
10347
  * ```typescript
10327
10348
  * {
@@ -10337,11 +10358,11 @@ declare const uiPanelSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.e
10337
10358
  * { type: "Button", label: "Save", onClick: () => alert("Save") },
10338
10359
  * ] },
10339
10360
  * ],
10340
- * });
10361
+ * }
10341
10362
  * ```
10342
10363
  *
10343
10364
  */
10344
- interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onClose" | "body" | "footer" | "onCreate" | "onDestroy"> {
10365
+ interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onClickClose" | "body" | "footer" | "onCreate" | "onDestroy"> {
10345
10366
  /**
10346
10367
  * The elements to add to the panel body.
10347
10368
  */
@@ -10353,7 +10374,7 @@ interface UIPanel extends UIElementBase, Omit<zInfer<typeof uiPanelSchema>, "onC
10353
10374
  /**
10354
10375
  * A function to call when panel's close button is clicked.
10355
10376
  */
10356
- onClose?: () => void;
10377
+ onClickClose?: () => void;
10357
10378
  }
10358
10379
  declare const uiPanelCreateSchema: {
10359
10380
  params: z.ZodObject<z.objectUtil.extendShape<Omit<{
@@ -11008,7 +11029,7 @@ declare const uiPanelCreateSchema: {
11008
11029
  placeholder?: string | undefined;
11009
11030
  search?: boolean | undefined;
11010
11031
  }>]>, "many">>;
11011
- onClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
11032
+ onClickClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
11012
11033
  }, "body" | "footer">, {
11013
11034
  body: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
11014
11035
  onCreate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
@@ -12036,7 +12057,7 @@ declare const uiPanelCreateSchema: {
12036
12057
  placeholder?: string | undefined;
12037
12058
  search?: boolean | undefined;
12038
12059
  })[] | undefined;
12039
- onClose?: ((...args: unknown[]) => void) | undefined;
12060
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
12040
12061
  }, {
12041
12062
  body: ({
12042
12063
  type: "Button";
@@ -12205,7 +12226,7 @@ declare const uiPanelCreateSchema: {
12205
12226
  placeholder?: string | undefined;
12206
12227
  search?: boolean | undefined;
12207
12228
  })[] | undefined;
12208
- onClose?: ((...args: unknown[]) => void) | undefined;
12229
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
12209
12230
  }>;
12210
12231
  clonable: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<Omit<{
12211
12232
  type: z.ZodOptional<z.ZodLiteral<"Panel">>;
@@ -12859,7 +12880,7 @@ declare const uiPanelCreateSchema: {
12859
12880
  placeholder?: string | undefined;
12860
12881
  search?: boolean | undefined;
12861
12882
  }>]>, "many">>;
12862
- onClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
12883
+ onClickClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
12863
12884
  }, "body" | "footer">, {
12864
12885
  body: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
12865
12886
  onCreate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
@@ -13727,7 +13748,7 @@ declare const uiPanelCreateSchema: {
13727
13748
  onCreate: z.ZodOptional<z.ZodString>;
13728
13749
  onDestroy: z.ZodOptional<z.ZodString>;
13729
13750
  }>>, {
13730
- onClose: z.ZodOptional<z.ZodString>;
13751
+ onClickClose: z.ZodOptional<z.ZodString>;
13731
13752
  body: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
13732
13753
  onCreate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
13733
13754
  onDestroy: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
@@ -15028,7 +15049,7 @@ declare const uiPanelCreateSchema: {
15028
15049
  placeholder?: string | undefined;
15029
15050
  search?: boolean | undefined;
15030
15051
  })[] | undefined;
15031
- onClose?: string | undefined;
15052
+ onClickClose?: string | undefined;
15032
15053
  }, {
15033
15054
  body: ({
15034
15055
  type: "Button";
@@ -15181,7 +15202,7 @@ declare const uiPanelCreateSchema: {
15181
15202
  placeholder?: string | undefined;
15182
15203
  search?: boolean | undefined;
15183
15204
  })[] | undefined;
15184
- onClose?: string | undefined;
15205
+ onClickClose?: string | undefined;
15185
15206
  }>;
15186
15207
  };
15187
15208
  /**
@@ -15976,7 +15997,7 @@ declare const CreatePanelParamsSchema: z.ZodObject<{
15976
15997
  placeholder?: string | undefined;
15977
15998
  search?: boolean | undefined;
15978
15999
  }>]>, "many">>;
15979
- onClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
16000
+ onClickClose: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
15980
16001
  }, "body" | "footer">, {
15981
16002
  body: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
15982
16003
  onCreate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
@@ -17004,7 +17025,7 @@ declare const CreatePanelParamsSchema: z.ZodObject<{
17004
17025
  placeholder?: string | undefined;
17005
17026
  search?: boolean | undefined;
17006
17027
  })[] | undefined;
17007
- onClose?: ((...args: unknown[]) => void) | undefined;
17028
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
17008
17029
  }, {
17009
17030
  body: ({
17010
17031
  type: "Button";
@@ -17173,7 +17194,7 @@ declare const CreatePanelParamsSchema: z.ZodObject<{
17173
17194
  placeholder?: string | undefined;
17174
17195
  search?: boolean | undefined;
17175
17196
  })[] | undefined;
17176
- onClose?: ((...args: unknown[]) => void) | undefined;
17197
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
17177
17198
  }>;
17178
17199
  placement: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
17179
17200
  after: z.ZodString;
@@ -17363,7 +17384,7 @@ declare const CreatePanelParamsSchema: z.ZodObject<{
17363
17384
  placeholder?: string | undefined;
17364
17385
  search?: boolean | undefined;
17365
17386
  })[] | undefined;
17366
- onClose?: ((...args: unknown[]) => void) | undefined;
17387
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
17367
17388
  };
17368
17389
  placement?: {
17369
17390
  after: string;
@@ -17541,7 +17562,7 @@ declare const CreatePanelParamsSchema: z.ZodObject<{
17541
17562
  placeholder?: string | undefined;
17542
17563
  search?: boolean | undefined;
17543
17564
  })[] | undefined;
17544
- onClose?: ((...args: unknown[]) => void) | undefined;
17565
+ onClickClose?: ((...args: unknown[]) => void) | undefined;
17545
17566
  };
17546
17567
  placement?: {
17547
17568
  after: string;