survey-react 1.9.117 → 1.9.118

package/survey.react.d.ts

@@ -463,6 +463,7 @@ declare module "jsonobject" {
         minValue: any;
         private dataListValue;
         layout: string;
+        onSerializeValue: (obj: any) => any;
         onGetValue: (obj: any) => any;
         onSettingValue: (obj: any, value: any) => any;
         onSetValue: (obj: any, value: any, jsonConv: JsonObject) => any;
@@ -487,6 +488,7 @@ declare module "jsonobject" {
         set defaultValue(newValue: any);
         isDefaultValue(value: any): boolean;
         isDefaultValueByObj(obj: Base, value: any): boolean;
+        getSerializableValue(obj: any): any;
         getValue(obj: any): any;
         getPropertyValue(obj: any): any;
         get hasToUseSetValue(): string | ((obj: any, value: any, jsonConv: JsonObject) => any);
@@ -2300,6 +2302,7 @@ declare module "defaultCss/defaultV2Css" {
         };
         saveData: {
             root: string;
+            rootWithButtons: string;
             info: string;
             error: string;
             success: string;
@@ -3885,7 +3888,9 @@ declare module "question_file" {
         confirmRemoveAllMessage: string;
         noFileChosenCaption: string;
         chooseButtonCaption: string;
-        takePhotoCaption: string;
+        get takePhotoCaption(): string;
+        set takePhotoCaption(val: string);
+        get locTakePhotoCaption(): LocalizableString;
         replaceButtonCaption: string;
         clearButtonCaption: string;
         removeFileCaption: string;
@@ -4235,6 +4240,7 @@ declare module "question_baseselect" {
          * When users select the "None" item in multi-select questions, all other items become unselected.
          * @see noneItem
          * @see noneText
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         get showNoneItem(): boolean;
         set showNoneItem(val: boolean);
@@ -4339,6 +4345,7 @@ declare module "question_baseselect" {
          *
          * [View Demo](https://surveyjs.io/form-library/examples/questiontype-dropdownrestfull/ (linkStyle))
          * @see choices
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         get choicesByUrl(): ChoicesRestful;
         set choicesByUrl(val: ChoicesRestful);
@@ -4361,6 +4368,7 @@ declare module "question_baseselect" {
          * If you need to specify only the `value` property, you can set the `choices` property to an array of primitive values, for example, `[ "item1", "item2", "item3" ]`. These values are both saved in survey results and used as display text.
          * @see choicesByUrl
          * @see choicesFromQuestion
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         get choices(): Array<any>;
         set choices(newValue: Array<any>);
@@ -4432,6 +4440,7 @@ declare module "question_baseselect" {
          * - `"asc"`- Sorts choice items in ascending order.
          * - `"desc"`- Sorts choice items in ascending order.
          * - `"random"` - Displays choice items in random order.
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         get choicesOrder(): string;
         set choicesOrder(val: string);
@@ -4446,6 +4455,7 @@ declare module "question_baseselect" {
          * Displays the "Select All", "None", and "Other" choices on individual rows.
          * @see showNoneItem
          * @see showOtherItem
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         separateSpecialChoices: boolean;
         /**
@@ -4534,7 +4544,6 @@ declare module "question_baseselect" {
         protected getCommentFromValue(newValue: any): string;
         protected setOtherValueIntoValue(newValue: any): any;
         onOtherValueInput(event: any): void;
-        onCompositionUpdateOtherValue(event: any): void;
         onOtherValueChange(event: any): void;
         private isRunningChoices;
         private runChoicesByUrl;
@@ -4925,6 +4934,7 @@ declare module "question_matrixdropdowncolumn" {
         getCellType(): string;
         getCustomCellType(column: MatrixDropdownColumn, row: MatrixDropdownRowModelBase, cellType: string): string;
         onColumnCellTypeChanged(column: MatrixDropdownColumn): void;
+        getCellAriaLabel(rowTitle: string, columnTitle: string): string;
     }
     export var matrixDropdownColumnTypes: any;
     export class MatrixDropdownColumn extends Base implements ILocalizableOwner, IWrapperObject {
@@ -5378,6 +5388,9 @@ declare module "question_matrixdynamic" {
         private dragOrClickHelper;
         constructor(index: number, data: IMatrixDropdownData, value: any);
         get rowName(): string;
+        get dataName(): string;
+        get text(): any;
+        getAccessbilityText(): string;
         get shortcutText(): string;
     }
     /**
@@ -6458,7 +6471,7 @@ declare module "question_paneldynamic" {
 declare module "survey-events-api" {
     import { IAction } from "actions/action";
     import { Base } from "base";
-    import { IElement, ISurveyElement, IValueItemCustomPropValues } from "base-interfaces";
+    import { IElement, IPanel, ISurveyElement, IValueItemCustomPropValues } from "base-interfaces";
     import { ItemValue } from "itemvalue";
     import { PageModel } from "page";
     import { PanelModel, PanelModelBase } from "panel";
@@ -7316,27 +7329,39 @@ declare module "survey-events-api" {
         /**
          * A survey element being dragged.
          */
-        target: IElement;
+        draggedElement: IElement;
         /**
-         * A survey element from which `target` is being dragged. This parameter is `null` if `target` is being dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox).
+         * A survey element from which `draggedElement` is being dragged. This parameter is `null` if `draggedElement` is being dragged from the [Toolbox](https://surveyjs.io/survey-creator/documentation/toolbox).
          */
-        source: IElement;
+        fromElement: IPanel;
+        /**
+         * A survey element to which `draggedElement` is being dragged.
+         */
+        toElement: IElement;
         /**
          * A survey element before which the target element will be placed. This parameter is `null` if the parent container (page or panel) has no elements or if the target element will be placed below all other elements within the container.
          */
         insertBefore: IElement;
         /**
-         * A survey element after which `target` will be placed. This parameter is `null` if the parent container (page or panel) has no elements or if `target` will be placed above all other elements within the container.
+         * A survey element after which `draggedElement` will be placed. This parameter is `null` if the parent container (page or panel) has no elements or if `draggedElement` will be placed above all other elements within the container.
          */
         insertAfter: IElement;
         /**
-         * A parent container (page or panel) within which `target` will be placed.
+         * A parent container (page or panel) within which `draggedElement` will be placed.
          */
         parent: ISurveyElement;
         /**
          * A Boolean property that you can set to `false` if you want to cancel the drag and drop operation.
          */
         allow: boolean;
+        /**
+         * Obsolete. Use `options.draggedElement` instead.
+         */
+        target: IElement;
+        /**
+         * Obsolete. Use `options.toElement` instead.
+         */
+        source: IElement;
     }
     export interface ScrollingElementToTopEvent {
         /**
@@ -7757,6 +7782,15 @@ declare module "notifier" {
     import { Base } from "base";
     import { ActionContainer } from "actions/container";
     import { IAction } from "actions/action";
+    interface INotifierCssClasses {
+        root: string;
+        rootWithButtons: string;
+        info: string;
+        error: string;
+        success: string;
+        button: string;
+        shown: string;
+    }
     export class Notifier extends Base {
         private cssClasses;
         active: boolean;
@@ -7768,14 +7802,7 @@ declare module "notifier" {
         private actionsVisibility;
         actionBar: ActionContainer;
         showActions: boolean;
-        constructor(cssClasses: {
-            root: string;
-            info: string;
-            error: string;
-            success: string;
-            button: string;
-            shown: string;
-        });
+        constructor(cssClasses: INotifierCssClasses);
         getCssClass(type: string): string;
         updateActionsVisibility(type: string): void;
         notify(message: string, type?: string, waitUserAction?: boolean): void;
@@ -7843,11 +7870,10 @@ declare module "question_textbase" {
         protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
         protected convertToCorrectValue(val: any): any;
         protected getValueSeparator(): string;
-        disableNativeUndoRedo: boolean;
-        protected checkForUndo(event: KeyboardEvent): void;
         protected getControlCssClassBuilder(): CssClassBuilder;
         getControlClass(): string;
         get isNewA11yStructure(): boolean;
+        onKeyDownPreprocess: (event: any) => void;
     }
 }
 declare module "question_text" {
@@ -9097,6 +9123,8 @@ declare module "survey" {
          *
          * - `"advanced"`\
          * An advanced header view applies the same properties as the basic view, plus [header settings](https://surveyjs.io/form-library/documentation/api-reference/iheader) from the [survey theme](https://surveyjs.io/form-library/documentation/api-reference/itheme#header). The advanced view features a more flexible header layout, a capability to specify a background image, and other settings that give a more professional look to the survey header.
+         *
+         * [View Demo](https://surveyjs.io/form-library/examples/brand-your-survey-header/ (linkStyle))
          */
         headerView: "advanced" | "basic";
         private getNavigationCss;
@@ -10026,6 +10054,16 @@ declare module "survey" {
         get completedState(): string;
         get completedStateText(): string;
         protected setCompletedState(value: string, text: string): void;
+        /**
+         * Displays a toast notification with a specified message.
+         *
+         * Depending on the `type` argument, a survey can display the following notification types:
+         *
+         * ![Toast notification types in SurveyJS Form Library](https://surveyjs.io//Content/Images/docs/notification-types.png)
+         * @param message A message to display.
+         * @param type A notification type: `"info"` (default), `"success"`, or `"error"`.
+         * @param showActions For internal use.
+         */
         notify(message: string, type: string, showActions?: boolean): void;
         /**
          * Resets the survey [`state`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#state) and, optionally, [`data`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#data). If `state` is `"completed"`, it becomes `"running"`.
@@ -10252,7 +10290,7 @@ declare module "survey" {
         private runningPages;
         private onShowingPreviewChanged;
         private changeCurrentPageFromPreview;
-        private origionalPages;
+        private originalPages;
         protected onQuestionsOnPageModeChanged(oldValue: string): void;
         private restoreOriginalPages;
         private getPageStartIndex;
@@ -11874,7 +11912,6 @@ declare module "question" {
         get isContainer(): boolean;
         protected updateCommentElements(): void;
         onCommentInput(event: any): void;
-        onCompositionUpdateComment(event: any): void;
         onCommentChange(event: any): void;
         afterRenderQuestionElement(el: HTMLElement): void;
         afterRender(el: HTMLElement): void;
@@ -11989,6 +12026,7 @@ declare module "question" {
          * @see otherItem
          * @see otherErrorText
          * @see showCommentArea
+         * @see [settings.specialChoicesOrder](https://surveyjs.io/form-library/documentation/api-reference/settings#specialChoicesOrder)
          */
         get showOtherItem(): boolean;
         set showOtherItem(val: boolean);
@@ -12511,6 +12549,7 @@ declare module "martixBase" {
         get rowTitleWidth(): string;
         set rowTitleWidth(val: string);
         getCellAriaLabel(rowTitle: string, columnTitle: string): string;
+        get isNewA11yStructure(): boolean;
     }
 }
 declare module "question_matrixdropdownbase" {
@@ -12557,6 +12596,7 @@ declare module "question_matrixdropdownbase" {
         data: IMatrixDropdownData;
         private questionValue;
         constructor(column: MatrixDropdownColumn, row: MatrixDropdownRowModelBase, data: IMatrixDropdownData);
+        private updateCellQuestionTitleDueToAccessebility;
         locStrsChanged(): void;
         protected createQuestion(column: MatrixDropdownColumn, row: MatrixDropdownRowModelBase, data: IMatrixDropdownData): Question;
         get question(): Question;
@@ -12592,10 +12632,12 @@ declare module "question_matrixdropdownbase" {
         constructor(data: IMatrixDropdownData, value: any);
         get id(): string;
         get rowName(): any;
+        get dataName(): string;
         get text(): any;
         get value(): any;
         set value(value: any);
         get locText(): LocalizableString;
+        getAccessbilityText(): string;
         get hasPanel(): boolean;
         get detailPanel(): PanelModel;
         get detailPanelId(): string;
@@ -14323,6 +14365,27 @@ declare module "settings" {
          * Default value: `"none"`
          */
         noneItemValue: string;
+        /**
+         * An object whose properties specify the order of the special choice items (None, Other, Select All) in select-based questions.
+         *
+         * Default value: `{ selectAllItem: [-1], noneItem: [1], otherItem: [2] }`
+         *
+         * Use this object to reorder special choices. Each property accepts an array of integer numbers. Negative numbers place a special choice item above regular choice items, positive numbers place it below them. For instance, the code below specifies the following order of choices: None, Select All, regular choices, Other.
+         *
+         * ```js
+         * import { settings } from "survey-core";
+         *
+         * settings.specialChoicesOrder.noneItem = [-2];
+         * settings.specialChoicesOrder.selectAllItem = [-1];
+         * settings.specialChoicesOrder.otherItem = [1];
+         * ```
+         *
+         * If you want to duplicate a special choice item above and below other choices, add two numbers to the corresponding array:
+         *
+         * ```js
+         * settings.specialChoicesOrder.selectAllItem = [-1, 3] // Displays Select All above and below other choices
+         * ```
+         */
         specialChoicesOrder: {
             selectAllItem: number[];
             noneItem: number[];
@@ -15314,6 +15377,7 @@ declare module "dragdrop/choices" {
     import { QuestionSelectBase } from "question_baseselect";
     import { DragDropCore } from "dragdrop/core";
     export class DragDropChoices extends DragDropCore<QuestionSelectBase> {
+        private imagepickerControlsNode;
         protected get draggedElementType(): string;
         protected createDraggedElementShortcut(text: string, draggedElementNode: HTMLElement, event: PointerEvent): HTMLElement;
         private createImagePickerShortcut;
@@ -16106,7 +16170,9 @@ declare module "question_signaturepad" {
          *
          * Default value: `false`
          *
-         * > The signature area is scaled only for display. The resulting image will have dimensions specified by the [`signatureHeight`](#signatureHeight) and [`signatureWidth`](#signatureWidth) properties.
+         * This property auto-scales the signature area to fill all available width within the question box while maintaining the default 3:2 aspect ratio. If you set [custom width](#signatureWidth) and [height](#signatureHeight) values, the setting will keep the aspect ratio of these dimensions.
+         *
+         * > The signature area is scaled only for display. The image saved in survey results will have dimensions specified by the [`signatureHeight`](#signatureHeight) and [`signatureWidth`](#signatureWidth) properties.
          */
         signatureAutoScaleEnabled: boolean;
         /**
@@ -16898,6 +16964,7 @@ declare module "defaultCss/cssstandard" {
         };
         saveData: {
             root: string;
+            rootWithButtons: string;
             info: string;
             error: string;
             success: string;
@@ -17362,6 +17429,7 @@ declare module "defaultCss/cssmodern" {
         };
         saveData: {
             root: string;
+            rootWithButtons: string;
             info: string;
             error: string;
             success: string;
@@ -23651,11 +23719,13 @@ declare module "react/reactquestion_comment" {
         protected renderElement(): JSX.Element;
     }
     export class SurveyQuestionCommentItem extends ReactSurveyElement {
+        private getStateComment;
+        constructor(props: any);
         protected canRender(): boolean;
         protected onCommentChange(event: any): void;
         protected onCommentInput(event: any): void;
-        protected onCommentCompositionUpdate(event: any): void;
         protected getComment(): string;
+        protected setComment(value: any): void;
         protected getId(): string;
         protected getPlaceholder(): string;
         protected renderElement(): JSX.Element;
@@ -23663,8 +23733,8 @@ declare module "react/reactquestion_comment" {
     export class SurveyQuestionOtherValueItem extends SurveyQuestionCommentItem {
         protected onCommentChange(event: any): void;
         protected onCommentInput(event: any): void;
-        protected onCommentCompositionUpdate(event: any): void;
         protected getComment(): string;
+        protected setComment(value: any): void;
         protected getId(): string;
         protected getPlaceholder(): string;
     }