@wix/editor-react-types 1.0.36 → 1.0.38

package/dist/visualMedia.d.ts

@@ -0,0 +1,46 @@
+import type { Link } from './links';
+import type { Phone, Email } from './base';
+interface VisualMediaBase {
+    /** The URL of the media file */
+    src: string;
+    /** The slug for the media */
+    slug?: string;
+    /** Description of the media for accessibility purposes */
+    description?: string;
+    /** The title of the media */
+    title?: string;
+    /** The height of the media in pixels */
+    height?: number;
+    /** The width of the media in pixels */
+    width?: number;
+    /** An action when the item is clicked */
+    action?: {
+        /** The URL to navigate to when the media is clicked */
+        link: Link | Phone | Email;
+    };
+}
+export type VisualMedia = (VisualMediaBase & {
+    type: 'image';
+    /** Additional parameters specific to images, such as focal point and alt text. */
+    parameters?: ImageParameters;
+}) | (VisualMediaBase & {
+    type: 'video';
+    /** Additional parameters specific to videos, such as thumbnail, alt text, and whether the video has audio. */
+    parameters?: VideoParameters;
+});
+type VideoParameters = {
+    /** The URL of the video thumbnail */
+    thumbnail?: string;
+    /** Alternative text for the video */
+    alt?: string;
+    /** Whether the video has audio */
+    hasAudio?: boolean;
+};
+type ImageParameters = {
+    /** The focal point for the image */
+    focalPoint?: [number, number];
+    /** The alt text for the image */
+    alt?: string;
+};
+export {};
+//# sourceMappingURL=visualMedia.d.ts.map

package/dist/visualMedia.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualMedia.d.ts","sourceRoot":"","sources":["../src/visualMedia.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAA;AAE1C,UAAU,eAAe;IACrB,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,MAAM,CAAC,EAAE;QACL,uDAAuD;QACvD,IAAI,EAAE,IAAI,GAAG,KAAK,GAAG,KAAK,CAAA;KAC7B,CAAA;CACJ;AAED,MAAM,MAAM,WAAW,GACjB,CAAC,eAAe,GAAG;IACf,IAAI,EAAE,OAAO,CAAA;IACb,kFAAkF;IAClF,UAAU,CAAC,EAAE,eAAe,CAAA;CAC/B,CAAC,GACF,CAAC,eAAe,GAAG;IACf,IAAI,EAAE,OAAO,CAAA;IACb,8GAA8G;IAC9G,UAAU,CAAC,EAAE,eAAe,CAAA;CAC/B,CAAC,CAAA;AAER,KAAK,eAAe,GAAG;IACnB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,KAAK,eAAe,GAAG;IACnB,oCAAoC;IACpC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/visualMedia.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=visualMedia.js.map

package/dist/visualMedia.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualMedia.js","sourceRoot":"","sources":["../src/visualMedia.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/editor-react-types",
-  "version": "1.0.36",
+  "version": "1.0.38",
   "description": "React types for Wix Editor components",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -50,5 +50,5 @@
     }
   },
   "type": "module",
-  "falconPackageHash": "be87cd697783806e7dfac3535ab528ccf247f4ac32594bba81ff84dc"
+  "falconPackageHash": "d02c5de5ad53b8f7244067a23d7cf15123367dab1a10892ceb436b2e"
 }

package/src/index.ts

@@ -6,6 +6,7 @@ export type { A11y } from './a11y'
 export type { Audio, AudioSource } from './audio'
 export type { MenuItems, MenuItem } from './menuItems'
 export type { Wix } from './wix'
+export type { VisualMedia } from './visualMedia'
 export type {
     Schema,
     Text,

package/src/visualMedia.ts

@@ -0,0 +1,50 @@
+import type { Link } from './links'
+import type { Phone, Email } from './base'
+
+interface VisualMediaBase {
+    /** The URL of the media file */
+    src: string
+    /** The slug for the media */
+    slug?: string
+    /** Description of the media for accessibility purposes */
+    description?: string
+    /** The title of the media */
+    title?: string
+    /** The height of the media in pixels */
+    height?: number
+    /** The width of the media in pixels */
+    width?: number
+    /** An action when the item is clicked */
+    action?: {
+        /** The URL to navigate to when the media is clicked */
+        link: Link | Phone | Email
+    }
+}
+
+export type VisualMedia =
+    | (VisualMediaBase & {
+          type: 'image'
+          /** Additional parameters specific to images, such as focal point and alt text. */
+          parameters?: ImageParameters
+      })
+    | (VisualMediaBase & {
+          type: 'video'
+          /** Additional parameters specific to videos, such as thumbnail, alt text, and whether the video has audio. */
+          parameters?: VideoParameters
+      })
+
+type VideoParameters = {
+    /** The URL of the video thumbnail */
+    thumbnail?: string
+    /** Alternative text for the video */
+    alt?: string
+    /** Whether the video has audio */
+    hasAudio?: boolean
+}
+
+type ImageParameters = {
+    /** The focal point for the image */
+    focalPoint?: [number, number]
+    /** The alt text for the image */
+    alt?: string
+}