survey-react 1.9.39 → 1.9.40

package/survey.react.d.ts

@@ -1,5 +1,5 @@
 /*
-* Type definition for Survey JavaScript library for React v1.9.39
+* Type definition for Survey JavaScript library for React v1.9.40
 * Copyright (c) 2015-2022 Devsoft Baltic OÜ  - https://surveyjs.io/
 * License: MIT (http://www.opensource.org/licenses/mit-license.php)
 */
@@ -189,6 +189,10 @@ export interface IAction {
   visibleIndex?: number;
   needSpace?: boolean;
 }
+export interface IAttachKey2clickOptions {
+  processEsc?: boolean;
+  disableTabStop?: boolean;
+}
 export interface IDimensions {
   scroll: number;
   offset: number;
@@ -531,24 +535,127 @@ export interface IQuestionPanelDynamicData {
   getSurvey(): ISurvey;
   getRootData(): ISurveyData;
 }
-export interface ICustomComponentDescription {
+/*
+* An interface used to create custom question types.
+* 
+* Refer to the following articles for more information:
+* 
+* - [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types)
+* - [Create Composite Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types)
+*/
+export interface ICustomQuestionTypeConfiguration {
+  /*
+  * A name used to identify a custom question type.
+  */
   name: string;
+  /*
+  * A title used for this custom question type in the UI. When `title` is not specified, the `name` property value is used.
+  */
+  title?: string;
+  /*
+  * An icon for the custom question type.
+  */
+  icon?: string;
+  /*
+  * A function that is called when the custom question type is initialized. Use it to add, remove, or modify the type's properties (see [Override Base Question Properties](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types#override-base-question-properties)).
+  */
   onInit(): void;
   /*
-  * Set this property to false if you don't want to show the component in toolbox in Creator
+  * Specifies whether the custom question type is available in the Toolbox and the Add Question menu.
+  * 
+  * Default value: `true`
+  * 
+  * Set this property to `false` if your custom question type is used only to customize Property Grid content and is not meant for a survey.
   */
   showInToolbox?: boolean;
+  /*
+  * A function that is called when the custom question is created. Use it to access questions nested within a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  */
   onCreated(question: Question): void;
+  /*
+  * A function that is called when JSON definitions are loaded.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  */
   onLoaded(question: Question): void;
+  /*
+  * A function that is called after the entire question is rendered.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  * - `htmlElement`: any - An HTML element that represents the custom question.
+  */
   onAfterRender(question: Question, htmlElement: any): void;
+  /*
+  * A function that is called each time a question nested within a [composite question](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types) is rendered.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The composite question.
+  * - `element`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - A nested question.
+  * - `htmlElement`: any - An HTML element that represents the nested question.
+  */
   onAfterRenderContentElement(question: Question, element: Question, htmlElement: any): void;
+  /*
+  * A function that is called when a custom question type property is changed. Use it to handle property changes.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  * - `propertyName`: string - The name of the changed property.
+  * - `newValue`: any - A new value for the property.
+  */
   onPropertyChanged(question: Question, propertyName: string, newValue: any): void;
+  /*
+  * A function that is called when the question value is changed.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  * - `name`: string -  The question's [name](https://surveyjs.io/Documentation/Library?id=Question#name).
+  * - `newValue`: any - A new value for the question.
+  */
   onValueChanged(question: Question, name: string, newValue: any): void;
+  /*
+  * A function that is called when an [ItemValue](https://surveyjs.io/Documentation/Library?id=itemvalue) property is changed.
+  * 
+  * Parameters:
+  * 
+  * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question) - The custom question.
+  * - `options.obj`: [ItemValue](https://surveyjs.io/Documentation/Library?id=itemvalue) - An `ItemValue` object.
+  * - `options.propertyName`: string - The name of the property to which an array of `ItemValue` objects is assigned (for example, `"choices"` or `"rows"`).
+  * - `options.name`: string - The name of the changed property: `"text"` or `"value"`.
+  * - `options.newValue`: any - A new value for the property.
+  */
   onItemValuePropertyChanged(question: Question, options: any): void;
+  /*
+  * A function that allows you to override the default `getDisplayValue()` implementation.
+  */
   getDisplayValue?: any;
+  /*
+  * JSON definitions of nested questions. Specify this property to create a [composite question type](https://surveyjs.io/Documentation/Survey-Creator?id=create-composite-question-types).
+  */
   elementsJSON?: any;
+  /*
+  * A function that allows you to create nested questions if you do not specify the `elementsJSON` property.
+  */
   createElements?: any;
+  /*
+  * A JSON definition for a built-in question type on which the custom question type is based.
+  * 
+  * Refer to the [Create Specialized Question Types](https://surveyjs.io/Documentation/Survey-Creator?id=create-specialized-question-types) help topic for more information.
+  */
   questionJSON?: any;
+  /*
+  * A function that allows you to create a custom question if you do not specify the `questionJSON` property.
+  */
   createQuestion?: any;
 }
 export interface IActionBarItemProps {
@@ -812,6 +919,11 @@ export declare class Bindings {
   getJson(): any;
   setJson(value: any): void;
 }
+export declare class BrandInfo extends React.Component<any, any> {
+  constructor(props: any);
+  constructor(props: any, context: any);
+  render(): JSX.Element;
+}
 export declare class ButtonGroupItemModel {
   constructor(question: QuestionButtonGroupModel, item: ItemValue, index: number);
   question: QuestionButtonGroupModel;
@@ -838,7 +950,7 @@ export declare class ComponentCollection {
   onCreateComposite: (name: string, questionJSON: ComponentQuestionJSON) => QuestionCompositeModel;
   onCreateCustom: (name: string, questionJSON: ComponentQuestionJSON) => QuestionCustomModel;
   onAddingJson: (name: string, isComposite: boolean) => void;
-  add(json: ICustomComponentDescription): void;
+  add(json: ICustomQuestionTypeConfiguration): void;
   get items(): any;
   getCustomQuestionByName(name: string): ComponentQuestionJSON;
   clear(): void;
@@ -847,9 +959,9 @@ export declare class ComponentCollection {
   protected createCustomModel(name: string, questionJSON: ComponentQuestionJSON): QuestionCustomModel;
 }
 export declare class ComponentQuestionJSON {
-  constructor(name: string, json: ICustomComponentDescription);
+  constructor(name: string, json: ICustomQuestionTypeConfiguration);
   name: string;
-  json: ICustomComponentDescription;
+  json: ICustomQuestionTypeConfiguration;
   onInit(): void;
   onCreated(question: Question): void;
   onLoaded(question: Question): void;
@@ -1801,6 +1913,16 @@ export declare class DragDropCore<T> extends Base {
   protected clear: any;
   protected doClear(): void;
 }
+export declare class DropdownListModel extends Base {
+  constructor(question: Question);
+  _popupModel: any;
+  get popupModel(): any;
+  updateItems(): void;
+  onClick(event: any): void;
+  onClear(event: any): void;
+  onKeyUp(event: any): void;
+  onBlur(event: any): void;
+}
 export declare class EventBase<T> extends Event<any, any> {
 }
 export declare class ExceedSizeError extends SurveyError {
@@ -2086,6 +2208,7 @@ export declare class LocalizableString implements ILocalizableString {
   localizationName: string;
   onGetTextCallback: (str: string) => string;
   onGetDefaultTextCallback: any;
+  storeDefaultText: boolean;
   onGetLocalizationTextCallback: (str: string) => string;
   onStrChanged: (oldValue: string, newValue: string) => void;
   onSearchChanged: any;
@@ -2180,6 +2303,9 @@ export declare class MatrixDropdownColumn extends Base implements ILocalizableOw
   get fullTitle(): string;
   get isRequired(): boolean;
   set isRequired(val: boolean);
+  get isRenderedRequired(): boolean;
+  set isRenderedRequired(val: boolean);
+  updateIsRenderedRequired(val: boolean): void;
   get requiredText(): string;
   get requiredErrorText(): string;
   set requiredErrorText(val: string);
@@ -4279,6 +4405,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
   get completedStateCss(): string;
   getCompletedStateCss(): string;
   lazyRenderingValue: boolean;
+  showBrandInfo: boolean;
   /*
   * By default all rows are rendered no matters if they are visible or not.
   * Set it true, and survey markup rows will be rendered only if they are visible in viewport.
@@ -5637,6 +5764,13 @@ export declare class SurveyQuestionMatrixDynamicRemoveButton extends ReactSurvey
   handleOnRowRemoveClick(event: any): void;
   protected renderElement(): JSX.Element;
 }
+export declare class SurveyQuestionMatrixHeaderRequired extends ReactSurveyElement {
+  constructor(props: any);
+  get column(): MatrixDropdownColumn;
+  get question(): any;
+  protected getStateElement(): Base;
+  protected renderElement(): JSX.Element;
+}
 export declare class SurveyQuestionMatrixRow extends ReactSurveyElement {
   constructor(props: any);
   handleOnChange(event: any): void;
@@ -6725,10 +6859,14 @@ export declare class SurveyQuestionCustom extends SurveyQuestionUncontrolledElem
 }
 export declare class SurveyQuestionDropdownBase<T> extends SurveyQuestionUncontrolledElement<T> {
   constructor(props: any);
-  onClick: (event: any) => void;
+  click: (event: any) => void;
+  clear: (event: any) => void;
+  keyup: (event: any) => void;
+  blur: (event: any) => void;
   protected setValueCore(newValue: any): void;
   protected getValueCore(): any;
   protected renderSelect(cssClasses: any): JSX.Element;
+  createClearButton(): JSX.Element;
 }
 export declare class SurveyQuestionMatrixDropdown extends SurveyQuestionMatrixDropdownBase {
   constructor(props: any);
@@ -8426,6 +8564,7 @@ export declare class QuestionCustomModel extends QuestionCustomModelBase {
 */
 export declare class QuestionDropdownModel extends QuestionSelectBase {
   constructor(name: string);
+  dropdownListModel: DropdownListModel;
   get showOptionsCaption(): boolean;
   set showOptionsCaption(val: boolean);
   get optionsCaption(): string;
@@ -8470,13 +8609,12 @@ export declare class QuestionDropdownModel extends QuestionSelectBase {
   denySearch: boolean;
   getControlClass(): string;
   get readOnlyText(): any;
-  onClear(event: any): void;
-  protected onVisibleChoicesChanged(): void;
-  _popupModel: any;
   get popupModel(): any;
   onOpened: EventBase<QuestionDropdownModel>;
   onOpenedCallBack(): void;
-  onClick(event: any): void;
+  protected onVisibleChoicesChanged(): void;
+  onClick(e: any): void;
+  onKeyUp(event: any): void;
 }
 /*
 * A Model for html question. Unlike other questions it doesn't have value and title.
@@ -8563,6 +8701,8 @@ export declare class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseM
   onHasDetailPanelCallback: (row: MatrixDropdownRowModelBase) => boolean;
   onCreateDetailPanelCallback: (row: MatrixDropdownRowModelBase, panel: PanelModel) => void;
   onCreateDetailPanelRenderedRowCallback: (renderedRow: QuestionMatrixDropdownRenderedRow) => void;
+  onAddColumn: (column: MatrixDropdownColumn) => void;
+  onRemoveColumn: (column: MatrixDropdownColumn) => void;
   protected createColumnValues(): any;
   /*
   * Returns the type of the object as a string as it represents in the json.
@@ -8953,7 +9093,6 @@ export declare class QuestionTextModel extends QuestionTextBase {
 export declare class SurveyQuestionDropdownSelect extends SurveyQuestionDropdown {
   constructor(props: any);
   protected renderSelect(cssClasses: any): JSX.Element;
-  createClearButton(): JSX.Element;
 }
 /*
 * A Model for a button group question.
@@ -9406,7 +9545,7 @@ export declare function getSize(value: any): any;
 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 attachKey2click(element: JSX.Element, viewModel?: any, options?: any): JSX.Element;
+export declare function attachKey2click(element: JSX.Element, viewModel?: any, options?: IAttachKey2clickOptions): JSX.Element;
 /*
 * Global survey settings
 */
@@ -9606,6 +9745,10 @@ export declare var settings: {
     panel: string,
     question: string,
   },
+  questions: {
+    inputTypes: any,
+    dataList: any,
+  },
 };
 export declare var surveyLocalization: {
   currentLocaleValue: string,
@@ -11041,6 +11184,7 @@ export declare var defaultV2Css: {
     maxText: string,
     itemDisabled: string,
     control: string,
+    controlValue: string,
     controlDisabled: string,
     controlEmpty: string,
     onError: string,