@unlayer/types 1.535.0 → 1.537.0

package/dist/editor/editor.d.ts

@@ -457,6 +457,13 @@ interface MessageData {
 }
 
 export interface FrameOptions {
+    /**
+     * Accessible name of the iframe (WCAG 4.1.2), set as its `aria-label`:
+     * screen reader users hear it when they reach the editor in the host page.
+     * Named after the `editor.title` option it usually comes from; it is never
+     * the iframe's `title`, which browsers show as a hover tooltip.
+     */
+    iframeTitle?: string;
     /**
      * Background color painted on the iframe element + injected into the
      * iframe document's `<html>` / `<body>` / `#editor` via an inline
@@ -495,7 +502,7 @@ declare class Frame {
     capabilities: FrameCapabilities | null;
     private capabilityListeners;
     constructor(src: string, options?: FrameOptions);
-    createIframe(src: string, { iframeBackgroundColor, iframeTextColor }?: FrameOptions): HTMLIFrameElement;
+    createIframe(src: string, { iframeBackgroundColor, iframeTextColor, iframeTitle }?: FrameOptions): HTMLIFrameElement;
     destroy: () => void;
     /**
      * Calls `listener` with the editor's capabilities once they are known, and

package/dist/editor/intl.d.ts

@@ -93,9 +93,11 @@ export type EditorTranslationKey =
   | 'buttons.corners'
   | 'buttons.crop'
   | 'buttons.delete'
+  | 'buttons.delete_image_number'
   | 'buttons.deselect'
   | 'buttons.desktop'
   | 'buttons.disable_amp'
+  | 'buttons.dismiss'
   | 'buttons.done'
   | 'buttons.download_pdf'
   | 'buttons.draw'
@@ -150,8 +152,20 @@ export type EditorTranslationKey =
   | 'buttons.use_prompt'
   | 'buttons.use_this'
   | 'buttons.zoom'
+  | 'canvas.design_label'
+  | 'canvas.editing_instructions_line'
+  | 'canvas.editing_instructions_table'
+  | 'canvas.editing_instructions_text'
+  | 'canvas.layer_with_columns'
+  | 'canvas.layer_with_states'
+  | 'canvas.layer_with_text'
+  | 'canvas.state_locked'
+  | 'canvas.state_page_warning'
+  | 'canvas.table_cell_label'
   | 'collaboration.add_comment'
   | 'collaboration.collaboration_mode'
+  | 'collaboration.comment_options'
+  | 'collaboration.edit_comment'
   | 'collaboration.empty.subtitle'
   | 'collaboration.empty.title'
   | 'collaboration.empty_filtered.subtitle'
@@ -170,6 +184,8 @@ export type EditorTranslationKey =
   | 'collaboration.replies.one'
   | 'collaboration.resolve'
   | 'collaboration.resolved'
+  | 'collaboration.send_comment'
+  | 'collaboration.send_reply'
   | 'collaboration.types.feedback'
   | 'collaboration.types.idea'
   | 'collaboration.types.question'
@@ -198,12 +214,25 @@ export type EditorTranslationKey =
   | 'dev_tab.info'
   | 'dev_tab.loading_project'
   | 'dev_tab.loading_project_info'
+  | 'dnd.cancelled'
+  | 'dnd.drop_target_in_column'
+  | 'dnd.drop_target_in_rows'
+  | 'dnd.dropped'
+  | 'dnd.dropped_outside'
+  | 'dnd.instructions'
+  | 'dnd.instructions_canvas'
+  | 'dnd.not_over'
+  | 'dnd.over'
+  | 'dnd.picked_up'
+  | 'dnd.row_number'
+  | 'dnd.rows'
   | 'editor.accessibility_title.description'
   | 'editor.action_type.label'
   | 'editor.align.label'
   | 'editor.alignment.label'
   | 'editor.all_sides.label'
   | 'editor.alternate_text.label'
+  | 'editor.anchor.amp_not_supported'
   | 'editor.anchor.section_already_exists'
   | 'editor.background_color.label'
   | 'editor.background_image.container_width'
@@ -355,6 +384,7 @@ export type EditorTranslationKey =
   | 'editor.link.call_phone'
   | 'editor.link.close_popup'
   | 'editor.link.email'
+  | 'editor.link.invalid_url'
   | 'editor.link.mailto'
   | 'editor.link.new_tab'
   | 'editor.link.no_page_sections_found'
@@ -387,6 +417,7 @@ export type EditorTranslationKey =
   | 'editor.magic_image.generating_images_for'
   | 'editor.magic_image.modal_title'
   | 'editor.magic_image.no_suggestions'
+  | 'editor.magic_image.prompt_label'
   | 'editor.magic_image.prompt_placeholder'
   | 'editor.magic_image.prompt_score_good'
   | 'editor.magic_image.prompt_score_info'
@@ -419,6 +450,7 @@ export type EditorTranslationKey =
   | 'editor.orientation.label'
   | 'editor.padding.label'
   | 'editor.placeholder.drop_it_here'
+  | 'editor.placeholder.keyboard_hint'
   | 'editor.placeholder.text'
   | 'editor.placeholder.text.left'
   | 'editor.placeholder.text.small'
@@ -468,6 +500,25 @@ export type EditorTranslationKey =
   | 'editor.smart_text.text_empty'
   | 'editor.social_links.label'
   | 'editor.space_between_fields.label'
+  | 'editor.status.ai_image_added'
+  | 'editor.status.ai_image_adding'
+  | 'editor.status.ai_image_replaced'
+  | 'editor.status.ai_image_reverted'
+  | 'editor.status.ai_images_added_to_prompt'
+  | 'editor.status.device_view'
+  | 'editor.status.hidden_on_device'
+  | 'editor.status.insert_locked'
+  | 'editor.status.insert_not_here'
+  | 'editor.status.insert_row_limit'
+  | 'editor.status.item_deleted'
+  | 'editor.status.item_duplicated'
+  | 'editor.status.item_inserted'
+  | 'editor.status.item_moved'
+  | 'editor.status.redo'
+  | 'editor.status.shown_on_device'
+  | 'editor.status.tools_panel_hidden'
+  | 'editor.status.tools_panel_shown'
+  | 'editor.status.undo'
   | 'editor.striped_rows.label'
   | 'editor.striped_rows_background_color.label'
   | 'editor.submit_action.label'
@@ -589,6 +640,7 @@ export type EditorTranslationKey =
   | 'labels.ai.assistant.protected_content_preserved'
   | 'labels.ai.assistant.quick_actions'
   | 'labels.ai.assistant.reorder_images'
+  | 'labels.ai.assistant.reorder_or_insert_images'
   | 'labels.ai.assistant.scroll_to_bottom'
   | 'labels.ai.assistant.select_a_component_to_run_ai'
   | 'labels.ai.assistant.template_importer.choose_file'
@@ -630,6 +682,9 @@ export type EditorTranslationKey =
   | 'labels.ai.image.continue_generating_new_image'
   | 'labels.ai.image.edit_existing_image'
   | 'labels.ai.image.generate_new_image'
+  | 'labels.ai.image_number'
+  | 'labels.ai.prompt'
+  | 'labels.ai.suggested_replies'
   | 'labels.align_text'
   | 'labels.alignment.bottom'
   | 'labels.alignment.center'
@@ -639,22 +694,32 @@ export type EditorTranslationKey =
   | 'labels.alignment.left'
   | 'labels.alignment.right'
   | 'labels.alignment.top'
+  | 'labels.alt_text_generation_failed'
+  | 'labels.amp_supported'
   | 'labels.auto_off'
   | 'labels.auto_on'
+  | 'labels.auto_width_item'
   | 'labels.beta.feedback.buttons.send_feedback'
   | 'labels.beta.feedback.errors.failed_to_send_feedback'
   | 'labels.beta.feedback.footnote'
   | 'labels.beta.feedback.intro_text'
   | 'labels.beta.feedback.thank_you_for_your_feedback'
+  | 'labels.beta.feedback.your_feedback'
   | 'labels.beta.feedback.your_feedback_here'
+  | 'labels.block_tile'
   | 'labels.blocks.plan_limit.cta'
   | 'labels.blocks.plan_limit.message'
   | 'labels.blocks.plan_limit.title'
   | 'labels.blur'
+  | 'labels.categories'
   | 'labels.category'
+  | 'labels.cell_options'
   | 'labels.change_language'
   | 'labels.characters'
+  | 'labels.clear'
   | 'labels.clear_formatting'
+  | 'labels.clear_item'
+  | 'labels.color'
   | 'labels.color_picker'
   | 'labels.comments'
   | 'labels.contain'
@@ -674,14 +739,26 @@ export type EditorTranslationKey =
   | 'labels.cut'
   | 'labels.dark'
   | 'labels.dark_mode'
+  | 'labels.date'
+  | 'labels.decrease'
+  | 'labels.decrease_item'
+  | 'labels.delete_item'
   | 'labels.description'
   | 'labels.desktop_preview'
   | 'labels.device_override'
+  | 'labels.device_view'
   | 'labels.disable_dark_mode'
   | 'labels.dismiss'
   | 'labels.display_conditions'
+  | 'labels.document_preview'
   | 'labels.dynamic_content_enabled'
+  | 'labels.edit_block'
+  | 'labels.edit_item'
+  | 'labels.editing_instructions_field'
   | 'labels.editor'
+  | 'labels.editor_actions'
+  | 'labels.editor_panels'
+  | 'labels.emojis'
   | 'labels.enable_dark_mode'
   | 'labels.error'
   | 'labels.errors.failed_to_fetch_prompt_suggestions'
@@ -698,8 +775,16 @@ export type EditorTranslationKey =
   | 'labels.google_fonts'
   | 'labels.gradient'
   | 'labels.header'
+  | 'labels.heading_level'
   | 'labels.hide'
   | 'labels.horizontal'
+  | 'labels.image'
+  | 'labels.image_credit'
+  | 'labels.image_editor'
+  | 'labels.image_preview_instructions'
+  | 'labels.increase'
+  | 'labels.increase_item'
+  | 'labels.item_actions'
   | 'labels.landscape'
   | 'labels.language'
   | 'labels.learn_more'
@@ -713,16 +798,24 @@ export type EditorTranslationKey =
   | 'labels.locked_live_mode.message'
   | 'labels.menu.label'
   | 'labels.menu.links'
+  | 'labels.menu_item_number'
   | 'labels.merge_tags'
   | 'labels.mobile_preview'
+  | 'labels.modified_for_device'
+  | 'labels.more_actions'
   | 'labels.more_images'
+  | 'labels.move_item'
+  | 'labels.move_item_down'
+  | 'labels.move_item_up'
   | 'labels.multi_language.plan_limit.tooltip'
+  | 'labels.name_with_instructions'
   | 'labels.new'
   | 'labels.no_images'
   | 'labels.no_results'
   | 'labels.none'
   | 'labels.not_supported'
   | 'labels.objects'
+  | 'labels.open_document_preview'
   | 'labels.orientation'
   | 'labels.outline'
   | 'labels.page'
@@ -730,18 +823,27 @@ export type EditorTranslationKey =
   | 'labels.paste'
   | 'labels.portrait'
   | 'labels.position'
+  | 'labels.preview'
   | 'labels.prompt'
   | 'labels.radius'
   | 'labels.recents'
   | 'labels.redo'
   | 'labels.refresh'
   | 'labels.refresh_results'
+  | 'labels.reset_item'
+  | 'labels.resize_table_column'
+  | 'labels.resize_table_row'
   | 'labels.resolution'
+  | 'labels.row_layout_tile'
   | 'labels.safe_search'
   | 'labels.search'
+  | 'labels.search_blocks'
+  | 'labels.search_emojis'
   | 'labels.search_images'
   | 'labels.search_images_by_name'
+  | 'labels.search_stock_images'
   | 'labels.section'
+  | 'labels.see_all_in_category'
   | 'labels.select_tone'
   | 'labels.shadow'
   | 'labels.show'
@@ -754,18 +856,29 @@ export type EditorTranslationKey =
   | 'labels.stock_photos_by'
   | 'labels.stock_photos_license'
   | 'labels.stop'
+  | 'labels.style'
+  | 'labels.success'
+  | 'labels.sync_block_synced'
+  | 'labels.sync_block_unsynced'
   | 'labels.tabloid'
+  | 'labels.tabs_instructions_horizontal'
+  | 'labels.tabs_instructions_vertical'
   | 'labels.tags'
+  | 'labels.text_formatting'
   | 'labels.text_prompt'
   | 'labels.text_style'
   | 'labels.texture'
+  | 'labels.time'
   | 'labels.timezone'
   | 'labels.tip'
   | 'labels.tone'
   | 'labels.tools.custom.plan_limit.cta'
   | 'labels.tools.custom.plan_limit.description'
   | 'labels.tools.custom.plan_limit.title'
+  | 'labels.tools_panel'
+  | 'labels.transparent'
   | 'labels.undo'
+  | 'labels.unit'
   | 'labels.usage_limit.errors.credits_exhausted'
   | 'labels.usage_limit.errors.credits_exhausted_claimable'
   | 'labels.usage_limit.errors.credits_exhausted_claimable_billing'
@@ -779,7 +892,10 @@ export type EditorTranslationKey =
   | 'labels.usage_limit.features.countdown_views'
   | 'labels.usage_limit.features.export'
   | 'labels.usage_limit.features.inbox_preview'
+  | 'labels.use_generated_image'
+  | 'labels.use_this_result'
   | 'labels.vertical'
+  | 'labels.warning'
   | 'labels.words'
   | 'minimap.hide'
   | 'minimap.label'
@@ -793,6 +909,9 @@ export type EditorTranslationKey =
   | 'modals.delete.confirmation'
   | 'modals.delete.title'
   | 'modals.display_conditions.title'
+  | 'modals.preview.amp_error_count'
+  | 'modals.preview.amp_validation_link'
+  | 'modals.preview.amp_validation_passed'
   | 'modals.preview.browser_preview.label'
   | 'modals.preview.content_overflow_warning'
   | 'modals.preview.download_pdf.downloaded'
@@ -885,6 +1004,7 @@ export type EditorTranslationKey =
   | 'modals.preview.inbox_preview.label.zoom_out'
   | 'modals.preview.inbox_preview.polling_status_timed_out'
   | 'modals.preview.inbox_preview.polling_timed_out'
+  | 'modals.preview.inbox_preview.search_clients'
   | 'modals.preview.inbox_preview.settings_link'
   | 'modals.preview.inbox_preview.text.email_clients'
   | 'modals.preview.inbox_preview.text.generate_previews'
@@ -1041,6 +1161,7 @@ export type EditorTranslationKey =
   | 'tools.form.update_field'
   | 'tools.social.click_icons_to_add'
   | 'tools.tabs.audit'
+  | 'tools.tabs.audit_issue_count'
   | 'tools.tabs.blocks'
   | 'tools.tabs.body'
   | 'tools.tabs.content'
@@ -1053,8 +1174,10 @@ export type EditorTranslationKey =
 
 export type ImageEditorTranslationKey =
   | 'image_editor.actions.reset'
+  | 'image_editor.actions.reset_item'
   | 'image_editor.ai_assistant.aborted'
   | 'image_editor.ai_assistant.clarify_edit'
+  | 'image_editor.ai_assistant.close'
   | 'image_editor.ai_assistant.credits_exhausted.claimable_message'
   | 'image_editor.ai_assistant.credits_exhausted.contact_owner_message'
   | 'image_editor.ai_assistant.credits_exhausted.message'
@@ -1069,6 +1192,10 @@ export type ImageEditorTranslationKey =
   | 'image_editor.ai_assistant.progress.analyzing'
   | 'image_editor.ai_assistant.progress.applying'
   | 'image_editor.ai_assistant.progress.finalizing'
+  | 'image_editor.ai_assistant.prompt_label'
+  | 'image_editor.ai_assistant.send'
+  | 'image_editor.ai_assistant.show_less'
+  | 'image_editor.ai_assistant.show_more'
   | 'image_editor.ai_assistant.suggestions.black_white'
   | 'image_editor.ai_assistant.suggestions.blur_background'
   | 'image_editor.ai_assistant.suggestions.brightness'
@@ -1083,11 +1210,25 @@ export type ImageEditorTranslationKey =
   | 'image_editor.arrange.bring_to_front'
   | 'image_editor.arrange.send_backward'
   | 'image_editor.arrange.send_to_back'
+  | 'image_editor.canvas.instructions'
+  | 'image_editor.canvas.label'
+  | 'image_editor.colors.black'
+  | 'image_editor.colors.blue'
+  | 'image_editor.colors.green'
+  | 'image_editor.colors.hex'
+  | 'image_editor.colors.orange'
+  | 'image_editor.colors.purple'
+  | 'image_editor.colors.red'
+  | 'image_editor.colors.white'
+  | 'image_editor.colors.yellow'
   | 'image_editor.corners.radius'
   | 'image_editor.crop.aspect_free'
   | 'image_editor.crop.aspect_original'
   | 'image_editor.crop.aspect_ratio'
   | 'image_editor.crop.aspect_square'
+  | 'image_editor.crop.image_alt'
+  | 'image_editor.crop.region_x'
+  | 'image_editor.crop.region_y'
   | 'image_editor.crop.rotate_flip'
   | 'image_editor.crop.straighten'
   | 'image_editor.draw.brush'
@@ -1147,6 +1288,12 @@ export type ImageEditorTranslationKey =
   | 'image_editor.labels.shape'
   | 'image_editor.labels.sticker'
   | 'image_editor.labels.text'
+  | 'image_editor.objects.actions'
+  | 'image_editor.objects.deleted'
+  | 'image_editor.objects.selected'
+  | 'image_editor.objects.text'
+  | 'image_editor.position.angle'
+  | 'image_editor.position.title'
   | 'image_editor.resize.height'
   | 'image_editor.resize.lock_aspect'
   | 'image_editor.resize.width'
@@ -1180,8 +1327,10 @@ export type ImageEditorTranslationKey =
   | 'image_editor.shapes.shadow_offset_y'
   | 'image_editor.shapes.shield'
   | 'image_editor.shapes.star'
+  | 'image_editor.shapes.tile_label'
   | 'image_editor.shapes.transparent'
   | 'image_editor.shapes.triangle'
+  | 'image_editor.status.loading_image'
   | 'image_editor.stickers.category.beach'
   | 'image_editor.stickers.category.bubbles'
   | 'image_editor.stickers.category.clouds'
@@ -1193,6 +1342,7 @@ export type ImageEditorTranslationKey =
   | 'image_editor.stickers.empty'
   | 'image_editor.stickers.less'
   | 'image_editor.stickers.more'
+  | 'image_editor.stickers.numbered'
   | 'image_editor.stickers.search'
   | 'image_editor.text.align'
   | 'image_editor.text.align_center'
@@ -1200,6 +1350,7 @@ export type ImageEditorTranslationKey =
   | 'image_editor.text.align_right'
   | 'image_editor.text.background'
   | 'image_editor.text.bold'
+  | 'image_editor.text.content'
   | 'image_editor.text.default_text'
   | 'image_editor.text.font'
   | 'image_editor.text.group.basic'
@@ -1228,9 +1379,11 @@ export type ImageEditorTranslationKey =
   | 'image_editor.text.underline'
   | 'image_editor.toolbar.cancel'
   | 'image_editor.toolbar.close'
+  | 'image_editor.toolbar.close_tool_panel'
   | 'image_editor.toolbar.fit_to_screen'
   | 'image_editor.toolbar.flatten'
   | 'image_editor.toolbar.hide_chat'
+  | 'image_editor.toolbar.label'
   | 'image_editor.toolbar.redo'
   | 'image_editor.toolbar.save'
   | 'image_editor.toolbar.show_chat'
@@ -1242,6 +1395,7 @@ export type ImageEditorTranslationKey =
   | 'image_editor.tools.draw'
   | 'image_editor.tools.filter'
   | 'image_editor.tools.frame'
+  | 'image_editor.tools.label'
   | 'image_editor.tools.resize'
   | 'image_editor.tools.shapes'
   | 'image_editor.tools.stickers'

package/dist/editor/utils.d.ts

@@ -20,6 +20,12 @@ export interface EditorProps<Value, WidgetParams = object> {
     deviceName: Device;
     displayMode: DisplayMode;
     label?: string;
+    /**
+     * Id of the element that holds the label text. Reference it from the
+     * widget's control with `aria-labelledby` so assistive technology
+     * announces the control with its label.
+     */
+    labelId?: string;
     location: Location;
     values: {
         [key: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unlayer/types",
-  "version": "1.535.0",
+  "version": "1.537.0",
   "license": "MIT",
   "private": false,
   "types": "./dist/index.d.ts",