@unlayer/types 1.510.0 → 1.513.0

package/dist/editor/editor.d.ts

@@ -431,12 +431,41 @@ declare class EditorClass<TClassDisplayMode extends DisplayMode | undefined = un
     setTextDirection(textDirection: TextDirection | null): void;
     setTranslations(translations: Translations): void;
     loadBlank(bodyValues?: object): void;
+    /**
+     * Loads a design JSON into the editor, replacing the current design.
+     *
+     * Get design JSON from `saveDesign()` or `exportHtml()`, or generate it from React code with
+     * `renderToJson()` from `@unlayer/react-elements` (templates written in code by developers,
+     * coding agents, or an LLM at runtime stay editable here).
+     *
+     * @see https://docs.unlayer.com/builder/load-and-save-designs
+     * @see https://docs.unlayer.com/elements
+     */
     loadDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(design: JSONTemplate<TDisplayMode>): void;
+    /**
+     * Returns the current design JSON in the callback. Store it and pass it to `loadDesign()` to
+     * reopen the design for editing later.
+     *
+     * @see https://docs.unlayer.com/builder/load-and-save-designs
+     */
     saveDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: JSONTemplate<TDisplayMode>) => void, options?: SaveDesignOptions): void;
+    /**
+     * Exports the current design as HTML. The callback receives `{ html, design }`: send or render
+     * the `html`, and store the `design` JSON to reopen it with `loadDesign()`.
+     *
+     * @see https://docs.unlayer.com/builder/export-html
+     */
     exportHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportHtmlResult<TDisplayMode>) => void, options?: ExportHtmlOptions): void;
     exportLiveHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportLiveHtmlResult<TDisplayMode>) => void, options?: ExportLiveHtmlOptions): void;
     exportPlainText<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportPlainTextResult<TDisplayMode>) => void, options?: ExportPlainTextOptions): void;
     exportImage<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportImageFromApiOptions): void;
+    /**
+     * Exports the current design as a PDF. Unlike `exportHtml()`, the PDF is generated by Unlayer's
+     * Cloud API, uploaded to your connected file storage, and the callback receives
+     * `{ url, design }`.
+     *
+     * @see https://docs.unlayer.com/builder/export-pdf
+     */
     exportPdf<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportPdfFromApiOptions): void;
     exportZip<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportZipFromApiOptions): void;
     setAppearance(appearance: DeepPartial<AppearanceConfig>): void;

package/package.json

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