survey-react 1.9.41 → 1.9.44

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.41
+* Type definition for Survey JavaScript library for React v1.9.44
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -92,6 +92,47 @@ export interface IExpresionExecutor {
   */
   onComplete: (res: any) => void;
 }
+export interface IListModel {
+  items: any;
+  onSelectionChanged: (item: Action, ...params: any) => void;
+  allowSelection?: boolean;
+  selectedItem?: IAction;
+  onFilteredTextChangedCallback?: (text: string) => void;
+}
+export interface IPosition {
+  left?: string | number;
+  top?: string | number;
+}
+export interface INumberPosition extends IPosition {
+  left?: number;
+  top?: number;
+}
+export interface ISize {
+  width: number;
+  height: number;
+}
+export interface IPopupOptionsBase {
+  onHide?: any;
+  onShow?: any;
+  onApply?: any;
+  onCancel?: any;
+  cssClass?: string;
+  title?: string;
+  verticalPosition?: any;
+  horizontalPosition?: any;
+  showPointer?: boolean;
+  isModal?: boolean;
+  displayMode?: "popup" | "overlay";
+}
+export interface IDialogOptions extends IPopupOptionsBase {
+  componentName: string;
+  data: any;
+  onApply: any;
+}
+export interface IPopupModel<T = any> extends IDialogOptions {
+  contentComponentName: string;
+  contentComponentData: T;
+}
 /*
 * An action item.
 * Action items are used in the Toolbar, matrix rows, titles of pages, panels, questions, and other survey elements.
@@ -189,6 +230,8 @@ export interface IAction {
   visibleIndex?: number;
   needSpace?: boolean;
 }
+export interface IActionDropdownPopupOptions extends IListModel, IPopupOptionsBase {
+}
 export interface IAttachKey2clickOptions {
   processEsc?: boolean;
   disableTabStop?: boolean;
@@ -197,21 +240,10 @@ export interface IDimensions {
   scroll: number;
   offset: number;
 }
-export interface IPosition {
-  left?: string | number;
-  top?: string | number;
-}
-export interface INumberPosition extends IPosition {
-  left?: number;
-  top?: number;
-}
-export interface ISize {
-  width: number;
-  height: number;
-}
 export interface ISurveyTriggerOwner {
   getObjects(pages: any, questions: any): Array<any>;
-  setCompleted(): any;
+  setCompleted(): void;
+  canBeCompleted(): void;
   triggerExecuted(trigger: Trigger): void;
   setTriggerValue(name: string, value: any, isVariable: boolean): any;
   copyTriggerValue(name: string, fromName: string): any;
@@ -1461,6 +1493,8 @@ export declare class SurveyError {
   protected getDefaultText(): string;
   protected getLocale(): string;
   protected getLocalizationString(locStrName: string): string;
+  onUpdateErrorTextCallback: (error: SurveyError) => void;
+  updateText(): void;
 }
 export declare class SurveyHeader extends React.Component<ISurveyHeaderProps, any> {
   constructor(props: ISurveyHeaderProps);
@@ -1478,10 +1512,12 @@ export declare class SurveyLocStringEditor extends React.Component<any, any> {
 }
 export declare class SurveyLocStringViewer extends React.Component<any, any> {
   constructor(props: any);
+  rootRef: any;
   componentDidMount(): void;
   componentWillUnmount(): void;
   componentDidUpdate(prevProps: any, prevState: any): void;
   isRendering: boolean;
+  onChangedHandler: (sender: any, options: any) => void;
   render(): JSX.Element;
   protected renderString(): JSX.Element;
 }
@@ -1668,6 +1704,7 @@ export declare class ActionContainer<T extends Action = Action> extends Base {
   updateCallback: (isResetInitialized: boolean) => void;
   containerCss: string;
   sizeMode: "default" | "small";
+  isEmpty: boolean;
   protected raiseUpdate(isResetInitialized: boolean): void;
   protected onSet(): void;
   protected onPush(item: T): void;
@@ -1915,9 +1952,14 @@ export declare class DragDropCore<T> extends Base {
   protected doClear(): void;
 }
 export declare class DropdownListModel extends Base {
-  constructor(question: Question);
+  constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
   _popupModel: any;
+  protected listModel: ListModel;
+  protected popupCssClasses: string;
+  protected getAvailableItems(): Array<Action>;
+  protected createListModel(): ListModel;
   get popupModel(): any;
+  setSearchEnabled(newValue: boolean): void;
   updateItems(): void;
   onClick(event: any): void;
   onClear(event: any): void;
@@ -2019,7 +2061,6 @@ export declare class ItemValue extends Base implements ILocalizableOwner, IShort
   static runEnabledConditionsForItems(items: any, runner: ConditionRunner, values: any, properties: any, onItemCallBack?: (item: ItemValue, val: boolean) => boolean): boolean;
   ownerPropertyName: string;
   locTextValue: LocalizableString;
-  isVisibleValue: boolean;
   visibleConditionRunner: ConditionRunner;
   enableConditionRunner: ConditionRunner;
   onCreating(): any;
@@ -2047,7 +2088,7 @@ export declare class ItemValue extends Base implements ILocalizableOwner, IShort
   set visibleIf(val: string);
   get enableIf(): string;
   set enableIf(val: string);
-  get isVisible(): boolean;
+  get isVisible(): any;
   setIsVisible(val: boolean): void;
   get isEnabled(): any;
   setIsEnabled(val: boolean): void;
@@ -2240,6 +2281,7 @@ export declare class LocalizableString implements ILocalizableString {
   searchableText: string;
   setFindText(text: string): boolean;
   onChanged(): void;
+  onStringChanged: EventBase<LocalizableString>;
   protected onCreating(): void;
   getHtmlValue(): string;
 }
@@ -2532,6 +2574,9 @@ export declare class MultipleTextItemModel extends Base implements IValidatorOwn
   /*
   * The input place holder.
   */
+  get placeholder(): string;
+  set placeholder(val: string);
+  get locPlaceholder(): LocalizableString;
   get placeHolder(): string;
   set placeHolder(val: string);
   get locPlaceHolder(): LocalizableString;
@@ -2884,7 +2929,7 @@ export declare class SurveyButtonGroupItem extends SurveyElementBase<any, any> {
   get question(): any;
   get item(): any;
   getStateElement(): any;
-  render(): JSX.Element;
+  renderElement(): JSX.Element;
   protected renderIcon(): JSX.Element;
   protected renderInput(): JSX.Element;
   protected renderCaption(): JSX.Element;
@@ -3147,7 +3192,9 @@ export declare class Trigger extends Base {
   set name(val: string);
   get expression(): string;
   set expression(val: string);
-  checkExpression(keys: any, values: any, properties?: any): void;
+  protected canBeExecuted(isOnNextPage: boolean): boolean;
+  protected isExecutingOnNextPage: boolean;
+  checkExpression(isOnNextPage: boolean, keys: any, values: any, properties?: any): void;
   check(value: any): void;
   protected onSuccess(values: any, properties: any): void;
   protected onFailure(): void;
@@ -3194,12 +3241,11 @@ export declare class WebRequestError extends SurveyError {
 export declare class AdaptiveActionContainer<T extends Action = Action> extends ActionContainer<T> {
   constructor();
   protected dotsItem: Action;
-  protected dotsItemPopupModel: any;
   responsivityManager: ResponsivityManager;
   minVisibleItemsCount: number;
   isResponsivenessDisabled: boolean;
-  protected invisibleItemsListModel: ListModel;
   static ContainerID: number;
+  get invisibleItemsListModel(): ListModel;
   protected onSet(): void;
   protected onPush(item: T): void;
   protected getRenderedActions(): Array<T>;
@@ -3210,6 +3256,9 @@ export declare class AdaptiveActionContainer<T extends Action = Action> extends
   setActionsMode(mode: any): void;
   dispose(): void;
 }
+/*
+* Validates the number of answers.
+*/
 export declare class AnswerCountValidator extends SurveyValidator {
   constructor(minCount?: number, maxCount?: number);
   getType(): string;
@@ -3312,6 +3361,17 @@ export declare class DragDropSurveyElements extends DragDropCore<any> {
   protected insertGhostElementIntoSurvey(): boolean;
   protected removeGhostElementFromSurvey(): void;
 }
+export declare class DropdownMultiSelectListModel extends DropdownListModel {
+  constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any) => void);
+  protected override: any;
+  createListModel(): MultiSelectListModel;
+  selectAllItems(): void;
+  selectNoneItem(): void;
+  selectItem(id: string): void;
+  deselectItem(id: string): void;
+  onClear(event: any): void;
+  setHideSelectedItems(newValue: boolean): void;
+}
 /*
 * Validate e-mail address in the text input
 */
@@ -3384,10 +3444,10 @@ export declare class JsonMissingTypeError extends JsonMissingTypeErrorBase {
   baseClassName: string;
 }
 export declare class ListModel extends ActionContainer {
-  constructor(items: any, onItemSelect: (item: Action) => void, allowSelection: boolean, selectedItem?: IAction, onFilteredTextChangedCallback?: (text: string) => void);
-  onItemSelect: (item: Action) => void;
+  constructor(items: any, onSelectionChanged: (item: Action, ...params: any) => void, allowSelection: boolean, selectedItem?: IAction, onFilteredTextChangedCallback?: (text: string) => void);
+  onSelectionChanged: (item: Action, ...params: any) => void;
   allowSelection: boolean;
-  denySearch: boolean;
+  searchEnabled: boolean;
   needFilter: boolean;
   isExpanded: boolean;
   selectedItem: IAction;
@@ -3396,7 +3456,8 @@ export declare class ListModel extends ActionContainer {
   static MINELEMENTCOUNT: number;
   isItemVisible(item: Action): boolean;
   protected onSet(): void;
-  selectItem: (itemValue: Action) => void;
+  protected updateItemActiveState(): void;
+  onItemClick: (itemValue: Action) => void;
   isItemDisabled: (itemValue: Action) => boolean;
   isItemSelected: (itemValue: Action) => boolean;
   getItemClass: (itemValue: Action) => string;
@@ -3668,6 +3729,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   get isErrorsModeTooltip(): boolean;
   protected getIsErrorsModeTooltip(): boolean;
   get hasParent(): boolean;
+  isSingleInRow: boolean;
   protected get hasFrameV2(): boolean;
   /*
   * Use it to set the specific width to the survey element like css style (%, px, em etc).
@@ -3708,6 +3770,7 @@ export declare class SurveyElement extends SurveyElementCore implements ISurveyE
   get clickTitleFunction(): any;
   protected needClickTitleFunction(): boolean;
   protected processTitleClick(): void;
+  localeChanged(): void;
 }
 export declare class SurveyElementErrors extends ReactSurveyElement {
   constructor(props: any);
@@ -4403,6 +4466,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   cssValue: any;
   get css(): any;
   set css(val: any);
+  setCss(value: any, needMerge?: boolean): void;
   get cssTitle(): string;
   get cssNavigationComplete(): string;
   get cssNavigationPreview(): string;
@@ -5206,6 +5270,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   protected doServerValidation(doComplete: boolean, isPreview?: boolean): boolean;
   protected doNextPage(): void;
   setCompleted(): void;
+  canBeCompleted(): void;
   /*
   * Returns the HTML content for the complete page.
   */
@@ -5641,7 +5706,7 @@ export declare class SurveyQuestionButtonGroup extends SurveyQuestionElementBase
   constructor(props: any);
   protected get question(): any;
   getStateElement(): any;
-  render(): JSX.Element;
+  renderElement(): JSX.Element;
   renderItems(): any;
 }
 export declare class SurveyQuestionCheckbox extends SurveyQuestionElementBase {
@@ -5888,6 +5953,14 @@ export declare class SurveyQuestionSignaturePad extends SurveyQuestionElementBas
   protected renderElement(): JSX.Element;
   renderCleanButton(): JSX.Element;
 }
+export declare class SurveyQuestionTagboxItem extends ReactSurveyElement {
+  constructor(props: any);
+  protected getStateElement(): Base;
+  protected get question(): any;
+  protected get item(): ItemValue;
+  protected canRender(): boolean;
+  protected renderElement(): JSX.Element;
+}
 export declare class SurveyQuestionUncontrolledElement<T> extends SurveyQuestionElementBase {
   constructor(props: any);
   protected get question(): T;
@@ -5911,7 +5984,7 @@ export declare class SurveyTrigger extends Trigger {
   get owner(): ISurveyTriggerOwner;
   setOwner(owner: ISurveyTriggerOwner): void;
   getSurvey(live?: boolean): ISurvey;
-  get isOnNextPage(): boolean;
+  protected isRealExecution(): boolean;
   protected onSuccessExecuted(): void;
 }
 export declare class SurveyWindow extends Survey {
@@ -5992,6 +6065,15 @@ export declare class DragDropRankingChoices extends DragDropChoices {
   protected doDrop: any;
   protected doClear: any;
 }
+export declare class MultiSelectListModel extends ListModel {
+  constructor(items: any, onSelectionChanged: (item: Action, status: string) => void, allowSelection: boolean, selectedItems?: any, onFilteredTextChangedCallback?: (text: string) => void);
+  selectedItems: any;
+  hideSelectedItems: boolean;
+  onItemClick: (item: Action) => void;
+  isItemDisabled: (itemValue: Action) => boolean;
+  isItemSelected: (itemValue: Action) => boolean;
+  setSelectedItems(newItems: any): void;
+}
 /*
 * A base class for a Panel and Page objects.
 */
@@ -6886,7 +6968,9 @@ export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontr
   protected setValueCore(newValue: any): void;
   protected getValueCore(): any;
   protected renderSelect(cssClasses: any): JSX.Element;
+  protected renderInput(): JSX.Element;
   createClearButton(): JSX.Element;
+  protected renderOther(cssClasses: any): JSX.Element;
 }
 export declare class SurveyQuestionMatrixDropdown extends SurveyQuestionMatrixDropdownBase {
   constructor(props: any);
@@ -6944,7 +7028,7 @@ export declare class SurveyQuestionText extends SurveyQuestionUncontrolledElemen
 export declare class SurveyTriggerComplete extends SurveyTrigger {
   constructor();
   getType(): string;
-  get isOnNextPage(): boolean;
+  protected isRealExecution(): boolean;
   protected onSuccess(values: any, properties: any): void;
 }
 /*
@@ -6994,7 +7078,7 @@ export declare class SurveyTriggerSkip extends SurveyTrigger {
   getType(): string;
   get gotoName(): string;
   set gotoName(val: string);
-  get isOnNextPage(): boolean;
+  protected canBeExecuted(isOnNextPage: boolean): boolean;
   protected onSuccess(values: any, properties: any): void;
 }
 /*
@@ -8407,6 +8491,9 @@ export declare class QuestionTextBase extends Question {
   /*
   * Use this property to set the input place holder.
   */
+  get placeholder(): string;
+  set placeholder(val: string);
+  get locPlaceholder(): LocalizableString;
   get placeHolder(): string;
   set placeHolder(val: string);
   get locPlaceHolder(): LocalizableString;
@@ -8425,12 +8512,12 @@ export declare class QuestionTextBase extends Question {
   get textUpdateMode(): string;
   set textUpdateMode(val: string);
   get isSurveyInputTextUpdate(): boolean;
-  get renderedPlaceHolder(): string;
-  protected setRenderedPlaceHolder(val: string): void;
+  get renderedPlaceholder(): string;
+  protected setRenderedPlaceholder(val: string): void;
   protected onReadOnlyChanged(): void;
   onSurveyLoad(): void;
   localeChanged(): void;
-  protected calcRenderedPlaceHolder(): void;
+  protected calcRenderedPlaceholder(): void;
   protected hasPlaceHolder(): boolean;
   getControlClass(): string;
   get ariaRole(): string;
@@ -8438,10 +8525,10 @@ export declare class QuestionTextBase extends Question {
 export declare class SurveyQuestionDropdown extends SurveyQuestionDropdownBase<Question> {
   constructor(props: any);
   protected renderElement(): JSX.Element;
-  protected renderOther(cssClasses: any): JSX.Element;
 }
 export declare class SurveyQuestionMatrixDropdownCell extends SurveyQuestionAndErrorsCell {
   constructor(props: any);
+  protected get itemCss(): string;
   protected getQuestion(): Question;
   protected doAfterRender(): void;
   protected getShowErrors(): boolean;
@@ -8453,6 +8540,12 @@ export declare class SurveyQuestionRatingDropdown extends SurveyQuestionDropdown
   constructor(props: any);
   protected renderElement(): JSX.Element;
 }
+export declare class SurveyQuestionTagbox extends SurveyQuestionDropdownBase<QuestionTagboxModel> {
+  constructor(props: any);
+  protected renderItem(key: string, item: any): JSX.Element;
+  protected renderInput(): JSX.Element;
+  protected renderElement(): JSX.Element;
+}
 /*
 * The flow panel object. It is a container with flow layout where you can mix questions with markdown text.
 */
@@ -8596,7 +8689,7 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
   get optionsCaption(): string;
   set optionsCaption(val: string);
   /*
-  * The input place holder.
+  * A text displayed in the input field when it doesn't have a value.
   */
   get placeholder(): string;
   set placeholder(val: string);
@@ -8628,11 +8721,17 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
   get autoComplete(): string;
   set autoComplete(val: string);
   /*
-  * Use it to clear the question value.
+  * Specifies whether to display a button that clears the selected value.
   */
   allowClear: boolean;
+  /*
+  * The name of a component used to render drop-down menu items.
+  */
   itemComponent: string;
-  denySearch: boolean;
+  /*
+  * Specifies whether to display a search bar in the drop-down menu.
+  */
+  searchEnabled: boolean;
   getControlClass(): string;
   get readOnlyText(): any;
   get popupModel(): any;
@@ -9564,14 +9663,51 @@ export declare class QuestionRankingModel extends QuestionCheckboxModel {
   get longTap(): boolean;
   set longTap(val: boolean);
 }
+/*
+* A Model for a tagbox question
+*/
+export declare class QuestionTagboxModel extends QuestionCheckboxModel {
+  constructor(name: string);
+  dropdownListModel: DropdownMultiSelectListModel;
+  get readOnlyText(): string;
+  onSurveyLoad(): void;
+  /*
+  * Specifies whether to display a button that clears the selected value.
+  */
+  allowClear: boolean;
+  /*
+  * Specifies whether to display a search bar in the drop-down menu.
+  */
+  searchEnabled: boolean;
+  hideSelectedItems: boolean;
+  /*
+  * A text displayed in the input field when it doesn't have a value.
+  */
+  get placeholder(): string;
+  set placeholder(val: string);
+  get locPlaceholder(): LocalizableString;
+  getType(): string;
+  get popupModel(): any;
+  getControlClass(): string;
+  onOpened: EventBase<QuestionTagboxModel>;
+  onOpenedCallBack(): void;
+  protected onVisibleChoicesChanged(): void;
+}
 export declare function property(options?: any): (target: any, key: string) => void;
 export declare function propertyArray(options?: IArrayPropertyDecoratorOptions): (target: any, key: string) => void;
+export declare function createDialogOptions(componentName: string, data: any, onApply: any, onCancel?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): IDialogOptions;
+export declare function createPopupModalViewModel(options: IDialogOptions): PopupBaseViewModel;
+export declare function createDropdownActionModel(actionOptions: IAction, dropdownOptions: IActionDropdownPopupOptions): Action;
+export declare function createDropdownActionModelAdvanced(actionOptions: IAction, listOptions: IListModel, popupOptions?: IPopupOptionsBase): Action;
 export declare function unwrap<T>(value: any): T;
 export declare function getSize(value: any): any;
+export declare function doKey2ClickBlur(evt: any): void;
+export declare function doKey2ClickUp(evt: any, options?: IAttachKey2clickOptions): void;
+export declare function doKey2ClickDown(evt: any, options?: IAttachKey2clickOptions): void;
 export declare function sanitizeEditableContent(element: any): void;
-export declare function createPopupModalViewModel(componentName: string, data: any, onApply: any, onCancel?: any, onHide?: any, onShow?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): PopupBaseViewModel;
 export declare function getCurrecyCodes(): Array<any>;
 export declare function showModal(componentName: string, data: any, onApply: any, onCancel?: any, cssClass?: string, title?: string, displayMode?: "popup" | "overlay"): void;
+export declare function showDialog(dialogOptions: any): void;
 export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
 /*
 * Global survey settings
@@ -9789,6 +9925,7 @@ export declare var surveyLocalization: {
   getCurrentStrings: (locale?: string) => any,
   getString: (strName: string, locale?: string) => any,
   getLocales: (removeDefaultLoc?: boolean) => any,
+  onGetExternalString: (name: string, locale: string) => string,
 };
 export declare var surveyStrings: any;
 /*
@@ -9809,8 +9946,8 @@ export declare var defaultActionBarCss: {
   itemTitle: string,
   itemTitleWithIcon: string,
 };
-export declare var keyFocusedClassName: any;
 export declare var FOCUS_INPUT_SELECTOR: any;
+export declare var keyFocusedClassName: any;
 export declare var surveyCss: {
   currentType: string,
   getCss: any,
@@ -10146,6 +10283,21 @@ export declare var defaultStandardCss: {
   variables: {
     themeMark: string,
   },
+  tagbox: {
+    root: string,
+    small: string,
+    selectWrapper: string,
+    other: string,
+    cleanButton: string,
+    cleanButtonSvg: string,
+    cleanButtonIconId: string,
+    cleanItemButton: string,
+    cleanItemButtonSvg: string,
+    cleanItemButtonIconId: string,
+    control: string,
+    controlValue: string,
+    controlEmpty: string,
+  },
 };
 export declare var surveyTimerFunctions: {
   setTimeout: (func: any) => any,
@@ -10929,6 +11081,7 @@ export declare var defaultV2Css: {
   pageDescription: string,
   row: string,
   rowMultiple: string,
+  pageRow: string,
   question: {
     mainRoot: string,
     flowRoot: string,
@@ -11333,6 +11486,32 @@ export declare var defaultV2Css: {
     imagepickerGapBetweenItems: string,
     themeMark: string,
   },
+  tagbox: {
+    root: string,
+    small: string,
+    selectWrapper: string,
+    other: string,
+    onError: string,
+    label: string,
+    item: string,
+    itemDisabled: string,
+    itemChecked: string,
+    itemHover: string,
+    itemControl: string,
+    itemDecorator: string,
+    cleanButton: string,
+    cleanButtonSvg: string,
+    cleanButtonIconId: string,
+    cleanItemButton: string,
+    cleanItemButtonSvg: string,
+    cleanItemButtonIconId: string,
+    control: string,
+    controlValue: string,
+    controlDisabled: string,
+    controlEmpty: string,
+    controlLabel: string,
+    materialDecorator: string,
+  },
 };
 export declare var modernCss: {
   root: string,