@wix/react-component-schema 1.8.0 → 1.10.0

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/index.d.ts CHANGED
@@ -57,7 +57,9 @@ declare enum A11yAttributes {
57
57
  /** The value used for aria-multiline */
58
58
  ariaMultiline = "ariaMultiline",
59
59
  /** The value used for aria-invalid */
60
- ariaInvalid = "ariaInvalid"
60
+ ariaInvalid = "ariaInvalid",
61
+ /** The value used for lang attribute */
62
+ lang = "lang"
61
63
  }
62
64
 
63
65
  export declare type Action = ApiAction;
@@ -116,7 +118,8 @@ declare enum ActionType {
116
118
  style = "style",
117
119
  displayGroup = "displayGroup",
118
120
  cssProperty = "cssProperty",
119
- cssCustomProperty = "cssCustomProperty"
121
+ cssCustomProperty = "cssCustomProperty",
122
+ dashboard = "dashboard"
120
123
  }
121
124
 
122
125
  declare interface ApiAction {
@@ -127,6 +130,11 @@ declare interface ApiAction {
127
130
  displayName?: string;
128
131
  /** A model definition for declaring a concrete instructions action will perform */
129
132
  execution?: Execution;
133
+ /**
134
+ * A description of this action
135
+ * @maxLength 300
136
+ */
137
+ description?: string | null;
130
138
  }
131
139
 
132
140
  /** @oneof */
@@ -137,7 +145,7 @@ declare interface ApiArrayItemsArrayDataOneOf {
137
145
  dataItem?: DataItem;
138
146
  /**
139
147
  * Marks this array as one whose item types are dynamic and resolved at runtime.
140
- * Only applicable when a template container (containerType = TEMPLATE) has a data_item_key
148
+ * Only applicable when a template container (containerType = TEMPLATE) has an item_key
141
149
  * that references this array. Mutually exclusive with 'data' and 'data_item'.
142
150
  */
143
151
  dynamicItems?: boolean | null;
@@ -155,6 +163,20 @@ declare interface ApiBackgroundImage {
155
163
  vectorArtCategory?: VectorArtCategoryTypes;
156
164
  }
157
165
 
166
+ declare interface ApiContext {
167
+ /** A map of keys describing the context provided by this component */
168
+ items?: Record<string, ContextItem>;
169
+ /** Named preview states this context can be rendered in, keyed by state key */
170
+ states?: Record<string, ContextState>;
171
+ /** Display groups for the top-level context items, used to group and order them in the editor for better UX */
172
+ displayGroups?: Record<string, ContextDisplayGroup>;
173
+ /**
174
+ * Human friendly name of the context for human readability
175
+ * @maxLength 50
176
+ */
177
+ displayName?: string | null;
178
+ }
179
+
158
180
  export declare enum ARCHETYPE {
159
181
  UNKNOWN_Archetype = "UNKNOWN_Archetype",
160
182
  Button = "Button",
@@ -208,7 +230,7 @@ export declare interface ArrayItems extends ApiArrayItemsArrayDataOneOf {
208
230
  dataItem?: DataItem;
209
231
  /**
210
232
  * Marks this array as one whose item types are dynamic and resolved at runtime.
211
- * Only applicable when a template container (containerType = TEMPLATE) has a data_item_key
233
+ * Only applicable when a template container (containerType = TEMPLATE) has an item_key
212
234
  * that references this array. Mutually exclusive with 'data' and 'data_item'.
213
235
  */
214
236
  dynamicItems?: boolean | null;
@@ -421,6 +443,11 @@ export declare const ButtonVariableNames: {
421
443
  readonly 'wst-button-tertiary-text-highlight': "wst-button-tertiary-text-highlight";
422
444
  };
423
445
 
446
+ declare interface ChangeEvent {
447
+ /** The type of input this change event originates from */
448
+ inputType?: InputTypeEnumInputType;
449
+ }
450
+
424
451
  declare interface ClientResources {
425
452
  /**
426
453
  * A URL to an ESM javascript bundle. It's default export should be the component
@@ -582,6 +609,126 @@ declare enum ContentResizeDirection {
582
609
  none = "none"
583
610
  }
584
611
 
612
+ /** An array of data items or complex data types */
613
+ declare interface ContextArrayItems extends ContextArrayItemsArrayDataOneOf {
614
+ /** Specify the type of data inside the array */
615
+ item?: ContextItem;
616
+ }
617
+
618
+ /** @oneof */
619
+ declare interface ContextArrayItemsArrayDataOneOf {
620
+ /** Specify the type of data inside the array */
621
+ item?: ContextItem;
622
+ }
623
+
624
+ /** A map of keys describing the context items provided by this component */
625
+ declare interface ContextDataItems {
626
+ /** A map of keys describing the data items provided by this component */
627
+ items?: Record<string, ContextItem>;
628
+ /** For sub types that implement parts of context, points to a context provider component type */
629
+ contextImplementor?: ContextImplementor;
630
+ /** Display groups for this context-data object's own items, used to group and order them in the editor for better UX */
631
+ displayGroups?: Record<string, ContextDisplayGroup>;
632
+ }
633
+
634
+ /** A labeled, ordered grouping of context items, used to group and order them in the editor for better UX */
635
+ declare interface ContextDisplayGroup {
636
+ /**
637
+ * Display name for this group, shown in the editor
638
+ * @maxLength 20
639
+ */
640
+ displayName?: string | null;
641
+ /**
642
+ * The context items in this group, referenced by their key in the items map of the enclosing message
643
+ * (Context or ContextDataItems). Reuses the same ItemsGroup mechanism as editor-react display groups;
644
+ * array order defines the display/sort order.
645
+ */
646
+ items?: ItemsGroup;
647
+ }
648
+
649
+ declare interface ContextImplementor {
650
+ /**
651
+ * The component type to implement the context item
652
+ * @maxLength 100
653
+ */
654
+ componentType?: string;
655
+ /**
656
+ * The prop key the component expects the context to be passed in to it (optional)
657
+ * @maxLength 100
658
+ */
659
+ propKey?: string | null;
660
+ }
661
+
662
+ declare interface ContextItem extends ContextItemSelectedDataTypeOneOf {
663
+ /** For arrays, the items are defined here */
664
+ arrayItems?: ContextArrayItems;
665
+ /** For data objects, the items are defined here */
666
+ data?: ContextDataItems;
667
+ /** For functions, the function definition is defined here */
668
+ function?: EditorFunction;
669
+ /** For text enums, the enum options are defined here */
670
+ textEnum?: TextEnum;
671
+ /** The type exposed by the context item (can't be "container") */
672
+ dataType?: DataType;
673
+ /**
674
+ * The display name of the context item for user facing and AI usage
675
+ * @maxLength 100
676
+ */
677
+ displayName?: string | null;
678
+ /** For sub types that implement parts of context, points to a context provider component type */
679
+ contextImplementor?: ContextImplementor;
680
+ /* Excluded from this release type: deprecated */
681
+ /* Excluded from this release type: spec */
682
+ /**
683
+ * A description of the context item for user facing and AI usage
684
+ * @maxLength 300
685
+ */
686
+ description?: string | null;
687
+ }
688
+
689
+ /** @oneof */
690
+ declare interface ContextItemSelectedDataTypeOneOf {
691
+ /** For arrays, the items are defined here */
692
+ arrayItems?: ContextArrayItems;
693
+ /** For data objects, the items are defined here */
694
+ data?: ContextDataItems;
695
+ /** For functions, the function definition is defined here */
696
+ function?: EditorFunction;
697
+ /** For text enums, the enum options are defined here */
698
+ textEnum?: TextEnum;
699
+ }
700
+
701
+ declare interface ContextReferences {
702
+ /**
703
+ * Available contexts in this container that were defined in the editorElement.contexts
704
+ * Example: itemsList
705
+ */
706
+ local?: string[];
707
+ /**
708
+ * A list of contexts this component exposes because it uses other context providers inside it's code
709
+ * Example: @wix/stores-products-list-context
710
+ */
711
+ reference?: string[];
712
+ }
713
+
714
+ /** A named preview state this context can be rendered in */
715
+ declare interface ContextState {
716
+ /**
717
+ * Display name of this state for user facing and AI usage
718
+ * @maxLength 100
719
+ */
720
+ displayName?: string | null;
721
+ /**
722
+ * A description of this state for user facing and AI usage
723
+ * @maxLength 300
724
+ */
725
+ description?: string | null;
726
+ /** The props to apply to activate this state */
727
+ props?: Record<string, any>;
728
+ /** The context item whose value the context applies in this state, given the props */
729
+ contextItem?: StateContextItem;
730
+ }
731
+
585
732
  export declare interface Coordinates {
586
733
  /**
587
734
  * Stores the top coordinate of the property shorthand
@@ -709,6 +856,12 @@ export declare interface CssCustomPropertyItem extends CssCustomPropertyItemSele
709
856
  defaultValue?: any;
710
857
  /** The default values for the css-property-item when the component is in one of the defined states */
711
858
  statesDefaultValues?: Record<string, any>;
859
+ /**
860
+ * A description of this css-custom-property-item
861
+ * @maxLength 300
862
+ */
863
+ description?: string | null;
864
+ /* Excluded from this release type: spec */
712
865
  }
713
866
 
714
867
  /** @oneof */
@@ -989,6 +1142,12 @@ export declare interface CssPropertyItem extends CssPropertyItemSelectedCssPrope
989
1142
  /** The default values for the css-property-item when the component is in one of the defined states */
990
1143
  statesDefaultValues?: Record<string, any>;
991
1144
  /* Excluded from this release type: deprecated */
1145
+ /**
1146
+ * A description of this css-property-item
1147
+ * @maxLength 300
1148
+ */
1149
+ description?: string | null;
1150
+ /* Excluded from this release type: spec */
992
1151
  }
993
1152
 
994
1153
  declare interface CssPropertyItemDefaults {
@@ -1010,6 +1169,11 @@ export declare interface CssPropertyItemDefinitionOverrides {
1010
1169
  defaultValue?: any;
1011
1170
  /** The default values for the css-property-item when the component is in one of the defined states */
1012
1171
  statesDefaultValues?: Record<string, any>;
1172
+ /**
1173
+ * A description of this css-property-item
1174
+ * @maxLength 300
1175
+ */
1176
+ description?: string | null;
1013
1177
  }
1014
1178
 
1015
1179
  /** @oneof */
@@ -1200,6 +1364,34 @@ declare interface CustomEnumOptionCssProperty {
1200
1364
  value?: string;
1201
1365
  }
1202
1366
 
1367
+ /** A custom filter operator definition beyond the built-in FilterOperator set */
1368
+ declare interface CustomFilterOperator {
1369
+ /**
1370
+ * The operator name as it will be passed in the filter object in the component's props.
1371
+ * Use the bare operator name without the leading `$` (e.g. `eq`, not `$eq`),
1372
+ * matching the FilterOperator enum convention.
1373
+ * @maxLength 20
1374
+ */
1375
+ name?: string | null;
1376
+ /**
1377
+ * Human-readable display name for this custom operator
1378
+ * @maxLength 100
1379
+ */
1380
+ displayName?: string | null;
1381
+ /**
1382
+ * A description of this custom filter operator
1383
+ * @maxLength 300
1384
+ */
1385
+ description?: string | null;
1386
+ /**
1387
+ * The value type this operator expects. When omitted, the operator is passed
1388
+ * with no value.
1389
+ */
1390
+ valueType?: FilterOperatorValueType;
1391
+ /** In case of text enum - a required list of options to supply to the users to choose from */
1392
+ textEnum?: TextEnum;
1393
+ }
1394
+
1203
1395
  export declare interface CustomPropertyEnum {
1204
1396
  /** The type of the css-custom-property, used to define the type of the values allowed in the enum */
1205
1397
  cssPropertyType?: CssPropertyEnumCssPropertyType;
@@ -1222,6 +1414,11 @@ export declare interface CustomPropertyEnumOption {
1222
1414
  */
1223
1415
  displayName?: string | null;
1224
1416
  /* Excluded from this release type: appliedStyles */
1417
+ /**
1418
+ * A description of this enum option
1419
+ * @maxLength 300
1420
+ */
1421
+ description?: string | null;
1225
1422
  }
1226
1423
 
1227
1424
  declare interface CustomPropertyEnumOptionStyle {
@@ -1253,6 +1450,42 @@ export declare interface DashboardAction {
1253
1450
  dashboardPageId?: string;
1254
1451
  /** A model definition for declaring a concrete instructions action will perform */
1255
1452
  execution?: Execution;
1453
+ /**
1454
+ * A description of this dashboard action
1455
+ * @maxLength 300
1456
+ */
1457
+ description?: string | null;
1458
+ }
1459
+
1460
+ /**
1461
+ * A dashboard (back-office) target - the page id only. Unlike DashboardAction
1462
+ * (which embeds an Execution), this leaf carries no nested Execution, so it can
1463
+ * be referenced from Execution (as a `dashboard` execution) without a cycle.
1464
+ */
1465
+ declare interface DashboardPageAction {
1466
+ /**
1467
+ * pageId of the dashboard in case there is more than one
1468
+ * @minLength 4
1469
+ * @maxLength 50
1470
+ */
1471
+ dashboardPageId?: string;
1472
+ /** Optional pre-defined anchor within the page, and values for its expected url params */
1473
+ pageAnchor?: DashboardPageAnchor;
1474
+ }
1475
+
1476
+ /**
1477
+ * A pre-defined anchor (e.g. a tab/section) within a dashboard page, along with
1478
+ * values for the url params that anchor expects.
1479
+ */
1480
+ declare interface DashboardPageAnchor {
1481
+ /**
1482
+ * The id of the pre-defined anchor (PageAnchor.id), used to reference it externally
1483
+ * @minLength 1
1484
+ * @maxLength 50
1485
+ */
1486
+ id?: string;
1487
+ /** Values for the pre-defined url params expected by this anchor, keyed by param name */
1488
+ urlParams?: Record<string, string>;
1256
1489
  }
1257
1490
 
1258
1491
  /**
@@ -1322,6 +1555,10 @@ export declare interface DataItem extends DataItemSelectedDataTypeOneOf {
1322
1555
  data?: DataItems;
1323
1556
  /** A definition of a custom function */
1324
1557
  function?: EditorFunction;
1558
+ /** A definition of what fields are available for filtering */
1559
+ filter?: FilterDefinition;
1560
+ /** A definition of what fields are available for sorting */
1561
+ sort?: SortDefinition;
1325
1562
  /** Defines the type of data we are configuring */
1326
1563
  dataType?: DataType;
1327
1564
  /**
@@ -1332,8 +1569,14 @@ export declare interface DataItem extends DataItemSelectedDataTypeOneOf {
1332
1569
  /** The default value of this data item (only for display purposes). */
1333
1570
  defaultValue?: any;
1334
1571
  /* Excluded from this release type: deprecated */
1572
+ /* Excluded from this release type: spec */
1335
1573
  /** Disables the ability to delete this data-item value in the Editor UI */
1336
1574
  disableDeletion?: boolean | null;
1575
+ /**
1576
+ * A description of this data item
1577
+ * @maxLength 300
1578
+ */
1579
+ description?: string | null;
1337
1580
  }
1338
1581
 
1339
1582
  declare interface DataItemOverrides extends DataItemOverridesSelectedDataTypeOneOf {
@@ -1354,6 +1597,11 @@ declare interface DataItemOverrides extends DataItemOverridesSelectedDataTypeOne
1354
1597
  displayName?: string | null;
1355
1598
  /** Overrides the ability to delete this data-item value in the Editor UI */
1356
1599
  disableDeletion?: boolean | null;
1600
+ /**
1601
+ * Overrides the description of this data-item
1602
+ * @maxLength 300
1603
+ */
1604
+ description?: string | null;
1357
1605
  }
1358
1606
 
1359
1607
  /** @oneof */
@@ -1402,6 +1650,10 @@ declare interface DataItemSelectedDataTypeOneOf {
1402
1650
  data?: DataItems;
1403
1651
  /** A definition of a custom function */
1404
1652
  function?: EditorFunction;
1653
+ /** A definition of what fields are available for filtering */
1654
+ filter?: FilterDefinition;
1655
+ /** A definition of what fields are available for sorting */
1656
+ sort?: SortDefinition;
1405
1657
  }
1406
1658
 
1407
1659
  export declare type DataItemsMap = NonNullable<DataItems['items']>;
@@ -1500,16 +1752,24 @@ declare enum DataType {
1500
1752
  data = "data",
1501
1753
  /** A custom function that can be used to call a function from a custom library */
1502
1754
  'function' = "function",
1503
- /** Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event), can also handle: `()=>void` */
1755
+ /** Deprecated: use function with pointerEvent parameter. Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event) */
1504
1756
  onClick = "onClick",
1505
- /** Standard input event [onChange](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) for text inputs, can also handle: `(value: string) => void` */
1757
+ /** Deprecated: use function with changeEvent parameter. Standard [onChange handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) */
1506
1758
  onChange = "onChange",
1507
- /** Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event), can also handle: `(event: KeyboardEvent) => void` */
1759
+ /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event) */
1508
1760
  onKeyPress = "onKeyPress",
1509
- /** Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event), can also handle: `(event: KeyboardEvent) => void` */
1761
+ /** Deprecated: use function with keyboardEvent parameter. Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event) */
1510
1762
  onKeyUp = "onKeyUp",
1511
- /** Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event), can also handle: `() => void` */
1512
- onSubmit = "onSubmit"
1763
+ /** Deprecated: use function with submitEvent parameter. Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event) */
1764
+ onSubmit = "onSubmit",
1765
+ /** A WQL-compliant filter definition for querying data */
1766
+ filter = "filter",
1767
+ /** A WQL-compliant sort definition for ordering data */
1768
+ sort = "sort",
1769
+ /** A media type that is ONLY used for binding and not stored in the document store of the site */
1770
+ visualMedia = "visualMedia",
1771
+ /** RicosDocument object type. */
1772
+ ricosDocument = "ricosDocument"
1513
1773
  }
1514
1774
 
1515
1775
  declare interface DefaultPresets {
@@ -1595,6 +1855,8 @@ declare interface DisplayFilters_2 {
1595
1855
  cssCustomProperties?: DisplayFilter;
1596
1856
  /** DisplayFilter for states, defines which states to hide or show, uses the state key in the states map, optional */
1597
1857
  states?: DisplayFilter;
1858
+ /** DisplayFilter for presets, defines which presets to hide or show, uses the preset key in the presets map, optional */
1859
+ presets?: DisplayFilter;
1598
1860
  }
1599
1861
 
1600
1862
  /**
@@ -1613,14 +1875,16 @@ declare interface DisplayGroupAction {
1613
1875
  export declare interface DisplayGroupItem extends DisplayGroupItemSelectedGroupTypeOneOf {
1614
1876
  /** A group that contains cssCustomProperties items that used one of the supported css-data-types (length, angle, number, ..._) */
1615
1877
  cssDataType?: ItemsGroup;
1616
- /** A group that contains data items */
1878
+ /** A group that contains data items, should be used for grouping and ordering purposes in the editor */
1617
1879
  data?: ItemsGroup;
1618
1880
  /** A group that contains preset items, which will be displayed in the editor as a category in the presets panel */
1619
1881
  presets?: ItemsGroup;
1620
- /** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used mostly for ordering purposes */
1882
+ /** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used for grouping and ordering purposes */
1621
1883
  cssCustomProperties?: ItemsGroup;
1622
- /** A group that contains other displayGroups items that use the same groupType, should be used mostly for ordering purposes */
1884
+ /** A group that contains other displayGroups items that use the same groupType, should be used for ordering purposes */
1623
1885
  displayGroups?: ItemsGroup;
1886
+ /** A group that contains elements that belong to the current element in the component, array order defines the display order to the elements in panels. Each item is the element name. */
1887
+ elements?: ItemsGroup;
1624
1888
  /** A group that contains background items */
1625
1889
  background?: ShorthandGroupBackground;
1626
1890
  /** A group that contains margin items */
@@ -1657,6 +1921,8 @@ export declare interface DisplayGroupItem extends DisplayGroupItemSelectedGroupT
1657
1921
  borderStyle?: Coordinates;
1658
1922
  /** a group that contains items related to text */
1659
1923
  text?: TextGroup;
1924
+ /** A group that contains items related to stroke */
1925
+ stroke?: StrokeGroup;
1660
1926
  /** A group that contains data-items related to arrayItems, will be used for enhancing the editor experience when editing them */
1661
1927
  arrayItems?: DataGroupsArrayItems;
1662
1928
  /** A group that contains common data-items that are used within array-item objects, will be used for enhancing the editor experience when editing them */
@@ -1668,20 +1934,27 @@ export declare interface DisplayGroupItem extends DisplayGroupItemSelectedGroupT
1668
1934
  displayName?: string | null;
1669
1935
  /** The type of the group, used to determine the group that will be displayed in the editor */
1670
1936
  groupType?: GroupType;
1937
+ /**
1938
+ * A description of this Group
1939
+ * @maxLength 300
1940
+ */
1941
+ description?: string | null;
1671
1942
  }
1672
1943
 
1673
1944
  /** @oneof */
1674
1945
  declare interface DisplayGroupItemSelectedGroupTypeOneOf {
1675
1946
  /** A group that contains cssCustomProperties items that used one of the supported css-data-types (length, angle, number, ..._) */
1676
1947
  cssDataType?: ItemsGroup;
1677
- /** A group that contains data items */
1948
+ /** A group that contains data items, should be used for grouping and ordering purposes in the editor */
1678
1949
  data?: ItemsGroup;
1679
1950
  /** A group that contains preset items, which will be displayed in the editor as a category in the presets panel */
1680
1951
  presets?: ItemsGroup;
1681
- /** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used mostly for ordering purposes */
1952
+ /** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used for grouping and ordering purposes */
1682
1953
  cssCustomProperties?: ItemsGroup;
1683
- /** A group that contains other displayGroups items that use the same groupType, should be used mostly for ordering purposes */
1954
+ /** A group that contains other displayGroups items that use the same groupType, should be used for ordering purposes */
1684
1955
  displayGroups?: ItemsGroup;
1956
+ /** A group that contains elements that belong to the current element in the component, array order defines the display order to the elements in panels. Each item is the element name. */
1957
+ elements?: ItemsGroup;
1685
1958
  /** A group that contains background items */
1686
1959
  background?: ShorthandGroupBackground;
1687
1960
  /** A group that contains margin items */
@@ -1718,6 +1991,8 @@ declare interface DisplayGroupItemSelectedGroupTypeOneOf {
1718
1991
  borderStyle?: Coordinates;
1719
1992
  /** a group that contains items related to text */
1720
1993
  text?: TextGroup;
1994
+ /** A group that contains items related to stroke */
1995
+ stroke?: StrokeGroup;
1721
1996
  /** A group that contains data-items related to arrayItems, will be used for enhancing the editor experience when editing them */
1722
1997
  arrayItems?: DataGroupsArrayItems;
1723
1998
  /** A group that contains common data-items that are used within array-item objects, will be used for enhancing the editor experience when editing them */
@@ -1751,7 +2026,15 @@ declare enum DisplayValueEnumDisplayValue {
1751
2026
  inlineTable = "inlineTable",
1752
2027
  inlineFlex = "inlineFlex",
1753
2028
  inlineGrid = "inlineGrid",
1754
- listItem = "listItem"
2029
+ listItem = "listItem",
2030
+ tableRowGroup = "tableRowGroup",
2031
+ tableHeaderGroup = "tableHeaderGroup",
2032
+ tableFooterGroup = "tableFooterGroup",
2033
+ tableRow = "tableRow",
2034
+ tableCell = "tableCell",
2035
+ tableColumnGroup = "tableColumnGroup",
2036
+ tableColumn = "tableColumn",
2037
+ tableCaption = "tableCaption"
1755
2038
  }
1756
2039
 
1757
2040
  export declare const DOM_EVENT: {
@@ -1764,6 +2047,20 @@ export declare const DOM_EVENT: {
1764
2047
 
1765
2048
  export declare type DomEvent = (typeof DOM_EVENT)[keyof typeof DOM_EVENT];
1766
2049
 
2050
+ declare enum DomEventType {
2051
+ UNKNOWN_DomEventType = "UNKNOWN_DomEventType",
2052
+ /** Value change event (https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) */
2053
+ CHANGE = "CHANGE",
2054
+ /** Pointer interaction event (https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent) */
2055
+ POINTER = "POINTER",
2056
+ /** Keyboard interaction event (https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) */
2057
+ KEYBOARD = "KEYBOARD",
2058
+ /** Focus and blur event (https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent) */
2059
+ FOCUS = "FOCUS",
2060
+ /** Form submission event (https://developer.mozilla.org/en-US/docs/Web/API/SubmitEvent) */
2061
+ SUBMIT = "SUBMIT"
2062
+ }
2063
+
1767
2064
  declare interface EditorDependencies {
1768
2065
  /**
1769
2066
  * A list of service dependencies required by the component, example: ['@wix/environment']
@@ -1789,7 +2086,11 @@ export declare type EditorElement = EditorElement_2 & RequiredFields<EditorEleme
1789
2086
  presets?: Record<string, PresetItem>;
1790
2087
  };
1791
2088
 
1792
- declare interface EditorElement_2 {
2089
+ declare interface EditorElement_2 extends EditorElementSelectedPartElementTypeOneOf {
2090
+ /** Media-specific selectors for parts of type media */
2091
+ media?: PartMedia;
2092
+ /** Container-specific selectors for parts of type container */
2093
+ container?: PartContainer;
1793
2094
  /**
1794
2095
  * DOM Query selector for this element that we can use to find it when rendering it (preferably a className)
1795
2096
  * @minLength 4
@@ -1803,6 +2104,8 @@ declare interface EditorElement_2 {
1803
2104
  displayName?: string;
1804
2105
  /** data-api of this element, a map of data-items where the key is the data-item name and the value is the data-item definition. These will be manifested as `props` for the component */
1805
2106
  data?: Record<string, DataItem>;
2107
+ /** A map of contexts this component exposes inside containers it supports */
2108
+ contexts?: Record<string, ApiContext>;
1806
2109
  /** elements-map of this element, a map of inner-elements where the key is the element name and the value is the element definition */
1807
2110
  elements?: Record<string, ElementItem>;
1808
2111
  /** Native actions specified for the component */
@@ -1832,6 +2135,13 @@ declare interface EditorElement_2 {
1832
2135
  cssCustomProperties?: Record<string, CssCustomPropertyItem>;
1833
2136
  /** A reference to a help article for this element */
1834
2137
  helpArticle?: HelpArticle;
2138
+ /**
2139
+ * A description of the editor element
2140
+ * @maxLength 300
2141
+ */
2142
+ description?: string | null;
2143
+ /** The semantic part-type of this element. */
2144
+ partType?: PartType;
1835
2145
  }
1836
2146
 
1837
2147
  /** Top-level message containing all layout capabilities */
@@ -1852,6 +2162,14 @@ export declare interface EditorElementLayout {
1852
2162
  disableDuplication?: boolean | null;
1853
2163
  }
1854
2164
 
2165
+ /** @oneof */
2166
+ declare interface EditorElementSelectedPartElementTypeOneOf {
2167
+ /** Media-specific selectors for parts of type media */
2168
+ media?: PartMedia;
2169
+ /** Container-specific selectors for parts of type container */
2170
+ container?: PartContainer;
2171
+ }
2172
+
1855
2173
  declare interface EditorFunction {
1856
2174
  /**
1857
2175
  * The Parameters expected by the function, can be empty
@@ -1873,6 +2191,8 @@ declare interface EditorFunction {
1873
2191
  */
1874
2192
  description?: string | null;
1875
2193
  /* Excluded from this release type: deprecated */
2194
+ /** The role of the function, describing the purpose it serves */
2195
+ role?: FunctionRole;
1876
2196
  }
1877
2197
 
1878
2198
  /** The full model for an imported component set in DEV Center */
@@ -1897,6 +2217,8 @@ export declare interface EditorReactComponent {
1897
2217
  installation?: InstallationInfo;
1898
2218
  /** Module configuration for NPM-based component */
1899
2219
  moduleConfiguration?: EditorReactComponentModuleConfiguration;
2220
+ /* Excluded from this release type: schemaUrl */
2221
+ /* Excluded from this release type: managingAppId */
1900
2222
  }
1901
2223
 
1902
2224
  declare interface EditorReactComponentModuleConfiguration {
@@ -1917,21 +2239,32 @@ declare enum EffectGroup {
1917
2239
  }
1918
2240
 
1919
2241
  export declare interface ElementItem extends ElementItemSelectedElementTypeOneOf {
1920
- /** An new element definition */
2242
+ /** A new element definition */
1921
2243
  inlineElement?: InlineElement;
1922
2244
  /** A reference to the used element with overrides */
1923
2245
  refElement?: RefElement;
2246
+ /**
2247
+ * A visual only element that requires a semantic part definition.
2248
+ * Should be used when the current element has several visual elements that need to be targeted separately for styling or animations
2249
+ */
2250
+ partElement?: PartElement;
1924
2251
  /** Defines the type of element we are configuring */
1925
2252
  elementType?: ElementTypeEnumElementType;
1926
2253
  /* Excluded from this release type: deprecated */
2254
+ /* Excluded from this release type: spec */
1927
2255
  }
1928
2256
 
1929
2257
  /** @oneof */
1930
2258
  declare interface ElementItemSelectedElementTypeOneOf {
1931
- /** An new element definition */
2259
+ /** A new element definition */
1932
2260
  inlineElement?: InlineElement;
1933
2261
  /** A reference to the used element with overrides */
1934
2262
  refElement?: RefElement;
2263
+ /**
2264
+ * A visual only element that requires a semantic part definition.
2265
+ * Should be used when the current element has several visual elements that need to be targeted separately for styling or animations
2266
+ */
2267
+ partElement?: PartElement;
1935
2268
  }
1936
2269
 
1937
2270
  export declare const ELEMENTS: {
@@ -1964,14 +2297,11 @@ declare interface ElementState {
1964
2297
  displayFilters?: DisplayFilters_2;
1965
2298
  /** The element that needs to be targeted when this state is applied */
1966
2299
  target?: TargetElement;
1967
- }
1968
-
1969
- /** DEPRECATED: This message is deprecated and will be removed in the future */
1970
- declare interface ElementStyleDefaults {
1971
- /** The default styles for an element */
1972
- style?: Record<string, StyleItemDefaults>;
1973
- /** The default preset and styles for inner elements */
1974
- elements?: Record<string, ElementStyleDefaults>;
2300
+ /**
2301
+ * A description of this state
2302
+ * @maxLength 300
2303
+ */
2304
+ description?: string | null;
1975
2305
  }
1976
2306
 
1977
2307
  declare interface ElementStyleOverrides {
@@ -1980,13 +2310,6 @@ declare interface ElementStyleOverrides {
1980
2310
  * @maxLength 100
1981
2311
  */
1982
2312
  presetKey?: string | null;
1983
- /**
1984
- * The override styles for an element
1985
- * @deprecated The override styles for an element
1986
- * @replacedBy cssProperties or cssCustomProperties
1987
- * @targetRemovalDate 2025-08-01
1988
- */
1989
- style?: Record<string, PresetStyleItemOverrides>;
1990
2313
  /** The override preset and styles for inner elements */
1991
2314
  elements?: Record<string, ElementStyleOverrides>;
1992
2315
  /** The default values for the element css-properties when the preset is selected */
@@ -2000,7 +2323,9 @@ declare enum ElementTypeEnumElementType {
2000
2323
  /** An element that was written as part of the component */
2001
2324
  inlineElement = "inlineElement",
2002
2325
  /** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
2003
- refElement = "refElement"
2326
+ refElement = "refElement",
2327
+ /** A component's part element definition */
2328
+ partElement = "partElement"
2004
2329
  }
2005
2330
 
2006
2331
  /** Executes an event-based action. Triggered event should be intercepted in the editor script */
@@ -2035,6 +2360,11 @@ export declare interface Execution extends ExecutionActionExecuteOneOf {
2035
2360
  cssProperty?: CssPropertyAction;
2036
2361
  /** Executes an action that points into a specific css-custom-property-key, */
2037
2362
  cssCustomProperty?: CssCustomPropertyAction;
2363
+ /**
2364
+ * Opens a back-office (dashboard) page. References the DashboardPageAction
2365
+ * leaf (page id only) - it carries no nested Execution, so Execution stays acyclic.
2366
+ */
2367
+ dashboard?: DashboardPageAction;
2038
2368
  /** The action type allows to determine the return type of the execution function */
2039
2369
  actionType?: ActionType;
2040
2370
  }
@@ -2062,6 +2392,11 @@ declare interface ExecutionActionExecuteOneOf {
2062
2392
  cssProperty?: CssPropertyAction;
2063
2393
  /** Executes an action that points into a specific css-custom-property-key, */
2064
2394
  cssCustomProperty?: CssCustomPropertyAction;
2395
+ /**
2396
+ * Opens a back-office (dashboard) page. References the DashboardPageAction
2397
+ * leaf (page id only) - it carries no nested Execution, so Execution stays acyclic.
2398
+ */
2399
+ dashboard?: DashboardPageAction;
2065
2400
  }
2066
2401
 
2067
2402
  export declare interface Filter {
@@ -2072,6 +2407,16 @@ export declare interface Filter {
2072
2407
  filterFunctions?: FilterFunction[];
2073
2408
  }
2074
2409
 
2410
+ /** Filter type - declares which items are filterable and which operators each item supports */
2411
+ declare interface FilterDefinition {
2412
+ /** Fully described inline filter items */
2413
+ inlineItems?: InlineFilterItem[];
2414
+ /** Filter items referencing existing data items */
2415
+ dataItems?: FilterItem[];
2416
+ /** Filter items referencing existing context items */
2417
+ contextItems?: FilterItem[];
2418
+ }
2419
+
2075
2420
  declare enum FilterFunction {
2076
2421
  UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
2077
2422
  /** The value used for blur filter */
@@ -2100,6 +2445,71 @@ declare enum FilterFunction {
2100
2445
  hueRotate = "hueRotate"
2101
2446
  }
2102
2447
 
2448
+ /** A filter item referencing an existing item (e.g. DataItem or ContextItem) */
2449
+ declare interface FilterItem {
2450
+ /** Path to the item */
2451
+ itemPath?: ItemPath;
2452
+ /** Explicitly supported operators. If omitted, all applicable operators for the resolved type are assumed */
2453
+ operators?: FilterOperator[];
2454
+ /**
2455
+ * Additional custom operators beyond the built-in FilterOperator set.
2456
+ * @maxSize 10
2457
+ */
2458
+ customOperators?: CustomFilterOperator[];
2459
+ /** Configures this filter item as an item-selection field */
2460
+ itemSelection?: ItemSelectionConfig;
2461
+ }
2462
+
2463
+ declare enum FilterOperator {
2464
+ UNKNOWN_FilterOperator = "UNKNOWN_FilterOperator",
2465
+ /** $eq - Equal */
2466
+ eq = "eq",
2467
+ /** $ne - Not equal */
2468
+ ne = "ne",
2469
+ /** $lt - Less than */
2470
+ lt = "lt",
2471
+ /** $lte - Less than or equal */
2472
+ lte = "lte",
2473
+ /** $gt - Greater than */
2474
+ gt = "gt",
2475
+ /** $gte - Greater than or equal */
2476
+ gte = "gte",
2477
+ /** $in - Value is in list */
2478
+ 'in' = "in",
2479
+ /** $nin - Value is not in list */
2480
+ nin = "nin",
2481
+ /** $exists - Field exists (is not null) */
2482
+ exists = "exists",
2483
+ /** $isEmpty - Field value is empty */
2484
+ isEmpty = "isEmpty",
2485
+ /** $startsWith - String starts with (text fields only) */
2486
+ startsWith = "startsWith",
2487
+ /** $hasAll - Array contains all values */
2488
+ hasAll = "hasAll",
2489
+ /** $hasSome - Array contains at least one value */
2490
+ hasSome = "hasSome",
2491
+ /** $matchItems - Filter on inner fields of array items (arrayItems only) */
2492
+ matchItems = "matchItems"
2493
+ }
2494
+
2495
+ declare enum FilterOperatorValueType {
2496
+ UNKNOWN_FilterOperatorValueType = "UNKNOWN_FilterOperatorValueType",
2497
+ /** A simple text value */
2498
+ text = "text",
2499
+ /** A list of predefined textual values to choose from */
2500
+ textEnum = "textEnum",
2501
+ /** Any number */
2502
+ number = "number",
2503
+ /** true / false value */
2504
+ booleanValue = "booleanValue",
2505
+ /** Local date output ISO-8601 extended local date format (YYYY-MM-DD) */
2506
+ localDate = "localDate",
2507
+ /** Local time output ISO-8601 extended local time format (hh:mm[:ss][.sss]) */
2508
+ localTime = "localTime",
2509
+ /** Local Date Time output ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss]) */
2510
+ localDateTime = "localDateTime"
2511
+ }
2512
+
2103
2513
  /** Fixed position builder for component installation */
2104
2514
  declare interface FixedPositionBuilder {
2105
2515
  /** Vertical position in the browser window */
@@ -2183,8 +2593,17 @@ declare interface FunctionParameter extends FunctionParameterSelectedDataTypeOne
2183
2593
  function?: EditorFunction;
2184
2594
  /** In case of a text enum */
2185
2595
  textEnum?: TextEnum;
2186
- /** The type of the Parameter, does not include containers */
2596
+ /** In case of a Change event parameter */
2597
+ changeEvent?: ChangeEvent;
2598
+ /** In case of a link */
2599
+ link?: Link;
2600
+ /**
2601
+ * Exactly one of `data_type` or `dom_event` must be set
2602
+ * A data type parameter
2603
+ */
2187
2604
  dataType?: DataType;
2605
+ /** A DOM event parameter */
2606
+ domEvent?: DomEventType;
2188
2607
  /** Whether the Parameter is optional, limitations of Javascript apply, only the last parameters can be optional */
2189
2608
  optional?: boolean | null;
2190
2609
  /**
@@ -2232,6 +2651,10 @@ declare interface FunctionParameterSelectedDataTypeOneOf {
2232
2651
  function?: EditorFunction;
2233
2652
  /** In case of a text enum */
2234
2653
  textEnum?: TextEnum;
2654
+ /** In case of a Change event parameter */
2655
+ changeEvent?: ChangeEvent;
2656
+ /** In case of a link */
2657
+ link?: Link;
2235
2658
  }
2236
2659
 
2237
2660
  declare interface FunctionReturnType extends FunctionReturnTypeSelectedDataTypeOneOf {
@@ -2265,6 +2688,14 @@ declare interface FunctionReturnTypeSelectedDataTypeOneOf {
2265
2688
  textEnum?: TextEnum;
2266
2689
  }
2267
2690
 
2691
+ declare enum FunctionRole {
2692
+ UNKNOWN_FUNCTION_ROLE = "UNKNOWN_FUNCTION_ROLE",
2693
+ /** The function converts between two data types, mostly useful for context providers and function libraries */
2694
+ data_type_conversion = "data_type_conversion",
2695
+ /** The function handles loading more items in a paginated list */
2696
+ pagination_load_next_page = "pagination_load_next_page"
2697
+ }
2698
+
2268
2699
  export declare interface Gap {
2269
2700
  /**
2270
2701
  * Stores the row-gap property of the gap shorthand
@@ -2294,6 +2725,7 @@ declare enum GroupType {
2294
2725
  presets = "presets",
2295
2726
  cssCustomProperties = "cssCustomProperties",
2296
2727
  displayGroups = "displayGroups",
2728
+ elements = "elements",
2297
2729
  /** Style Shorthand Groups */
2298
2730
  background = "background",
2299
2731
  margin = "margin",
@@ -2314,6 +2746,7 @@ declare enum GroupType {
2314
2746
  gap = "gap",
2315
2747
  /** Mixed Variables Groups */
2316
2748
  text = "text",
2749
+ stroke = "stroke",
2317
2750
  /** Data Groups */
2318
2751
  arrayItems = "arrayItems",
2319
2752
  /** Deprecated, use `listItem` instead */
@@ -2396,9 +2829,13 @@ declare interface InitialSizeSettingSelectedSizingTypeOneOf {
2396
2829
  pixels?: number;
2397
2830
  }
2398
2831
 
2399
- export declare interface InlineElement {
2832
+ export declare interface InlineElement extends InlineElementSelectedPartElementTypeOneOf {
2833
+ /** Media-specific selectors for parts of type media */
2834
+ media?: PartMedia;
2835
+ /** Container-specific selectors for parts of type container */
2836
+ container?: PartContainer;
2400
2837
  /**
2401
- * Relative DOM Query selector for this element to the component root. We assume nesting by it's parent elements for CSS Vars scoping.
2838
+ * Relative DOM Query selector for this element to the component root. We assume nesting by its parent elements for CSS Vars scoping.
2402
2839
  * @minLength 4
2403
2840
  * @maxLength 300
2404
2841
  */
@@ -2441,6 +2878,95 @@ export declare interface InlineElement {
2441
2878
  cssCustomProperties?: Record<string, CssCustomPropertyItem>;
2442
2879
  /** A reference to a help article for this element */
2443
2880
  helpArticle?: HelpArticle;
2881
+ /**
2882
+ * A description of this inline element
2883
+ * @maxLength 300
2884
+ */
2885
+ description?: string | null;
2886
+ /** The semantic part-type of this element. */
2887
+ partType?: PartType;
2888
+ }
2889
+
2890
+ /** @oneof */
2891
+ declare interface InlineElementSelectedPartElementTypeOneOf {
2892
+ /** Media-specific selectors for parts of type media */
2893
+ media?: PartMedia;
2894
+ /** Container-specific selectors for parts of type container */
2895
+ container?: PartContainer;
2896
+ }
2897
+
2898
+ /** An inline filter item definition */
2899
+ declare interface InlineFilterItem {
2900
+ /**
2901
+ * Name of the filtered field
2902
+ * @maxLength 200
2903
+ */
2904
+ name?: string | null;
2905
+ /**
2906
+ * Human-readable name for this field
2907
+ * @maxLength 100
2908
+ */
2909
+ displayName?: string | null;
2910
+ /** The data type of the field (subset of DataType suitable for filtering) */
2911
+ dataType?: DataType;
2912
+ /** Explicitly supported operators. If omitted, all applicable operators for the fieldType are assumed */
2913
+ operators?: FilterOperator[];
2914
+ /**
2915
+ * Additional custom operators beyond the built-in FilterOperator set.
2916
+ * @maxSize 10
2917
+ */
2918
+ customOperators?: CustomFilterOperator[];
2919
+ /**
2920
+ * A description of this filter field
2921
+ * @maxLength 300
2922
+ */
2923
+ description?: string | null;
2924
+ /**
2925
+ * Configures this text filter field as an item-selection field, populated by an items provider implementing the Items
2926
+ * Selection SPI (wix.items_selection.spi_host.v1). provider_key picks the provider; for multi-select use an array item.
2927
+ */
2928
+ itemSelection?: ItemSelectionConfig;
2929
+ }
2930
+
2931
+ /** An inline sort item definition */
2932
+ declare interface InlineSortItem {
2933
+ /**
2934
+ * Name of the sorted field
2935
+ * @maxLength 200
2936
+ */
2937
+ name?: string | null;
2938
+ /**
2939
+ * Human-readable name for this field
2940
+ * @maxLength 100
2941
+ */
2942
+ displayName?: string | null;
2943
+ /**
2944
+ * Human-readable label for the ascending sort order of this field (e.g. "Oldest first")
2945
+ * @maxLength 100
2946
+ */
2947
+ ascendingDisplayName?: string | null;
2948
+ /**
2949
+ * Human-readable label for the descending sort order of this field (e.g. "Newest first")
2950
+ * @maxLength 100
2951
+ */
2952
+ descendingDisplayName?: string | null;
2953
+ /**
2954
+ * A description of this sort field
2955
+ * @maxLength 300
2956
+ */
2957
+ description?: string | null;
2958
+ }
2959
+
2960
+ declare enum InputTypeEnumInputType {
2961
+ UNKNOWN_InputType = "UNKNOWN_InputType",
2962
+ /** target.value (string) - Text inputs, selects, sliders, search boxes */
2963
+ text = "text",
2964
+ /** target.checked (boolean) - Checkboxes, toggles, switches */
2965
+ checkbox = "checkbox",
2966
+ /** target.valueAsNumber (number) - Number inputs, range inputs */
2967
+ number = "number",
2968
+ /** target.valueAsDate (Date) - Date pickers, datetime inputs */
2969
+ date = "date"
2444
2970
  }
2445
2971
 
2446
2972
  declare interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
@@ -2490,15 +3016,50 @@ declare enum InteractionsTrigger {
2490
3016
  animationEnd = "animationEnd"
2491
3017
  }
2492
3018
 
3019
+ declare enum ItemField {
3020
+ /** item.id */
3021
+ ID = "ID",
3022
+ /** item.name */
3023
+ NAME = "NAME",
3024
+ /** item.description */
3025
+ DESCRIPTION = "DESCRIPTION",
3026
+ /** item.note */
3027
+ NOTE = "NOTE"
3028
+ }
3029
+
2493
3030
  /** A path to a data item within the same element scope. */
2494
3031
  declare interface ItemPath {
3032
+ /**
3033
+ * Deprecated, use item_key instead
3034
+ * @deprecated Deprecated, use item_key instead
3035
+ * @replacedBy item_key
3036
+ * @targetRemovalDate 2026-09-30
3037
+ */
3038
+ dataItemKey?: string;
2495
3039
  /**
2496
3040
  * The key of the data item within the element's data scope.
2497
3041
  * Example: "items" – top-level data item 'items'
2498
3042
  * Example: "slides.title" – inner key 'title' of data item 'slides'
2499
3043
  * @minLength 1
2500
3044
  */
2501
- dataItemKey?: string;
3045
+ itemKey?: string;
3046
+ }
3047
+
3048
+ /** Configuration for selecting items from an items provider (e.g. via a dropdown picker) */
3049
+ declare interface ItemSelectionConfig {
3050
+ /**
3051
+ * The key of the items provider to select items from
3052
+ * @minLength 1
3053
+ * @maxLength 100
3054
+ */
3055
+ providerKey?: string;
3056
+ /**
3057
+ * The maximum number of items that can be selected
3058
+ * @min 1
3059
+ */
3060
+ maxSelected?: number | null;
3061
+ /** The item field whose value is stored (defaults to id) */
3062
+ itemField?: ItemField;
2502
3063
  }
2503
3064
 
2504
3065
  export declare interface ItemsGroup {
@@ -2530,6 +3091,14 @@ export declare interface Link {
2530
3091
  * @maxSize 12
2531
3092
  */
2532
3093
  linkTypes?: LinkType[];
3094
+ /**
3095
+ * Allows limiting the link to specific Wix apps, by their app ID, in case of LinkType dynamicPageLink or pageLink
3096
+ * @format GUID
3097
+ * @maxSize 20
3098
+ */
3099
+ appIds?: string[];
3100
+ /** In case of LinkType dynamicPageLink, whether to hide inner routes in the page selection dialog (only top level pages will be selectable) */
3101
+ hideInnerRoute?: boolean | null;
2533
3102
  }
2534
3103
 
2535
3104
  declare enum LinkType {
@@ -2682,6 +3251,11 @@ export declare interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
2682
3251
  /* Excluded from this release type: inline */
2683
3252
  /** The selected panel reference type */
2684
3253
  panelType?: PanelType;
3254
+ /**
3255
+ * Optional hint. When used on a custom action the editor will handle it as if it was a native one.
3256
+ * Will be ignored when used on native actions or when the value `custom` is selected.
3257
+ */
3258
+ actionName?: ACTION_NAME;
2685
3259
  }
2686
3260
 
2687
3261
  /** @oneof */
@@ -2743,6 +3317,71 @@ declare enum PanelType {
2743
3317
  inline = "inline"
2744
3318
  }
2745
3319
 
3320
+ declare interface PartContainer {
3321
+ /**
3322
+ * A CSS selector for an element inside the container part, wrapping container background content
3323
+ * @minLength 4
3324
+ * @maxLength 300
3325
+ */
3326
+ backgroundSelector?: string | null;
3327
+ /**
3328
+ * A CSS selector for an element inside the container part, wrapping container's contents
3329
+ * @minLength 4
3330
+ * @maxLength 300
3331
+ */
3332
+ contentSelector?: string | null;
3333
+ }
3334
+
3335
+ declare interface PartElement extends PartElementSelectedPartElementTypeOneOf {
3336
+ /** Media-specific selectors for parts of type media */
3337
+ media?: PartMedia;
3338
+ /** Container-specific selectors for parts of type container */
3339
+ container?: PartContainer;
3340
+ /** The type of the part element. */
3341
+ partType?: PartType;
3342
+ /**
3343
+ * A CSS selector for the part element relative to its parent
3344
+ * @minLength 4
3345
+ * @maxLength 300
3346
+ */
3347
+ selector?: string;
3348
+ }
3349
+
3350
+ /** @oneof */
3351
+ declare interface PartElementSelectedPartElementTypeOneOf {
3352
+ /** Media-specific selectors for parts of type media */
3353
+ media?: PartMedia;
3354
+ /** Container-specific selectors for parts of type container */
3355
+ container?: PartContainer;
3356
+ }
3357
+
3358
+ declare interface PartMedia {
3359
+ /**
3360
+ * A CSS selector for an element wrapping the media layer element
3361
+ * @minLength 4
3362
+ * @maxLength 300
3363
+ */
3364
+ wrapperSelector?: string | null;
3365
+ /**
3366
+ * A CSS selector for an element wrapping the media wrapper element
3367
+ * @minLength 4
3368
+ * @maxLength 300
3369
+ */
3370
+ clipSelector?: string | null;
3371
+ }
3372
+
3373
+ declare enum PartType {
3374
+ UNKNOWN_PartType = "UNKNOWN_PartType",
3375
+ /** An element containing text content */
3376
+ text = "text",
3377
+ /** An element containing SVG content */
3378
+ svg = "svg",
3379
+ /** An element containing media content (raster, image or video) */
3380
+ media = "media",
3381
+ /** An inner wrapper element for a container component */
3382
+ container = "container"
3383
+ }
3384
+
2746
3385
  declare interface PlaceHolder {
2747
3386
  /**
2748
3387
  * The placeholder definition that this container should accept as defined in DEV Center
@@ -2770,6 +3409,17 @@ declare interface PresetElementDefaults {
2770
3409
  * The Preset is the second in line to affect the display, Element is before and State is after it
2771
3410
  */
2772
3411
  displayFilters?: DisplayFilters_2;
3412
+ /**
3413
+ * A description of the element when this preset is selected
3414
+ * @maxLength 300
3415
+ */
3416
+ description?: string | null;
3417
+ /**
3418
+ * Optional per-preset layout overrides for containers in this element's data scope, keyed by the container's data-item key.
3419
+ * Each key must reference a data item of type 'container' in the same scope. Any field left unset on the
3420
+ * ContainerLayout falls back to the container's own declared layout.
3421
+ */
3422
+ containers?: Record<string, ContainerLayout>;
2773
3423
  }
2774
3424
 
2775
3425
  declare interface PresetInnerElementDefaults {
@@ -2779,21 +3429,17 @@ declare interface PresetInnerElementDefaults {
2779
3429
  cssCustomProperties?: Record<string, CssPropertyItemDefaults>;
2780
3430
  /** The default preset and styles for inner elements */
2781
3431
  elements?: Record<string, PresetInnerElementDefaults>;
3432
+ /**
3433
+ * Optional per-preset layout overrides for containers in this element's data scope, keyed by the container's data-item key.
3434
+ * Each key must reference a data item of type 'container' in this element's scope. Any field left unset on the
3435
+ * ContainerLayout falls back to the container's own declared layout.
3436
+ */
3437
+ containers?: Record<string, ContainerLayout>;
2782
3438
  }
2783
3439
 
2784
3440
  export declare type PresetItem = PresetItem_2 & RequiredFields<PresetItem_2, 'displayName'>;
2785
3441
 
2786
3442
  declare interface PresetItem_2 {
2787
- /**
2788
- * DEPRECATED - use preset_css_url instead
2789
- * @format WEB_URL
2790
- * @minLength 13
2791
- * @maxLength 500
2792
- * @deprecated DEPRECATED - use preset_css_url instead
2793
- * @replacedBy preset_css_url
2794
- * @targetRemovalDate 2025-08-01
2795
- */
2796
- cssUrl?: string;
2797
3443
  /**
2798
3444
  * Preset name for displaying purposes in the editor
2799
3445
  * @maxLength 100
@@ -2807,22 +3453,6 @@ declare interface PresetItem_2 {
2807
3453
  thumbnailUrl?: string | null;
2808
3454
  /** Optional initial size of the component when switching into this preset (will not be applied when element is used as an inner element) */
2809
3455
  initialSize?: ComponentInitialSize;
2810
- /**
2811
- * Display filters for the Preset, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
2812
- * The Preset is the second in line to affect the display, Element is before and State is after it
2813
- * @deprecated Display filters for the Preset, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
2814
- * The Preset is the second in line to affect the display, Element is before and State is after it
2815
- * @replacedBy preset_defaults
2816
- * @targetRemovalDate 2025-08-01
2817
- */
2818
- displayFilters?: DisplayFilters_2;
2819
- /**
2820
- * The default styles for this preset and the inner elements
2821
- * @deprecated The default styles for this preset and the inner elements
2822
- * @replacedBy preset_defaults
2823
- * @targetRemovalDate 2025-08-01
2824
- */
2825
- styleDefaults?: PresetStyleDefaults;
2826
3456
  /** The style overrides for this preset and the inner elements */
2827
3457
  styleOverrides?: BreakpointPresetStyleOverrides;
2828
3458
  /**
@@ -2832,13 +3462,6 @@ declare interface PresetItem_2 {
2832
3462
  * @maxSize 2
2833
3463
  */
2834
3464
  optimizedFor?: BreakpointEnumBreakpoint[];
2835
- /**
2836
- * Optional editor layout behaviors we want to apply when this preset is selected
2837
- * @deprecated Optional editor layout behaviors we want to apply when this preset is selected
2838
- * @replacedBy preset_defaults
2839
- * @targetRemovalDate 2025-08-01
2840
- */
2841
- layout?: EditorElementLayout;
2842
3465
  /**
2843
3466
  * A URL to the CSS file of this preset, to be used when you need to apply many css-changes or default-values to the DOM when this preset is selected, optional
2844
3467
  * @format WEB_URL
@@ -2847,18 +3470,16 @@ declare interface PresetItem_2 {
2847
3470
  presetCssUrl?: string | null;
2848
3471
  /** All the default values that needs to be set when the preset is selected */
2849
3472
  presetDefaults?: PresetElementDefaults;
3473
+ /* Excluded from this release type: spec */
3474
+ /**
3475
+ * A description of this preset
3476
+ * @maxLength 300
3477
+ */
3478
+ description?: string | null;
2850
3479
  }
2851
3480
 
2852
3481
  export declare type Presets = NonNullable<EditorElement_2['presets']>;
2853
3482
 
2854
- /** DEPRECATED: This message is deprecated and will be removed in the future */
2855
- declare interface PresetStyleDefaults {
2856
- /** The default styles for this preset */
2857
- style?: Record<string, StyleItemDefaults>;
2858
- /** The default styles of inner elements for this preset */
2859
- elements?: Record<string, ElementStyleDefaults>;
2860
- }
2861
-
2862
3483
  declare interface PresetStyleItemOverrides {
2863
3484
  /** The override value of this style item */
2864
3485
  value?: any;
@@ -2867,13 +3488,6 @@ declare interface PresetStyleItemOverrides {
2867
3488
  }
2868
3489
 
2869
3490
  declare interface PresetStyleOverrides {
2870
- /**
2871
- * The style overrides for this preset
2872
- * @deprecated The style overrides for this preset
2873
- * @replacedBy cssProperties or cssCustomProperties
2874
- * @targetRemovalDate 2025-08-01
2875
- */
2876
- style?: Record<string, PresetStyleItemOverrides>;
2877
3491
  /** The style overrides of inner elements for this preset */
2878
3492
  elements?: Record<string, ElementStyleOverrides>;
2879
3493
  /** The default values for the element css-properties when the preset is selected */
@@ -2897,12 +3511,25 @@ declare interface ReactElementContainer extends ReactElementContainerSelectedCon
2897
3511
  template?: TemplateContainer;
2898
3512
  /**
2899
3513
  * A DOM Selector that will allow us to target it in the editor
2900
- * @minLength 2
2901
3514
  * @maxLength 100
3515
+ * @deprecated A DOM Selector that will allow us to target it in the editor
3516
+ * @targetRemovalDate 2026-05-31
2902
3517
  */
2903
3518
  selector?: string;
2904
3519
  /** The type of Container to be rendered */
2905
3520
  containerType?: CONTAINER_TYPE;
3521
+ /** Contexts available in this container */
3522
+ contexts?: ContextReferences;
3523
+ /**
3524
+ * An optional override of the display name of the container.
3525
+ * @maxLength 50
3526
+ */
3527
+ displayName?: string | null;
3528
+ /**
3529
+ * An optional override of the description of the container
3530
+ * @maxLength 300
3531
+ */
3532
+ description?: string | null;
2906
3533
  }
2907
3534
 
2908
3535
  /** @oneof */
@@ -2962,6 +3589,11 @@ export declare interface RefElement {
2962
3589
  cssCustomProperties?: Record<string, CssPropertyItemDefinitionOverrides>;
2963
3590
  /** A reference to a help article for this element */
2964
3591
  helpArticle?: HelpArticle;
3592
+ /**
3593
+ * The override of the used element description
3594
+ * @maxLength 300
3595
+ */
3596
+ description?: string | null;
2965
3597
  }
2966
3598
 
2967
3599
  declare interface RefInnerElementDefaults {
@@ -3022,6 +3654,8 @@ declare interface Resources {
3022
3654
  /* Excluded from this release type: viewerReducedModel */
3023
3655
  /* Excluded from this release type: schemaRefsUrl */
3024
3656
  /* Excluded from this release type: viewerRuntimeCss */
3657
+ /** The exported hooks for usage with the contexts defined inside the editorElement. key must ,match key in the contexts map of the editorElement, and the value is the name of the hook that will be used to consume this context in the component code. Example: { "MyContext": "useMyContext" } */
3658
+ contextHooks?: Record<string, string>;
3025
3659
  }
3026
3660
 
3027
3661
  /** rich text data type allow manipulation of text with html & inline styles */
@@ -3145,6 +3779,9 @@ declare interface SimpleContainer {
3145
3779
  /**
3146
3780
  * An optional override of the display name of the container.
3147
3781
  * @maxLength 50
3782
+ * @deprecated
3783
+ * @replacedBy container.display_name
3784
+ * @targetRemovalDate 2026-06-30
3148
3785
  */
3149
3786
  displayName?: string | null;
3150
3787
  }
@@ -3159,6 +3796,63 @@ declare enum SizingType {
3159
3796
  pixels = "pixels"
3160
3797
  }
3161
3798
 
3799
+ /** Sort type - declares which items are available for sorting */
3800
+ declare interface SortDefinition {
3801
+ /** Fully described inline sort items */
3802
+ inlineItems?: InlineSortItem[];
3803
+ /** Sort items referencing existing data items */
3804
+ dataItems?: SortItem[];
3805
+ /** Sort items referencing existing context items */
3806
+ contextItems?: SortItem[];
3807
+ }
3808
+
3809
+ /**
3810
+ * A sort item referencing an existing item (e.g. DataItem or ContextItem),
3811
+ * with optional per-direction display labels.
3812
+ */
3813
+ declare interface SortItem {
3814
+ /** Path to the item */
3815
+ itemPath?: ItemPath;
3816
+ /**
3817
+ * Human-readable label for the ascending sort order of this item (e.g. "Oldest first")
3818
+ * @maxLength 100
3819
+ */
3820
+ ascendingDisplayName?: string | null;
3821
+ /**
3822
+ * Human-readable label for the descending sort order of this item (e.g. "Newest first")
3823
+ * @maxLength 100
3824
+ */
3825
+ descendingDisplayName?: string | null;
3826
+ }
3827
+
3828
+ /** The value the context applies to a context item in a given preview state */
3829
+ declare interface StateContextItem extends StateContextItemValueOneOf {
3830
+ /** The boolean the context applies to a booleanValue context item */
3831
+ booleanValue?: boolean | null;
3832
+ /**
3833
+ * The TextEnum.Option.value the context applies to a textEnum context item
3834
+ * @maxLength 100
3835
+ */
3836
+ enumValue?: string | null;
3837
+ /**
3838
+ * Key of the context.items entry this value applies to. Must reference an existing item whose
3839
+ * data_type is booleanValue or textEnum
3840
+ * @maxLength 100
3841
+ */
3842
+ itemKey?: string | null;
3843
+ }
3844
+
3845
+ /** @oneof */
3846
+ declare interface StateContextItemValueOneOf {
3847
+ /** The boolean the context applies to a booleanValue context item */
3848
+ booleanValue?: boolean | null;
3849
+ /**
3850
+ * The TextEnum.Option.value the context applies to a textEnum context item
3851
+ * @maxLength 100
3852
+ */
3853
+ enumValue?: string | null;
3854
+ }
3855
+
3162
3856
  export declare type States = NonNullable<EditorElement_2['states']>;
3163
3857
 
3164
3858
  declare enum StaticContainer {
@@ -3169,6 +3863,24 @@ declare enum StaticContainer {
3169
3863
  GLOBAL_PAGE = "GLOBAL_PAGE"
3170
3864
  }
3171
3865
 
3866
+ declare interface StrokeGroup {
3867
+ /**
3868
+ * Stores the stroke property of the stroke group
3869
+ * @maxLength 100
3870
+ */
3871
+ stroke?: string | null;
3872
+ /**
3873
+ * Stores the stroke-width property of the stroke group
3874
+ * @maxLength 100
3875
+ */
3876
+ strokeWidth?: string | null;
3877
+ /**
3878
+ * Stores the stroke-opacity property of the stroke group
3879
+ * @maxLength 100
3880
+ */
3881
+ strokeOpacity?: string | null;
3882
+ }
3883
+
3172
3884
  /** DEPRECATED - use CssPropertyAction or CssCustomPropertyAction */
3173
3885
  declare interface StyleAction {
3174
3886
  /**
@@ -3235,14 +3947,6 @@ export declare interface StyleItem extends StyleItemSelectedItemTypeOneOf, Style
3235
3947
  /* Excluded from this release type: deprecated */
3236
3948
  }
3237
3949
 
3238
- /** DEPRECATED: This message is deprecated and will be removed in the future */
3239
- declare interface StyleItemDefaults {
3240
- /** The default value of this style item */
3241
- defaultValue?: any;
3242
- /** The default values for the style-item when the component is in one of the defined states */
3243
- statesDefaultValues?: Record<string, any>;
3244
- }
3245
-
3246
3950
  /** DEPRECATED: This message is deprecated and will be removed in the future */
3247
3951
  declare interface StyleItemOverrides {
3248
3952
  /** Disables the ability to edit this style-item */
@@ -3461,6 +4165,11 @@ declare interface Text_2 {
3461
4165
  * @maxLength 100
3462
4166
  */
3463
4167
  pattern?: string | null;
4168
+ /**
4169
+ * Configures this text as an item-selection field, populated by an items provider implementing the Items
4170
+ * Selection SPI (wix.items_selection.spi_host.v1). provider_key picks the provider; for multi-select use an array of Text.
4171
+ */
4172
+ itemSelection?: ItemSelectionConfig;
3464
4173
  }
3465
4174
  export { Text_2 as Text }
3466
4175
 
@@ -3511,6 +4220,11 @@ declare interface TextEnumOption {
3511
4220
  * @maxLength 100
3512
4221
  */
3513
4222
  displayName?: string;
4223
+ /**
4224
+ * A description of this text item
4225
+ * @maxLength 300
4226
+ */
4227
+ description?: string | null;
3514
4228
  }
3515
4229
 
3516
4230
  export declare interface TextGroup {