@wix/editor 1.505.0 → 1.506.0

package/dist/types/index.d.ts

@@ -163,17 +163,17 @@ type IPanelOptions = {
 /**
  * Methods for interacting with a component from a custom panel.
  *
- * Import `element` from `@wix/editor` to read and update styles, data,
+ * Import `reactElements` from `@wix/editor` to read and update styles, data,
  * presets, and states, and to open editor pickers.
  *
  * @example
  * ```tsx
- * import { element } from '@wix/editor';
+ * import { reactElements } from '@wix/editor';
  *
  * export default function MyPanel() {
  *   const handleClick = async () => {
- *     const data = await element.getData();
- *     await element.setData({ title: 'Updated!' });
+ *     const data = await reactElements.getData();
+ *     await reactElements.setData({ title: 'Updated!' });
  *   };
  *   return <button onClick={handleClick}>Update Title</button>;
  * }
@@ -191,9 +191,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const defs = await element.getStyleDefinitions();
+     * const defs = await reactElements.getStyleDefinitions();
      * ```
      */
     getStyleDefinitions(): Promise<ElementStyleDefinitions>;
@@ -204,9 +204,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const styles = await element.getStyles();
+     * const styles = await reactElements.getStyles();
      * const bgColor = styles.cssProperties.backgroundColor;
      * ```
      */
@@ -216,16 +216,16 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      * import { CssPropertyType } from '@wix/public-editor-platform-sdk';
      *
      * // Using enum (recommended):
-     * await element.setStyles({
+     * await reactElements.setStyles({
      *   cssProperties: { [CssPropertyType.color]: '#fff' }
      * });
      *
      * // Using string literal (also works):
-     * await element.setStyles({
+     * await reactElements.setStyles({
      *   cssProperties: { 'color': '#fff' }
      * });
      * ```
@@ -236,16 +236,16 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      * import { CssPropertyType } from '@wix/public-editor-platform-sdk';
      *
      * // Using enum (recommended):
-     * await element.removeStyles({
+     * await reactElements.removeStyles({
      *   cssPropertiesKeys: [CssPropertyType.color]
      * });
      *
      * // Using string literal (also works):
-     * await element.removeStyles({
+     * await reactElements.removeStyles({
      *   cssPropertiesKeys: ['color']
      * });
      * ```
@@ -258,9 +258,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const defs = await element.getDataDefinitions();
+     * const defs = await reactElements.getDataDefinitions();
      * ```
      */
     getDataDefinitions(): Promise<ElementDataDefinitions>;
@@ -272,9 +272,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const data = await element.getData();
+     * const data = await reactElements.getData();
      * ```
      */
     getData<T extends ElementData = ElementData>(): Promise<T>;
@@ -289,9 +289,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const resolved = await element.getResolvedData({
+     * const resolved = await reactElements.getResolvedData({
      *   dataItemKey: 'heroImage',
      * });
      * ```
@@ -308,9 +308,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * await element.setData({ title: 'New Title', showButton: false });
+     * await reactElements.setData({ title: 'New Title', showButton: false });
      * ```
      */
     setData<T extends ElementData = ElementData>(values: ElementDataInput<T>): Promise<void>;
@@ -321,9 +321,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const presets = await element.getPresetDefinitions();
+     * const presets = await reactElements.getPresetDefinitions();
      * ```
      */
     getPresetDefinitions(): Promise<ElementPresetDefinitions>;
@@ -334,9 +334,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const preset = await element.getAppliedPreset();
+     * const preset = await reactElements.getAppliedPreset();
      * ```
      */
     getAppliedPreset(): Promise<any>;
@@ -348,9 +348,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * await element.applyPreset({ key: 'minimal' });
+     * await reactElements.applyPreset({ key: 'minimal' });
      * ```
      */
     applyPreset(options: {
@@ -364,11 +364,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const groups = await element.getDisplayGroupDefinitions();
+     * const groups = await reactElements.getDisplayGroupDefinitions();
      *
-     * const cssGroups = await element.getDisplayGroupDefinitions({
+     * const cssGroups = await reactElements.getDisplayGroupDefinitions({
      *   filter: { groupType: 'cssDataType' },
      * });
      * ```
@@ -385,9 +385,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const name = await element.getDisplayName();
+     * const name = await reactElements.getDisplayName();
      * ```
      */
     getDisplayName(): Promise<any>;
@@ -398,9 +398,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const state = await element.getState();
+     * const state = await reactElements.getState();
      * ```
      */
     getState(): Promise<any>;
@@ -412,11 +412,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * await element.setState('hover');
+     * await reactElements.setState('hover');
      *
-     * await element.setState(null);
+     * await reactElements.setState(null);
      * ```
      */
     setState(stateKey: string | null): Promise<any>;
@@ -427,9 +427,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const states = await element.getStateDefinitions();
+     * const states = await reactElements.getStateDefinitions();
      * ```
      */
     getStateDefinitions(): Promise<ElementStateDefinitions>;
@@ -442,9 +442,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const unsubscribe = await element.onChange((patch) => {
+     * const unsubscribe = await reactElements.onChange((patch) => {
      *   if (patch.type === 'data') {
      *     console.log('Data changed:', patch.value);
      *   }
@@ -468,11 +468,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const font = await element.selectFont({ styleItemKey: 'headingFont' });
+     * const font = await reactElements.selectFont({ styleItemKey: 'headingFont' });
      *
-     * const font = await element.selectFont({
+     * const font = await reactElements.selectFont({
      *   selectedFontFamily: { family: 'Arial', weight: '400' },
      *   onChange: (value) => console.log('Selected:', value),
      * });
@@ -497,11 +497,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const font = await element.selectFontFamily({ styleItemKey: 'bodyFont' });
+     * const font = await reactElements.selectFontFamily({ styleItemKey: 'bodyFont' });
      *
-     * const font = await element.selectFontFamily({
+     * const font = await reactElements.selectFontFamily({
      *   selectedFontFamily: { family: 'Helvetica', weight: '400' },
      *   onChange: (value) => console.log('Selected:', value.family),
      * });
@@ -528,11 +528,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const media = await element.selectMedia({ dataItemKey: 'heroImage' });
+     * const media = await reactElements.selectMedia({ dataItemKey: 'heroImage' });
      *
-     * const media = await element.selectMedia({
+     * const media = await reactElements.selectMedia({
      *   isMultiSelect: true,
      *   category: 'image',
      * });
@@ -555,11 +555,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const link = await element.selectLink({ dataItemKey: 'buttonLink' });
+     * const link = await reactElements.selectLink({ dataItemKey: 'buttonLink' });
      *
-     * const link = await element.selectLink({
+     * const link = await reactElements.selectLink({
      *   value: currentLink,
      *   options: { linkTypes: ['ExternalLink', 'PageLink'] },
      * });
@@ -585,11 +585,11 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const color = await element.selectColor({ styleItemKey: 'backgroundColor' });
+     * const color = await reactElements.selectColor({ styleItemKey: 'backgroundColor' });
      *
-     * const color = await element.selectColor({
+     * const color = await reactElements.selectColor({
      *   initialValue: '#ff0000',
      *   mode: ['solid', 'gradient'],
      *   showOpacity: true,
@@ -628,9 +628,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const bg = await element.selectBackground({
+     * const bg = await reactElements.selectBackground({
      *   initialValue: { backgroundColor: '#fff', backgroundImage: '' },
      *   onChange: (value) => console.log('Preview:', value),
      * });
@@ -649,14 +649,14 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const weight = await element.selectFontWeight({
+     * const weight = await reactElements.selectFontWeight({
      *   fontFamilyStyleItemKey: 'headingFontFamily',
      *   fontWeightStyleItemKey: 'headingFontWeight',
      * });
      *
-     * const weight = await element.selectFontWeight({
+     * const weight = await reactElements.selectFontWeight({
      *   fontFamily: { family: 'Arial', weight: '400' },
      *   onChange: (value) => console.log('Selected weight:', value.weight),
      * });
@@ -683,9 +683,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const theme = await element.selectTextTheme({
+     * const theme = await reactElements.selectTextTheme({
      *   initialValue: { font: 'Heading 1', color: '#333' },
      * });
      * ```
@@ -706,9 +706,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const index = await element.getArrayItemsSelectedIndex();
+     * const index = await reactElements.getArrayItemsSelectedIndex();
      * ```
      */
     getArrayItemsSelectedIndex(options?: {
@@ -722,9 +722,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * await element.setArrayItemsSelectedIndex({ index: 2 });
+     * await reactElements.setArrayItemsSelectedIndex({ index: 2 });
      * ```
      */
     setArrayItemsSelectedIndex(options: {
@@ -739,9 +739,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * await element.resetArrayItemsSelectedIndex();
+     * await reactElements.resetArrayItemsSelectedIndex();
      * ```
      */
     resetArrayItemsSelectedIndex(options?: {
@@ -754,9 +754,9 @@ declare class ElementSDKShape extends BaseSDKShape {
      *
      * @example
      * ```ts
-     * import { element } from '@wix/editor';
+     * import { reactElements } from '@wix/editor';
      *
-     * const token = await element.getBiToken();
+     * const token = await reactElements.getBiToken();
      * ```
      */
     getBiToken(): Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor",
-  "version": "1.505.0",
+  "version": "1.506.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Editor Platform <editor-platform-dev@wix.com>",
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "falconPackageHash": "8419d560ad15b13c54e4a60915f75611b7217242f81704e3ade9e862"
+  "falconPackageHash": "fd98ff7e35a5ba2c1f8e8c2908513bb37f9b054c41b16114a6d6e68c"
 }