survey-react 1.9.85 → 1.9.87

package/survey.react.d.ts

@@ -1,5 +1,12 @@
 /// <reference types="react" />
 declare module "settings" {
+    export type ISurveyEnvironment = {
+        root: Document | ShadowRoot;
+        rootElement: HTMLElement | ShadowRoot;
+        popupMountContainer: HTMLElement | string;
+        svgMountContainer: HTMLElement | string;
+        stylesSheetsMountContainer: HTMLElement;
+    };
     /**
      * Global settings that apply to all surveys on the page. To specify one of the settings, use the code below:
      *
@@ -369,6 +376,10 @@ declare module "settings" {
          * - `"icon"` - Users can only use the choice item icon as a drag handle.
          */
         rankingDragHandleArea: string;
+        /**
+         * Specifies environment in which SurveyJS will exist
+         */
+        environment: ISurveyEnvironment;
         titleTags: {
             survey: string;
             page: string;
@@ -387,6 +398,9 @@ declare module "settings" {
          * - `columnWidthsByType`: `Object`\
          * An object that specifies fixed and minimum column width based on the column type.\
          * Example: `settings.matrix.columnWidthsByType = { "tagbox": { minWidth: "240px", width: "300px" } }`
+         *
+         * - `rateSize`: `"small"` (default) | `"normal"`\
+         * Specifies the size of rate values. Applies to [Rating Scale](https://surveyjs.io/form-library/examples/rating-scale/) questions within matrixes.
          */
         matrix: {
             columnWidthsByType: {
@@ -395,6 +409,7 @@ declare module "settings" {
                     width?: string;
                 };
             };
+            rateSize: "small" | "normal";
         };
     };
 }
@@ -723,6 +738,7 @@ declare module "localizablestring" {
         private getValue;
         private setValue;
         private deleteValue;
+        private getValueLoc;
         private getValuesKeys;
         private get defaultLoc();
     }
@@ -1379,6 +1395,8 @@ declare module "utils/utils" {
     function detectIEOrEdge(): any;
     function loadFileFromBase64(b64Data: string, fileName: string): void;
     function isMobile(): boolean;
+    const isShadowDOM: (rootElement: Document | ShadowRoot | HTMLElement) => rootElement is ShadowRoot;
+    const getElement: (element: HTMLElement | string) => HTMLElement;
     function isElementVisible(element: HTMLElement, threshold?: number): boolean;
     function findScrollableParent(element: HTMLElement): HTMLElement;
     function scrollElementByChildId(id: string): void;
@@ -1408,7 +1426,7 @@ declare module "utils/utils" {
         log(action: string): void;
         get result(): string;
     }
-    export { mergeValues, getElementWidth, isContainerVisible, classesToSelector, compareVersions, confirmAction, detectIEOrEdge, detectIEBrowser, loadFileFromBase64, isMobile, isElementVisible, findScrollableParent, scrollElementByChildId, navigateToUrl, createSvg, getIconNameFromProxy, increaseHeightByContent, getOriginalEvent, preventDefaults, findParentByClassNames, };
+    export { mergeValues, getElementWidth, isContainerVisible, classesToSelector, compareVersions, confirmAction, detectIEOrEdge, detectIEBrowser, loadFileFromBase64, isMobile, isShadowDOM, getElement, isElementVisible, findScrollableParent, scrollElementByChildId, navigateToUrl, createSvg, getIconNameFromProxy, increaseHeightByContent, getOriginalEvent, preventDefaults, findParentByClassNames, };
 }
 declare module "actions/container" {
     import { Base } from "base";
@@ -2447,6 +2465,7 @@ declare module "defaultCss/defaultV2Css" {
             itemStarDisabled: string;
             itemStarHighlighted: string;
             itemStarUnhighlighted: string;
+            itemStarSmall: string;
             itemSmiley: string;
             itemSmileyOnError: string;
             itemSmileyHover: string;
@@ -2455,12 +2474,14 @@ declare module "defaultCss/defaultV2Css" {
             itemSmileyHighlighted: string;
             itemSmileyScaleColored: string;
             itemSmileyRateColored: string;
+            itemSmileySmall: string;
             minText: string;
             itemText: string;
             maxText: string;
             itemDisabled: string;
             itemFixedSize: string;
             control: string;
+            itemSmall: string;
             controlValue: string;
             controlDisabled: string;
             controlEmpty: string;
@@ -2627,6 +2648,10 @@ declare module "defaultCss/defaultV2Css" {
             controlLabel: string;
             filterStringInput: string;
             materialDecorator: string;
+            hint: string;
+            hintPrefix: string;
+            hintSuffix: string;
+            hintSuffixWrapper: string;
         };
     };
     export const defaultV2ThemeName = "defaultV2";
@@ -2641,12 +2666,15 @@ declare module "trigger" {
      * Please note, it runs only one changing the expression result.
      */
     export class Trigger extends Base {
+        static idCounter: number;
         static operatorsValue: HashTable<Function>;
         static get operators(): HashTable<Function>;
         private conditionRunner;
         private usedNames;
         private hasFunction;
+        private idValue;
         constructor();
+        get id(): number;
         getType(): string;
         toString(): string;
         get operator(): string;
@@ -2678,7 +2706,7 @@ declare module "trigger" {
     export interface ISurveyTriggerOwner {
         getObjects(pages: string[], questions: string[]): any[];
         setCompleted(): void;
-        canBeCompleted(): void;
+        canBeCompleted(trigger: Trigger, isCompleted: boolean): void;
         triggerExecuted(trigger: Trigger): void;
         setTriggerValue(name: string, value: any, isVariable: boolean): any;
         copyTriggerValue(name: string, fromName: string): any;
@@ -2719,6 +2747,7 @@ declare module "trigger" {
         getType(): string;
         protected isRealExecution(): boolean;
         protected onSuccess(values: HashTable<any>, properties: HashTable<any>): void;
+        protected onFailure(): void;
     }
     /**
      * If expression returns true, the value from property **setValue** will be set to **setToName**
@@ -2834,9 +2863,9 @@ declare module "questionfactory" {
         static get DefaultColums(): string[];
         static get DefaultRows(): string[];
         static get DefaultMutlipleTextItems(): string[];
-        private creatorHash;
         registerQuestion(questionType: string, questionCreator: (name: string) => Question): void;
-        unregisterElement(elementType: string): void;
+        registerCustomQuestion(questionType: string): void;
+        unregisterElement(elementType: string, removeFromSerializer?: boolean): void;
         clear(): void;
         getAllTypes(): Array<string>;
         createQuestion(questionType: string, name: string): Question;
@@ -2845,6 +2874,7 @@ declare module "questionfactory" {
         static Instance: ElementFactory;
         private creatorHash;
         registerElement(elementType: string, elementCreator: (name: string) => IElement): void;
+        registerCustomQuestion: (questionType: string) => void;
         clear(): void;
         unregisterElement(elementType: string, removeFromSerializer?: boolean): void;
         getAllTypes(): Array<string>;
@@ -3464,6 +3494,7 @@ declare module "panel" {
         cancelPreview(): void;
         get cssTitle(): string;
         get cssError(): string;
+        get showErrorsAbovePanel(): boolean;
         protected getCssError(cssClasses: any): string;
         protected onVisibleChanged(): void;
         needResponsiveWidth(): boolean;
@@ -3844,6 +3875,7 @@ declare module "question_baseselect" {
         private newItemValue;
         private canShowOptionItemCallback;
         private isUsingCarrayForward;
+        private waitingGetChoiceDisplayValueResponse;
         protected selectedItemValues: any;
         constructor(name: string);
         getType(): string;
@@ -3966,6 +3998,8 @@ declare module "question_baseselect" {
         protected rendredValueToDataCore(val: any): any;
         protected needConvertRenderedOtherToDataValue(): boolean;
         protected updateSelectedItemValues(): void;
+        protected updateSingleSelectedItemValues(): void;
+        protected updateMultipleSelectedItemValues(): void;
         protected resetSelectedItemValues(): void;
         protected hasUnknownValue(val: any, includeOther?: boolean, isFilteredChoices?: boolean, checkEmptyValue?: boolean): boolean;
         protected isValueDisabled(val: any): boolean;
@@ -7665,23 +7699,33 @@ declare module "survey" {
          */
         onProcessTextValue: EventBase<SurveyModel, ProcessTextValueEvent>;
         /**
-         * An event that is raised before rendering a question. Use it to override the default question CSS classes.
+         * An event that is raised before rendering a question. Use it to override default question CSS classes.
          *
          * For information on event handler parameters, refer to descriptions within the interface.
          *
-         * [View Demo](https://surveyjs.io/form-library/examples/survey-cssclasses/ (linkStyle))
+         * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
+         * @see css
          */
         onUpdateQuestionCssClasses: EventBase<SurveyModel, UpdateQuestionCssClassesEvent>;
         /**
-         * An event that is raised before rendering a panel. Use it to override the default panel CSS classes.
+         * An event that is raised before rendering a panel. Use it to override default panel CSS classes.
+         *
+         * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
+         * @see css
          */
         onUpdatePanelCssClasses: EventBase<SurveyModel, UpdatePanelCssClassesEvent>;
         /**
-         * An event that is raised before rendering a page. Use it to override the default page CSS classes.
+         * An event that is raised before rendering a page. Use it to override default page CSS classes.
+         *
+         * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
+         * @see css
          */
         onUpdatePageCssClasses: EventBase<SurveyModel, UpdatePageCssClassesEvent>;
         /**
-         * An event that is raised before rendering a choice item in radiogroup, checkbox or dropdown questions. Use it to override the default choice item css.
+         * An event that is raised before rendering a choice item in Radio Button Group, Checkboxes, and Dropdown questions. Use it to override default CSS classes applied to choice items.
+         *
+         * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
+         * @see css
          */
         onUpdateChoiceItemCss: EventBase<SurveyModel, UpdateChoiceItemCssEvent>;
         /**
@@ -7952,6 +7996,11 @@ declare module "survey" {
         private cssValue;
         private updateCompletedPageCss;
         private updateCss;
+        /**
+         * Gets or sets an object in which keys are UI elements and values are CSS classes applied to them.
+         *
+         * [View Demo](/form-library/examples/customize-survey-with-css/ (linkStyle))
+         */
         get css(): any;
         set css(value: any);
         setCss(value: any, needMerge?: boolean): void;
@@ -8360,6 +8409,7 @@ declare module "survey" {
         get locBackgroundImage(): LocalizableString;
         renderBackgroundImage: string;
         private updateRenderBackgroundImage;
+        backgroundImageFit: string;
         /**
          * A value from 0 to 1 that specifies how transparent the survey background should be: 0 makes the background completely transparent, and 1 makes it opaque.
          * @see backgroundImage
@@ -8863,7 +8913,7 @@ declare module "survey" {
         get areInvisibleElementsShowing(): boolean;
         get areEmptyElementsHidden(): boolean;
         /**
-         * Returns `true`, if a user has already completed the survey in this browser and there is a cookie about it. Survey goes to `completed` state if the function returns `true`.
+         * Returns `true`, if a user has already completed the survey in this browser and there is a cookie about it. Survey goes to `completedbefore` state if the function returns `true`.
          * @see cookieName
          * @see setCookie
          * @see deleteCookie
@@ -9113,7 +9163,9 @@ declare module "survey" {
         private completeServerValidation;
         protected doNextPage(): void;
         setCompleted(): void;
-        canBeCompleted(): void;
+        canBeCompleted(trigger: Trigger, isCompleted: boolean): void;
+        private completedByTriggers;
+        private get canBeCompletedByTrigger();
         /**
          * Returns the HTML content for the complete page.
          * @see completedHtml
@@ -9923,11 +9975,13 @@ declare module "survey-element" {
          *
          * Use the following events of the [`SurveyModel`](https://surveyjs.io/form-library/documentation/surveymodel) object to override CSS classes:
          *
-         * - [`onUpdatePageCssClasses`](https://surveyjs.io/form-library/documentation/surveymodel#onUpdatePageCssClasses)
-         * - [`onUpdatePanelCssClasses`](https://surveyjs.io/form-library/documentation/surveymodel#onUpdatePanelCssClasses)
          * - [`onUpdateQuestionCssClasses`](https://surveyjs.io/form-library/documentation/surveymodel#onUpdateQuestionCssClasses)
+         * - [`onUpdatePanelCssClasses`](https://surveyjs.io/form-library/documentation/surveymodel#onUpdatePanelCssClasses)
+         * - [`onUpdatePageCssClasses`](https://surveyjs.io/form-library/documentation/surveymodel#onUpdatePageCssClasses)
+         * - [`onUpdateChoiceItemCss`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onUpdateChoiceItemCss)
          */
         get cssClasses(): any;
+        get cssTitleNumber(): any;
         protected calcCssClasses(css: any): any;
         protected updateElementCssCore(cssClasses: any): void;
         get cssError(): string;
@@ -10219,6 +10273,7 @@ declare module "question" {
         isReadOnlyRenderDiv(): boolean;
         protected setIsMobile(val: boolean): void;
         isMobile: boolean;
+        forceIsInputReadOnly: boolean;
         constructor(name: string);
         protected createLocTitleProperty(): LocalizableString;
         getSurvey(live?: boolean): ISurvey;
@@ -10859,6 +10914,7 @@ declare module "question" {
         getComponentName(): string;
         isDefaultRendering(): boolean;
         renderAs: string;
+        inMatrixMode: boolean;
         getErrorCustomText(text: string, error: SurveyError): string;
         getValidatorTitle(): string;
         get validatedValue(): any;
@@ -11742,6 +11798,13 @@ declare module "base-interfaces" {
         element: Base;
         str: LocalizableString;
     }
+    export type ISurveyEnvironment = {
+        root: Document | ShadowRoot;
+        rootElement: HTMLElement | ShadowRoot;
+        popupMountContainer: HTMLElement | string;
+        svgMountContainer: HTMLElement | string;
+        stylesSheetsMountContainer: HTMLElement;
+    };
     export type LayoutElementContainer = "header" | "footer" | "left" | "right" | "contentTop" | "contentBottom";
     export interface ISurveyLayoutElement {
         id: string;
@@ -11923,7 +11986,8 @@ declare module "dropdownListModel" {
         showInputFieldComponent: boolean;
         ariaActivedescendant: string;
         private applyInputString;
-        private applyHintString;
+        protected fixInputCase(): void;
+        protected applyHintString(item: ItemValue): void;
         get inputStringRendered(): string;
         set inputStringRendered(val: string);
         get placeholderRendered(): any;
@@ -11936,6 +12000,7 @@ declare module "dropdownListModel" {
         get hintStringPrefix(): string;
         get showHintString(): boolean;
         get hintStringSuffix(): string;
+        get hintStringMiddle(): string;
         constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any[]) => void);
         get popupModel(): PopupModel;
         get inputReadOnly(): boolean;
@@ -11944,10 +12009,14 @@ declare module "dropdownListModel" {
         setSearchEnabled(newValue: boolean): void;
         updateItems(): void;
         onClick(event: any): void;
+        protected focusItemOnClickAndPopup(): void;
         onClear(event: any): void;
         getSelectedAction(): ItemValue;
         changeSelectionWithKeyboard(reverse: boolean): void;
+        protected beforeScrollToFocusedItem(focusedItem: ItemValue): void;
+        protected afterScrollToFocusedItem(): void;
         keyHandler(event: any): void;
+        protected onEscape(): void;
         onScroll(event: Event): void;
         onBlur(event: any): void;
         onFocus(event: any): void;
@@ -11974,9 +12043,9 @@ declare module "question_rating" {
         constructor(itemValue: ItemValue, locString?: LocalizableString);
     }
     /**
-     * A Model for a rating question.
+     * A class that describes the Rating Scale question type.
      *
-     * [View Demo](https://surveyjs.io/form-library/examples/questiontype-rating/ (linkStyle))
+     * [View Demo](https://surveyjs.io/form-library/examples/rating-scale/ (linkStyle))
      */
     export class QuestionRatingModel extends Question {
         constructor(name: string);
@@ -12012,6 +12081,8 @@ declare module "question_rating" {
          * If you need to specify only the `value` property, you can set the `rateValues` property to an array of numbers, for example, `[ 3, 6, 10 ]`. These values are both saved in survey results and used as display text.
          *
          * If you do not specify the `rateValues` property, rate values are generated automatically based upon the [`rateMin`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMin), [`rateMax`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMax), [`rateStep`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateStep), and [`rateCount`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateCount) property values.
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
          */
         get rateValues(): Array<any>;
         set rateValues(val: Array<any>);
@@ -12019,6 +12090,8 @@ declare module "question_rating" {
          * Specifies the first rate value in the generated sequence of rate values. Applies if the [`rateValues`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateValues) array is empty.
          *
          * Default value: 1
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
          * @see rateMax
          * @see rateStep
          * @see rateCount
@@ -12029,6 +12102,8 @@ declare module "question_rating" {
          * Specifies the last rate value in the generated sequence of rate values. Applies if the [`rateValues`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateValues) array is empty.
          *
          * Default value: 5
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
          * @see rateMin
          * @see rateStep
          * @see rateCount
@@ -12039,6 +12114,8 @@ declare module "question_rating" {
          * Specifies a step with which to generate rate values. Applies if the [`rateValues`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateValues) array is empty.
          *
          * Default value: 1
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
          * @see rateMin
          * @see rateMax
          * @see rateCount
@@ -12049,6 +12126,8 @@ declare module "question_rating" {
          * Specifies the number of rate values you want to generate. Applies if the [`rateValues`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateValues) array is empty.
          *
          * Set the [`rateMin`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMin) or [`rateMax`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateMax) property to specify the first or the last rate value. Use the [`rateStep`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateStep) property to specify a step with which to generate rate values.
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
          */
         rateCount: number;
         private static badColor;
@@ -12107,19 +12186,56 @@ declare module "question_rating" {
         */
         displayRateDescriptionsAsExtremeItems: boolean;
         /**
-        * Specifies how a Rating question displays rate values.
+        * Specifies whether to display rate values as buttons or items in a drop-down list.
         *
         * Possible values:
         *
         * - `"buttons"` - Displays rate values as buttons in a row.
         * - `"dropdown"` - Displays rate values as items in a drop-down list.
         * - `"auto"` (default) - Selects between the `"buttons"` and `"dropdown"` modes based on the available width. When the width is insufficient to display buttons, the question displays a dropdown.
+        *
+        * [View Demo](/form-library/examples/ui-adaptation-modes-for-rating-scale/ (linkStyle))
+        * @see rateType
         */
         displayMode: "dropdown" | "buttons" | "auto";
-        rateDisplayMode: "labels" | "stars" | "smileys";
-        get rateType(): "labels" | "stars" | "smileys";
-        set rateType(val: "labels" | "stars" | "smileys");
+        /**
+         * Specifies the visual representation of rate values.
+         *
+         * Possible values:
+         *
+         * - `"labels"` (default) - Displays rate values as buttons with labels.
+         * - `"stars"` - Displays rate values as stars.
+         * - `"smileys"` - Displays rate values as smiley faces.
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
+         * @see scaleColorMode
+         * @see rateColorMode
+         * @see displayMode
+         */
+        rateType: "labels" | "stars" | "smileys";
+        get rateDisplayMode(): "labels" | "stars" | "smileys";
+        set rateDisplayMode(val: "labels" | "stars" | "smileys");
+        /**
+         * Specifies how to colorize the smiley face rating scale. Applies only if [`rateType`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateType) is `"smileys"`.
+         *
+         * Possible values:
+         *
+         * - `"monochrome"` (default) - Displays emojis in monochrome.
+         * - `"colored"` - Displays emojis in color.
+         *
+         * [View Demo](/form-library/examples/rating-scale/ (linkStyle))
+         * @see rateColorMode
+         */
         scaleColorMode: "monochrome" | "colored";
+        /**
+         * Specifies how to colorize the selected emoji. Applies only if [`rateType`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model#rateType) is `"smileys"`.
+         *
+         * Possible values:
+         *
+         * - `"default"` - Displays the selected emoji in default survey color.
+         * - `"scale"` (default) - Inherits the color from the scale.
+         * @see scaleColorMode
+         */
         rateColorMode: "default" | "scale";
         get isStar(): boolean;
         get isSmiley(): boolean;
@@ -12128,7 +12244,10 @@ declare module "question_rating" {
         setValueFromClick(value: any): void;
         onItemMouseIn(item: RenderedRatingItem): void;
         onItemMouseOut(item: RenderedRatingItem): void;
+        get itemSmallMode(): boolean;
         get ratingRootCss(): string;
+        get itemStarIcon(): string;
+        get itemStarIconAlt(): string;
         getItemSmiley(item: ItemValue): string;
         getItemSmileyIconName(item: ItemValue): string;
         getItemClassByText(item: ItemValue, text: string): string;
@@ -13153,6 +13272,10 @@ declare module "dropdownMultiSelectListModel" {
         constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any[]) => void);
         inputKeyHandler(event: any): void;
         setInputStringFromSelectedItem(newValue: any): void;
+        protected focusItemOnClickAndPopup(): void;
+        protected onEscape(): void;
+        protected beforeScrollToFocusedItem(focusedItem: ItemValue): void;
+        protected afterScrollToFocusedItem(): void;
     }
 }
 declare module "question_tagbox" {
@@ -14482,7 +14605,7 @@ declare module "dragdrop/survey-elements" {
 declare module "entries/chunks/model" {
     export var Version: string;
     export function checkLibraryVersion(ver: string, libraryName: string): void;
-    export { settings } from "settings";
+    export { settings, ISurveyEnvironment } from "settings";
     export { Helpers, HashTable } from "helpers";
     export { AnswerCountValidator, EmailValidator, NumericValidator, RegexValidator, SurveyValidator, TextValidator, ValidatorResult, ExpressionValidator, ValidatorRunner } from "validator";
     export { ItemValue } from "itemvalue";
@@ -14948,6 +15071,10 @@ declare module "defaultCss/cssstandard" {
             controlEmpty: string;
             placeholderInput: string;
             filterStringInput: string;
+            hint: string;
+            hintPrefix: string;
+            hintSuffix: string;
+            hintSuffixWrapper: string;
         };
     };
 }
@@ -15414,7 +15541,7 @@ declare module "entries/core-wo-model" {
     export * from "svgbundle";
     export * from "rendererFactory";
     export * from "utils/responsivity-manager";
-    export { unwrap, getOriginalEvent } from "utils/utils";
+    export { unwrap, getOriginalEvent, getElement } from "utils/utils";
     export * from "actions/action";
     export * from "actions/adaptive-container";
     export * from "actions/container";