survey-creator-react 1.9.7-beta.1 → 1.9.8-beta.1

package/survey-creator-react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey Creator library for React v1.9.7-beta.1
+* Type definition for Survey Creator library for React v1.9.8-beta.1
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: https://surveyjs.io/Licenses#SurveyCreator
 */
@@ -294,7 +294,7 @@ export interface ISurveyCreatorToolboxItemProps {
 export interface ISurveyCreatorToolboxProps {
   model: any;
 }
-export interface ISideBarComponentProps {
+export interface ISidebarComponentProps {
   model: any;
 }
 export interface ISurveyPageNavigatorProps {
@@ -795,6 +795,16 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> {
   */
   onTranslationStringVisibility: Event<(sender: CreatorBase<T>, options: any) => any, any>;
   /*
+  * Use this event to define is the locale initially selected (default value) and ready for translaion or it is unselected.
+  * 
+  * The event handler accepts the following arguments:
+  * 
+  * - `sender` - A Survey Creator instance that raised the event.
+  * - `options.locale` - the locale name, like 'en', 'de' and so on.
+  * - `options.isSelected` - it is true by default. Set it to false to make the translation unselected.
+  */
+  onTranslationLocaleInitiallySelected: Event<(sender: CreatorBase<T>, options: any) => any, any>;
+  /*
   * This callback is used internally for providing survey JSON text.
   */
   getSurveyJSONTextCallback: any;
@@ -922,16 +932,20 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> {
   makeNewViewActive(viewName: string): boolean;
   toolbox: QuestionToolbox;
   get toolboxCategories(): any;
-  sideBar: SideBarModel;
+  sidebar: SidebarModel;
   updateToolboxIsCompact(newVal?: boolean): void;
   onSurveyElementPropertyValueChanged(property: JsonObjectProperty, obj: any, newValue: any): void;
-  get showToolbox(): boolean | "none" | "top" | "left" | "right";
-  set showToolbox(val: boolean | "none" | "top" | "left" | "right");
-  showPropertyGridValue: boolean;
-  onShowPropertyGridVisiblityChanged: Event<(sender: CreatorBase<T>, options: any) => any, any>;
+  showToolboxValue: boolean;
+  get showToolbox(): boolean;
+  set showToolbox(val: boolean);
+  showSidebarValue: boolean;
+  onShowSidebarVisiblityChanged: Event<(sender: CreatorBase<T>, options: any) => any, any>;
   /*
   * Set this this property grid false to hide the property grid.
   */
+  get showSidebar(): boolean;
+  set showSidebar(val: boolean);
+  onShowPropertyGridVisiblityChanged: Event<(sender: CreatorBase<T>, options: any) => any, any>;
   get showPropertyGrid(): boolean;
   set showPropertyGrid(val: boolean);
   rightContainerActiveItem(name: string): void;
@@ -967,6 +981,10 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> {
   */
   stopUndoRedoTransaction(): void;
   /*
+  * Returns true if Creator is currently doing undo or redo opertaions
+  */
+  get isProcessingUndoRedo(): boolean;
+  /*
   * This method performs undo uperation if possible.
   */
   undo(): void;
@@ -1166,17 +1184,21 @@ export declare class CreatorBase<T extends SurveyModel = SurveyModel> {
   showPageNavigator: any;
   showTabs: any;
   showToolbar: any;
+  allowCollapseSidebar: any;
   isMobileView: any;
   toolboxLocation: any;
-  sideBarLocation: "left" | "right";
+  sidebarLocation: "left" | "right";
   selectFromStringEditor: boolean;
 }
 export declare class CreatorResponsivityManager {
   constructor(container: any, creator: any);
   resizeObserver: any;
   currentWidth: any;
-  prevToolboxLocation: any;
+  prevShowToolbox: any;
+  prevToolboxIsCompact: any;
+  prevShowPageNavigator: any;
   screenWidth: any;
+  devicePixelRatio: any;
   process(): void;
   dispose(): void;
 }
@@ -1749,8 +1771,8 @@ export declare class SelectionHistory extends Base {
   selectFromAction(obj: Base, propertyName: string): void;
   onObjSelected(obj: Base): void;
 }
-export declare class SideBarComponent extends SurveyElementBase<ISideBarComponentProps, any> {
-  constructor(props: ISideBarComponentProps);
+export declare class SidebarComponent extends SurveyElementBase<ISidebarComponentProps, any> {
+  constructor(props: ISidebarComponentProps);
   containerRef: any;
   get model(): any;
   protected getStateElement(): Base;
@@ -1759,13 +1781,13 @@ export declare class SideBarComponent extends SurveyElementBase<ISideBarComponen
   canRender(): boolean;
   renderElement(): any;
 }
-export declare class SideBarModel extends Base {
+export declare class SidebarModel extends Base {
   constructor(creator: any, collapseAction?: any, expandAction?: any);
   toolbar: any;
   _expandAction: Action;
   _collapseAction: Action;
-  _activeTab: SideBarTabModel;
-  onPropertyGridVisibilityChanged: any;
+  _activeTab: SidebarTabModel;
+  onSidebarVisibilityChanged: any;
   resizeManager: ResizeManager;
   tabs: any;
   headerText: string;
@@ -1779,23 +1801,23 @@ export declare class SideBarModel extends Base {
   get closeText(): string;
   getTabById(id: string): any;
   getExpandAction(): Action;
-  collapseSideBar(): void;
-  expandSideBar(): void;
-  addTab(id: string, componentName?: string, model?: any, buildActions?: any): SideBarTabModel;
+  collapseSidebar(): void;
+  expandSidebar(): void;
+  addTab(id: string, componentName?: string, model?: any, buildActions?: any): SidebarTabModel;
   updateHasVisibleTabs(): void;
   dispose(): void;
   initResizeManager(container: any): void;
   resetResizeManager(): void;
 }
-export declare class SideBarTab extends SurveyElementBase<any, any> {
+export declare class SidebarTab extends SurveyElementBase<any, any> {
   constructor(props: any);
   protected getStateElement(): Base;
   renderElement(): any;
 }
-export declare class SideBarTabModel extends Base {
-  constructor(id: string, sidePanel: SideBarModel, componentName?: string, model?: any);
+export declare class SidebarTabModel extends Base {
+  constructor(id: string, sidePanel: SidebarModel, componentName?: string, model?: any);
   id: string;
-  sidePanel: SideBarModel;
+  sidePanel: SidebarModel;
   caption: string;
   visible: boolean;
   model: any;
@@ -1837,7 +1859,7 @@ export declare class SurveyCreatorComponent extends SurveyElementBase<ISurveyCre
   renderElement(): any;
   renderActiveTab(): any;
   renderCreatorTab(tab: any): any;
-  renderSideBar(): any;
+  renderSidebar(): any;
 }
 export declare class SurveyCreatorToolboxItem extends SurveyElementBase<ISurveyCreatorToolboxItemProps, any> {
   constructor(props: any);
@@ -2404,6 +2426,7 @@ export declare class Translation extends Base implements ITranslationLocales {
   availableTranlationsChangedCallback: any;
   tranlationChangedCallback: any;
   translationStringVisibilityCallback: any;
+  localeInitialVisibleCallback: any;
   surveyValue: SurveyModel;
   settingsSurveyValue: SurveyModel;
   onBaseObjCreatingCallback: any;
@@ -2517,6 +2540,7 @@ export declare class UndoRedoManager {
   transactionCounter: number;
   startTransaction(name: string): void;
   stopTransaction(): void;
+  get isProcessingUndoRedo(): boolean;
   canUndo(): boolean;
   undo(): void;
   canRedo(): boolean;
@@ -2765,8 +2789,8 @@ export declare class TabDesignerPlugin<T> implements ICreatorPlugin {
   constructor(creator: any);
   model: any;
   propertyGrid: any;
-  propertyGridTab: SideBarTabModel;
-  toolboxTab: SideBarTabModel;
+  propertyGridTab: SidebarTabModel;
+  toolboxTab: SidebarTabModel;
   surveySettingsAction: Action;
   saveSurveyAction: Action;
   previewAction: Action;
@@ -2832,7 +2856,7 @@ export declare class TabTranslationPlugin implements ICreatorPlugin {
   exportCsvAction: Action;
   inputFileElement: any;
   pagePopupModel: any;
-  sideBarTab: SideBarTabModel;
+  sidebarTab: SidebarTabModel;
   model: Translation;
   activate(): void;
   update(): void;
@@ -3383,9 +3407,13 @@ export declare var editorLocalization: {
 };
 export declare var defaultStrings: any;
 export declare var settings: {
-  traslation: {
+  translation: {
     sortByName: boolean,
     exportPrefix: string,
+    /*
+    * The maximum number of locales that user can select at once for translation
+    */
+    maximumSelectedLocales: number,
   },
   operators: {
     empty: any,
@@ -3411,7 +3439,6 @@ export declare var settings: {
   */
   questionConvertMode: QuestionConvertMode,
   propertyGrid: {
-    allowCollapse: boolean,
     useButtonGroup: boolean,
     maxCharsInButtonGroup: number,
     showNavigationButtons: boolean,
@@ -3445,6 +3472,7 @@ export declare var settings: {
   layout: {
     showTabs: boolean,
     showToolbar: boolean,
+    allowCollapseSidebar: boolean,
   },
   jsonEditor: {
     indentation: number,