survey-creator-core 1.9.118 → 1.9.119

package/typings/components/tabs/theme-builder.d.ts

@@ -36,8 +36,6 @@ export declare class ThemeBuilder extends Base {
     themePalette: any;
     themeMode: any;
     getFullThemeName(_themeName?: string): any;
-    get activeLanguage(): string;
-    set activeLanguage(val: string);
     get survey(): SurveyModel;
     get pageActions(): Array<Action>;
     get isPageToolbarVisible(): boolean;
@@ -49,13 +47,13 @@ export declare class ThemeBuilder extends Base {
     onThemeSelected: EventBase<ThemeBuilder, {
         theme: ITheme;
     }>;
-    onThemeModified: EventBase<ThemeBuilder, {
+    onThemePropertyChanged: EventBase<ThemeBuilder, {
         name: string;
         value: any;
     }>;
-    onCanModifyTheme: EventBase<ThemeBuilder, {
+    onAllowModifyTheme: EventBase<ThemeBuilder, {
         theme: ITheme;
-        canModify: boolean;
+        allow: boolean;
     }>;
     constructor(surveyProvider: CreatorBase, startThemeClasses?: any);
     get isMobileView(): boolean;

package/typings/components/tabs/theme-plugin.d.ts

@@ -2,6 +2,22 @@ import { Action, ITheme, EventBase } from "survey-core";
 import { CreatorBase, ICreatorPlugin } from "../../creator-base";
 import { ThemeBuilder } from "./theme-builder";
 import { saveToFileHandler } from "../../utils/utils";
+/**
+ * An object that enables you to modify, add, and remove UI themes and handle theme-related events. To access this object, use the [`themeEditor`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#themeEditor) property on a Survey Creator instance:
+ *
+ * ```js
+ * const creatorOptions = { ... };
+ * const creator = new SurveyCreator.SurveyCreator(creatorOptions);
+ * creator.themeEditor.settingName = "value";
+ *
+ * // In modular applications:
+ * import { SurveyCreatorModel } from "survey-creator-core";
+ *
+ * const creatorOptions = { ... };
+ * const creator = new SurveyCreatorModel(creatorOptions);
+ * creator.themeEditor.settingName = "value";
+ * ```
+ */
 export declare class ThemeTabPlugin implements ICreatorPlugin {
     private creator;
     private previewAction;
@@ -35,22 +51,92 @@ export declare class ThemeTabPlugin implements ICreatorPlugin {
     redo(): void;
     private updateUndeRedoActions;
     addFooterActions(): void;
+    /**
+     * A list of UI themes from which users can select. You can sort this list if you want to reorder themes in Theme Editor.
+     * @see addTheme
+     * @see removeTheme
+     */
     get availableThemes(): string[];
-    set availableThemes(availebleThemes: string[]);
+    set availableThemes(availableThemes: string[]);
+    /**
+     * Adds a new UI theme to Theme Editor.
+     * @param theme A [UI theme](https://surveyjs.io/form-library/documentation/api-reference/itheme) to add.
+     * @param setAsDefault For internal use.
+     * @returns An identifier of the added theme, which is a concatenation of the [`themeName`](https://surveyjs.io/form-library/documentation/api-reference/itheme#themeName), [`colorPalette`](https://surveyjs.io/form-library/documentation/api-reference/itheme#colorPalette), and [`isPanelless`](https://surveyjs.io/form-library/documentation/api-reference/itheme#isPanelless) settings (for example, `"default-dark-panelless"`).
+     * @see removeTheme
+     * @see getCurrentTheme
+     */
     addTheme(theme: ITheme, setAsDefault?: boolean): string;
-    removeTheme(themeAccessor: string | ITheme, withModifications?: boolean): void;
-    getCurrentTheme(content?: "full" | "changes"): ITheme;
+    /**
+     * Removes a UI theme from Theme Editor.
+     * @param themeAccessor A [UI theme](https://surveyjs.io/form-library/documentation/api-reference/itheme) to delete or a theme identifier, which is a concatenation of the [`themeName`](https://surveyjs.io/form-library/documentation/api-reference/itheme#themeName), [`colorPalette`](https://surveyjs.io/form-library/documentation/api-reference/itheme#colorPalette), and [`isPanelless`](https://surveyjs.io/form-library/documentation/api-reference/itheme#isPanelless) settings (for example, `"default-dark-panelless"`).
+     * @param includeModifications Pass `true` to delete not only the specified UI theme, but also all other themes with the same `themeName` value (dark/light and panelless modifications).
+     * @see addTheme
+     * @see getCurrentTheme
+     */
+    removeTheme(themeAccessor: string | ITheme, includeModifications?: boolean): void;
+    /**
+     * Returns a JSON object that describes the currently applied UI theme.
+     * @param changesOnly Pass `true` to get a JSON object that contains only changed theme settings instead of a full theme JSON schema.
+     * @returns A currently applied [theme JSON schema](https://surveyjs.io/form-library/documentation/api-reference/itheme).
+     * @see availableThemes
+     * @see addTheme
+     * @see removeTheme
+     */
+    getCurrentTheme(changesOnly?: boolean): ITheme;
     getThemeChanges(): ITheme;
-    get isThemePristine(): boolean;
+    /**
+     * Indicates whether the selected theme has been modified.
+     * @see [`creator.saveTheme()`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveTheme)
+     * @see [`creator.saveThemeFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveThemeFunc)
+     */
+    get isModified(): boolean;
+    /**
+     * An event that is raised when users select a UI theme from a drop-down list, choose a dark or light color palette, and switch between regular and panelless theme modifications.
+     *
+     * Parameters:
+     *
+     * - `sender`: `ThemeTabPlugin`\
+     * A `ThemeTabPlugin` instance that raised the event.
+     * - `options.theme`: [`ITheme`](https://surveyjs.io/form-library/documentation/api-reference/itheme)\
+     * A selected theme.
+     * @see availableThemes
+     * @see addTheme
+     * @see removeTheme
+     */
     onThemeSelected: EventBase<ThemeTabPlugin, {
         theme: ITheme;
     }>;
-    onThemeModified: EventBase<ThemeTabPlugin, {
+    /**
+     * An event that is raised when the value of a property or CSS variable in a theme JSON schema has changed.
+     *
+     * Parameters:
+     *
+     * - `sender`: `ThemeTabPlugin`\
+     * A `ThemeTabPlugin` instance that raised the event.
+     * - `options.name`: `string`\
+     * The name of the changed property or CSS variable.
+     * - `options.value`: `any`\
+     * A new value of the property or CSS variable.
+     */
+    onThemePropertyChanged: EventBase<ThemeTabPlugin, {
         name: string;
         value: any;
     }>;
-    onCanModifyTheme: EventBase<ThemeTabPlugin, {
+    /**
+     * An event that is raised when Theme Editor renders Property Grid. Use this event to switch the current theme to read-only mode.
+     *
+     * Parameters:
+     *
+     * - `sender`: `ThemeTabPlugin`\
+     * A `ThemeTabPlugin` instance that raised the event.
+     * - `options.theme`: [`ITheme`](https://surveyjs.io/form-library/documentation/api-reference/itheme)\
+     * The current theme.
+     * - `options.allow`: `boolean`\
+     * A Boolean property that you can set to `false` if you want to disallow theme modifications.
+     */
+    onAllowModifyTheme: EventBase<ThemeTabPlugin, {
         theme: ITheme;
-        canModify: boolean;
+        allow: boolean;
     }>;
 }

package/typings/creator-base.d.ts

@@ -11,6 +11,7 @@ import { UndoRedoManager } from "./plugins/undo-redo/undo-redo-manager";
 import { UndoRedoController } from "./plugins/undo-redo/undo-redo-controller";
 import { SidebarModel } from "./components/side-bar/side-bar-model";
 import { ICreatorOptions } from "./creator-options";
+import { ThemeTabPlugin } from "./components/tabs/theme-plugin";
 import { DragDropSurveyElements } from "./survey-elements";
 import { PageAdorner } from "./components/page";
 export interface IKeyboardShortcut {
@@ -97,6 +98,8 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * Specifies whether to display the Themes tab.
      *
      * Default value: `false`
+     *
+     * Use the [`themeEditor`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#themeEditor) object to manage UI themes available in the Themes tab.
      * @see activeTab
      * @see saveThemeFunc
      */
@@ -1052,21 +1055,34 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      * @see allowChangeThemeInPreview
      */
     themeForPreview: string;
+    /**
+     * An object that enables you to manage UI themes. Refer to the following API section for information on available properties, methods, and events: [`ThemeTabPlugin`](https://surveyjs.io/survey-creator/documentation/api-reference/themetabplugin).
+     * @see showThemeTab
+     * @see saveThemeFunc
+     */
+    get themeEditor(): ThemeTabPlugin;
     /**
      * A function that is called each time users click the [Save button](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSaveButton) or [auto-save](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#isAutoSave) is triggered to save a theme JSON object.
      *
      * For more information, refer to the [Save and Load Custom Themes](https://surveyjs.io/survey-creator/documentation/theme-editor#save-and-load-custom-themes) help topic.
      * @see showThemeTab
+     * @see themeEditor
      * @see saveSurveyFunc
      */
     get saveThemeFunc(): any;
     set saveThemeFunc(value: any);
-    isThemeModified: boolean;
+    hasPendingThemeChanges: boolean;
     private _theme;
     get theme(): ITheme;
     set theme(newTheme: ITheme);
     private _doSaveThemeCore;
-    doSaveTheme(): void;
+    /**
+     * Calls the [`saveThemeFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveThemeFunc) function to save the theme JSON schema.
+     * @see saveSurvey
+     * @see save
+     */
+    saveTheme(): void;
+    saveThemeActionHandler(): void;
     private _allowModifyPages;
     /**
      * Specifies whether users can add, edit, and delete survey pages.
@@ -1314,12 +1330,10 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
      */
     get survey(): SurveyModel;
     private existingPages;
-    private isInitialSurveyEmptyValue;
     /**
      * Returns true if initial survey was empty. It was not set via JSON property and default new survey is empty as well.
      * @returns true if initial survey doesn't have any elements or properties
      */
-    get isInitialSurveyEmpty(): boolean;
     protected initSurveyWithJSON(json: any, clearState: boolean): void;
     private updatePlugin;
     protected initDragDrop(): void;
@@ -1607,14 +1621,39 @@ export declare class CreatorBase extends Base implements ISurveyCreatorOptions,
     protected doAutoSave(): void;
     saveNo: number;
     private _doSaveCore;
+    /**
+     * Calls the [`saveSurveyFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveSurveyFunc) function to save the survey JSON schema.
+     * @see saveTheme
+     * @see save
+     */
+    saveSurvey(): void;
     doSave(): void;
+    saveSurveyActionHandler(): void;
     private _updateSaveActions;
-    doSaveSurveyAndTheme(): void;
+    /**
+     * Calls the [`saveSurveyFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveSurveyFunc) and [`saveThemeFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveThemeFunc) functions to save the survey and theme JSON schemas.
+     * @see saveSurvey
+     * @see saveTheme
+     */
+    save(): void;
     protected _syncSaveActions: (sender: any, options: any) => void;
-    saveSurveyAndTheme: boolean;
+    /**
+     * Specifies whether to synchronize [Save buttons](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#showSaveButton) in the Designer and Themes tabs.
+     *
+     * Default value: `false`
+     *
+     * When this property is disabled, the Save button in the Designer tab saves only the survey JSON schema, while the Save button in the Themes tab saves only the theme JSON schema. If you enable this property, both buttons will save both JSON schemas.
+     * @see saveSurveyFunc
+     * @see saveThemeFunc
+     * @see save
+     */
+    syncSaveButtons: boolean;
     /**
      * Specifies whether to display a button that saves the survey or theme (executes the [`saveSurveyFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveSurveyFunc) or [`saveThemeFunc`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#saveThemeFunc) function).
+     *
+     * Default value: `false`
      * @see isAutoSave
+     * @see syncSaveButtons
      */
     showSaveButton: boolean;
     /**

package/typings/creator-options.d.ts

@@ -1,8 +1,15 @@
 /**
- * Survey Creator configuration. Pass it as an argument to the `SurveyCreator` constructor:
+ * Survey Creator configuration. Pass it as an argument to the `SurveyCreator`/`SurveyCreatorModel` constructor:
  *
  * ```js
+ * const creatorOptions = { ... };
  * const creator = new SurveyCreator.SurveyCreator(creatorOptions);
+ *
+ * // In modular applications:
+ * import { SurveyCreatorModel } from "survey-creator-core";
+ *
+ * const creatorOptions = { ... };
+ * const creator = new SurveyCreatorModel(creatorOptions);
  * ```
  */
 export interface ICreatorOptions {

package/typings/property-grid-theme/property-grid.d.ts

@@ -23,7 +23,8 @@ export declare var propertyGridCss: {
     panel: {
         title: string;
         titleExpandable: string;
-        titleOnExpand: string;
+        titleExpanded: string;
+        titleCollapsed: string;
         titleOnError: string;
         description: string;
         container: string;

package/typings/survey-helper.d.ts

@@ -1,4 +1,4 @@
-import { Base, ISurveyElement, ItemValue, JsonObjectProperty, SurveyElement, SurveyModel } from "survey-core";
+import { Base, ISurveyElement, ItemValue, JsonObjectProperty, SurveyElement, SurveyModel, PageModel } from "survey-core";
 import { ISurveyCreatorOptions } from "./creator-settings";
 export declare enum ObjType {
     Unknown = "unknown",
@@ -12,6 +12,7 @@ export declare class SurveyHelper {
     static getNewElementName(el: ISurveyElement): string;
     static getNewPageName(objs: Array<any>): string;
     static isPageNameAutoGenerated(name: string): boolean;
+    static isPagePropertiesAreModified(page: PageModel): boolean;
     static getNewQuestionName(objs: Array<any>): string;
     static getNewPanelName(objs: Array<any>): string;
     static generateNewName(name: string): string;

package/typings/toolbox.d.ts

@@ -37,6 +37,13 @@ export interface IQuestionToolboxItem extends IAction {
 export interface IQuestionToolbox {
     toggleCategoryState(name: string): any;
 }
+export interface IToolboxCategoryDefinition {
+    category: string;
+    items: Array<string | {
+        name: string;
+        title?: string;
+    }>;
+}
 export declare class QuestionToolboxCategory extends Base {
     private toolbox;
     constructor(toolbox: IQuestionToolbox);
@@ -221,6 +228,35 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
      * @param changedItems the array of objects {name: "your toolbox item name", category: "new category name"}
      */
     changeCategories(changedItems: Array<any>): void;
+    /**
+     * Defines toolbox categories from scratch.
+     *
+     * This method accepts an array of objects as the `categories` parameter. Each object defines a single category and lists items included into it. Unlisted items can be collected in the Misc category if you pass `true` as the `displayMisc` parameter. Optionally, you can override display titles for individual items.
+     *
+     * The following code defines two toolbox categories: Dropdowns and Text Input. Items that do not fall into either category are collected in Misc. The `"comment"` item has a custom display title.
+     *
+     * ```
+     * creator.toolbox.defineCategories([{
+     *   category: "Dropdowns",
+     *   items: [
+     *     "dropdown",
+     *     "tagbox"
+     *   ]
+     * }, {
+     *   category: "Text Input",
+     *   items: [
+     *     "text",
+     *     // Override the display title
+     *     { name: "comment", title: "Multi-Line Input" }
+     *   ]
+     * }], true);
+     * ```
+     *
+     * [View Demo](https://surveyjs.io/survey-creator/examples/survey-toolbox-categories/ (linkStyle))
+     * @param categories An array of new categories.
+     * @param displayMisc Pass `true` if you want to collect unlisted toolbox items in the Misc category. Default value: `false`.
+     */
+    defineCategories(categories: Array<IToolboxCategoryDefinition>, displayMisc?: boolean): void;
     /**
      * Removes categories from the Toolbox.
      */
@@ -252,7 +288,7 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     hiddenItemSelected(model: Action): void;
     private expandCollapseAllCategories;
     private getCategoryByName;
-    protected onItemsChanged(): void;
+    protected onItemsChanged(changeActions?: boolean): void;
     protected createCategory(): QuestionToolboxCategory;
     private indexOf;
     private updateItemSeparators;