survey-creator-core 1.8.78-beta.1 → 1.8.79-beta.1

package/survey-creator-core.d.ts

@@ -1,4 +1,4 @@
-/*Type definitions for SurveyJS Creator JavaScript library v1.8.78-beta.1
+/*Type definitions for SurveyJS Creator JavaScript library v1.8.79-beta.1
 (c) 2015-2021 Devsoft Baltic OÜ - http://surveyjs.io/
 Github: https://github.com/surveyjs/survey-creator
 License: https://surveyjs.io/Licenses#SurveyCreator
@@ -17,7 +17,7 @@ import { Action, SurveyModel } from "survey-core";
 import { SurveyModel, Base, Event, Question } from "survey-core";
 import { Base, SurveyModel, JsonObjectProperty, PageModel, ILocalizableString, QuestionCheckboxModel, IAction } from "survey-core";
 import { SurveyModel, Action } from "survey-core";
-import { Base, PageModel, SurveyModel, Action } from "survey-core";
+import { Base, PageModel, SurveyModel } from "survey-core";
 import { SurveyModel, Action, QuestionMatrixDynamicModel } from "survey-core";
 import { PopupModel, ListModel, Base, SurveyModel, IAction, Action } from "survey-core";
 import { PageModel, SurveyModel } from "survey-core";
@@ -34,10 +34,11 @@ import { SurveyModel, QuestionNonValue } from "survey-core";
 import { Base, JsonObjectProperty, PanelModel, PanelModelBase, Question, SurveyModel, MatrixDynamicRowModel } from "survey-core";
 import { Base, JsonObjectProperty, Question } from "survey-core";
 import { Base, JsonObjectProperty, MatrixDynamicRowModel, Question, QuestionMatrixDynamicModel } from "survey-core";
-import { Base, SurveyModel, AdaptiveActionContainer, Action } from "survey-core";
+import { Base, SurveyModel, Action } from "survey-core";
 import { Base, SurveyModel, ListModel, IAction, Action } from "survey-core";
 import { Base, JsonObjectProperty } from "survey-core";
 import { Action, AdaptiveActionContainer, Base, IAction, Question, SurveyModel } from "survey-core";
+import { Base, AdaptiveActionContainer, Action } from "survey-core";
 import { Base, ItemValue, JsonObjectProperty } from "survey-core";
 import { ArrayChanges, Base } from "survey-core";
 import { Base, SurveyModel, EventBase, PageModel } from "survey-core";
@@ -55,6 +56,7 @@ import "../components/tabbed-menu/tabbed-menu.scss";
 import "../components/toolbox/toolbox-tool.scss";
 import "../components/question-dropdown.scss";
 import "../components/toolbox/toolbox.scss";
+import "../components/side-bar/side-bar.scss";
 import "../property-grid-theme/property-grid.scss";
 import "../utils/design.scss";
 import "../utils/layout.scss";
@@ -1872,7 +1874,6 @@ export interface ICreatorPlugin {
         update?: () => void;
         deactivate?: () => boolean;
         model: Base;
-        propertyGrid?: PropertyGridViewModelBase;
 }
 export interface ITabbedMenuItem extends IAction {
         componentContent: string;
@@ -1886,6 +1887,7 @@ export declare class TabbedMenuItem extends Action implements ITabbedMenuItem {
 export declare class TabbedMenuContainer extends AdaptiveActionContainer<TabbedMenuItem> {
         constructor();
 }
+export declare type toolBoxLocationType = "left" | "right" | "insideSideBar" | "hidden";
 /**
     * Base class for Survey Creator.
     */
@@ -2286,6 +2288,14 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
             * @see uploadFile
             */
         onUploadFile: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
+        /**
+            * Use this event to modify the list of the strings available in a translation tab.
+            * <br/> sender - the survey creator object that fires the event
+            * <br/> options.obj - the survey object which property translations are edited in the translation tab.
+            * <br/> options.propertyName - the name of the property.
+            * <br/> options.visible - a boolean value. You can change it to hide the property.
+            */
+        onTranslationStringVisibility: Survey.Event<(sender: CreatorBase<T>, options: any) => any, any>;
         /**
             * This callback is used internally for providing survey JSON text.
             */
@@ -2401,9 +2411,9 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
         static defaultNewSurveyText: string;
         toolbox: QuestionToolbox;
         get toolboxCategories(): Array<any>;
-        get currentTabPropertyGrid(): PropertyGridViewModelBase;
-        getTabPropertyGrid(id: string): PropertyGridViewModelBase;
+        sideBar: SideBarModel;
         constructor(options: ICreatorOptions, options2?: ICreatorOptions);
+        updateToolboxIsCompact(newVal?: boolean): void;
         onSurveyElementPropertyValueChanged(property: Survey.JsonObjectProperty, obj: any, newValue: any): void;
         get showToolbox(): string;
         set showToolbox(val: string);
@@ -2696,6 +2706,8 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> extends Su
         showTabs: any;
         showToolbar: any;
         isMobileView: any;
+        toolboxLocation: toolBoxLocationType;
+        sideBarLocation: "left" | "right";
         selectFromStringEditor: boolean;
 }
 export declare class StylesManager {
@@ -3052,7 +3064,7 @@ export interface ITranslationLocales {
     translateItemAfterRender(item: TranslationItem, el: any, locale: string): any;
     fireOnObjCreating(obj: Base): any;
     removeLocale(loc: string): void;
-    canShowProperty(obj: Base, prop: JsonObjectProperty): boolean;
+    canShowProperty(obj: Base, prop: JsonObjectProperty, isEmpty: boolean): boolean;
 }
 export declare class TranslationGroup extends TranslationItemBase {
     name: any;
@@ -3090,6 +3102,7 @@ export declare class Translation extends Base implements ITranslationLocales {
     translateItemAfterRenderCallback: (item: TranslationItem, el: any, locale: string) => void;
     availableTranlationsChangedCallback: () => void;
     tranlationChangedCallback: (locale: string, name: string, value: string, context: any) => void;
+    translationStringVisibilityCallback: (obj: Base, propertyName: string, visible: boolean) => boolean;
     chooseLanguageActions: Array<IAction>;
     constructor(survey: SurveyModel, options?: ISurveyCreatorOptions, hasUI?: boolean);
     getType(): string;
@@ -3113,7 +3126,7 @@ export declare class Translation extends Base implements ITranslationLocales {
     get survey(): SurveyModel;
     set survey(val: SurveyModel);
     reset(): void;
-    canShowProperty(obj: Base, prop: JsonObjectProperty): boolean;
+    canShowProperty(obj: Base, prop: JsonObjectProperty, isEmpty: boolean): boolean;
     get defaultLocale(): string;
     getLocaleName(loc: string): string;
     removeLocale(locale: string): void;
@@ -3434,12 +3447,8 @@ export declare var translationCss: {
     };
 };
 
-export declare class PropertyGridViewTranslationModel extends PropertyGridViewModelBase {
-    get propertyGridType(): string;
-}
 export declare class TabTranslationPlugin implements ICreatorPlugin {
     model: Translation;
-    propertyGrid: PropertyGridViewModelBase;
     constructor(creator: CreatorBase<SurveyModel>);
     activate(): void;
     update(): void;
@@ -3457,17 +3466,19 @@ export declare class TabDesignerViewModel<T extends SurveyModel> extends Base {
     newPage: PageModel;
     showNewPage: boolean;
     pageCount: number;
+    withModifier: string;
     creator: CreatorBase<T>;
     constructor(creator: CreatorBase<T>);
     get survey(): T;
+    get isToolboxVisible(): boolean;
     initSurvey(): void;
     dispose(): void;
-    withModifier: string;
     getDesignerCss(): string;
 }
+
 export declare class TabDesignerPlugin<T extends SurveyModel> implements ICreatorPlugin {
     model: TabDesignerViewModel<T>;
-    propertyGrid: PropertyGridViewModelBase;
+    propertyGrid: PropertyGridViewModel<T>;
     previewAction: Action;
     constructor(creator: CreatorBase<T>);
     activate(): void;
@@ -4534,28 +4545,16 @@ export declare class PropertyGridEditorBindings extends PropertyGridEditor {
     onMatrixCellValueChanged(obj: Base, options: any): void;
 }
 
-export declare abstract class PropertyGridViewModelBase extends Base {
-    model?: Base;
-    toolbar: AdaptiveActionContainer;
-    survey: SurveyModel;
-    headerText: string;
-    visible: boolean;
-    flyoutMode: boolean;
-    get flyoutPanelMode(): boolean;
-    get closeText(): string;
-    constructor(model?: Base, collapseAction?: () => void, expandAction?: () => void);
-    abstract get propertyGridType(): string;
-    createExpandAction(): Action;
-    closePropertyGrid(): void;
-}
-export declare class PropertyGridViewModel<T extends SurveyModel> extends PropertyGridViewModelBase {
+export declare class PropertyGridViewModel<T extends SurveyModel> extends Base {
+    nextSelectionAction: Action;
+    prevSelectionAction: Action;
+    objectSelectionAction: Action;
     hasPrev: boolean;
     hasNext: boolean;
-    get toolbarItems(): Array<Action>;
-    constructor(propertyGridModel: PropertyGridModel, creator: CreatorBase<T>, collapseAction?: () => void, expandAction?: () => void);
-    get propertyGridType(): string;
+    survey: SurveyModel;
+    selectedElementName: string;
+    constructor(propertyGridModel: PropertyGridModel, creator: CreatorBase<T>);
     protected onPropertyValueChanged(name: string, oldValue: any, newValue: any): void;
-    dispose(): void;
 }
 
 export declare class ObjectSelectorItem extends Action {
@@ -5013,8 +5012,8 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
         hasCategories: boolean;
         canCollapseCategories: boolean;
         isCompact: boolean;
-        visible: boolean;
         constructor(supportedQuestions?: Array<string>, creator?: CreatorBase<SurveyModel>);
+        setLocation(toolboxLocation: toolBoxLocationType): void;
         /**
             * The Array of Toolbox items as Text JSON.
             */
@@ -5124,6 +5123,35 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
         dispose(): void;
 }
 
+export declare class SideBarModel extends Base {
+    toolbar: AdaptiveActionContainer;
+    tabs: Array<SideBarTabModel>;
+    headerText: string;
+    visible: boolean;
+    hasVisibleTabs: boolean;
+    flyoutMode: boolean;
+    activeTab: string;
+    get flyoutPanelMode(): boolean;
+    get closeText(): string;
+    getTabById(id: string): SideBarTabModel;
+    constructor(creator: CreatorBase, collapseAction?: () => void, expandAction?: () => void);
+    getExpandAction(): Action;
+    closePropertyGrid(): void;
+    addTab(id: string, componentName?: string, model?: any, buildActions?: () => Array<Action>): SideBarTabModel;
+    updateHasVisibleTabs(): void;
+    dispose(): void;
+}
+
+export declare class SideBarTabModel extends Base {
+    id: string;
+    sidePanel: SideBarModel;
+    caption: string;
+    visible: boolean;
+    model: any;
+    componentName: string;
+    constructor(id: string, sidePanel: SideBarModel, componentName?: string, model?: any);
+}
+
 export interface IPortableMouseEvent {
     stopPropagation(): any;
     preventDefault(): any;