lucid-extension-sdk 0.0.105 → 0.0.107

package/interop.d.ts

@@ -33,3 +33,29 @@ interface Console {
     trace(...data: any[]): void;
     warn(...data: any[]): void;
 }
+
+declare class I18nSafeString {
+    public value: string;
+    constructor(str: string);
+}
+
+declare interface I18nFormattedNumberParams {
+    useGrouping?: boolean;
+    minimumIntegerDigits?: number;
+    minimumFractionDigits?: number;
+    maximumFractionDigits?: number;
+}
+
+declare class I18nFormattedNumber {}
+
+declare interface I18nReplacement {
+    [s: string]: number | string | I18nSafeString | I18nFormattedNumber;
+}
+
+declare namespace i18n {
+    function setData(data: {[key: string]: string}, language: string): void;
+    function get(key: string, replacements?: I18nReplacement, wrappers?: string[], gender?: string): string;
+    function getLanguage(): string;
+    function getInLocale(locale: string, key: string, replacements?: I18nReplacement, wrappers?: string[]): string;
+    function formatNumber(value: number, params: I18nFormattedNumberParams): I18nFormattedNumber;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.105",
+    "version": "0.0.107",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "sdk/index.js",
     "types": "sdk/index.d.ts",

package/sdk/commandtypes.d.ts

@@ -1059,11 +1059,17 @@ export declare type ShowModalQuery = {
     /** Name of the modal's action for receiving events; generated automatically by Modal base class */
     'n': string;
     /** Title to show on the modal */
-    't': string;
+    't'?: string | undefined;
     /** Desired modal width */
-    'w': number;
+    'w'?: number | undefined;
     /** Desired modal height */
-    'h': number;
+    'h'?: number | undefined;
+    /** Chromeless (without a header and borders) or not */
+    'cl'?: boolean | undefined;
+    /** FullScreen or not */
+    'fs'?: boolean | undefined;
+    /** TransparentBackground or not */
+    'tb'?: boolean | undefined;
     /** Content to display in the modal; full HTML page preferred */
     'c': string;
 };

package/sdk/ui/modal.d.ts

@@ -3,16 +3,38 @@ import { IframeUI } from './iframeui';
 /**
  * Configuration required to display a [Modal](#classes_ui_modal-Modal).
  */
-export interface ModalConfig {
+export declare type ModalConfig = {
+    /** Content to display in the modal's iframe. This is set as the srcdoc on a sandboxed iframe. */
+    content: string;
+} & ({
     /** Title to display in the header bar of the modal. */
     title: string;
+    /** If true, the header bar won't display (and no title is needed). */
+    chromeless?: false | never;
+} | {
+    /** Title to display in the header bar of the modal. */
+    title?: never;
+    /** If true, the header bar won't display (and no title is needed). */
+    chromeless: true;
+}) & ({
     /** Requested width of the modal, in pixels. Depending on window size, this may not be honored exactly. */
     width: number;
     /** Requested height of the modal, in pixels. Depending on window size, this may not be honored exactly. */
     height: number;
-    /** Content to display in the modal's iframe. This is set as the srcdoc on a sandboxed iframe. */
-    content: string;
-}
+    /** If true, the modal will take up the entire window, and won't need a width and height */
+    fullScreen?: false | never;
+    /** If true, the background of modal will be transparent. */
+    transparentBackground?: false | never;
+} | {
+    /** Requested width of the modal, in pixels. Depending on window size, this may not be honored exactly. */
+    width?: never;
+    /** Requested height of the modal, in pixels. Depending on window size, this may not be honored exactly. */
+    height?: never;
+    /** If true, the modal will take up the entire window, and won't need a width and height */
+    fullScreen: true;
+    /** If true, the background of modal will be transparent. */
+    transparentBackground?: boolean;
+});
 /**
  * Extend this class to show a custom modal to the user, whose contents are displayed in a sandboxed
  * iframe controlled by your extension.

package/sdk/ui/modal.js

@@ -29,6 +29,9 @@ class Modal extends iframeui_1.IframeUI {
                 't': this.config.title,
                 'w': this.config.width,
                 'h': this.config.height,
+                'cl': this.config.chromeless,
+                'fs': this.config.fullScreen,
+                'tb': this.config.transparentBackground,
                 'c': this.config.content,
             });
             this.visible = true;