survey-react 1.9.86 → 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";
         };
     };
 }
@@ -1380,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;
@@ -1409,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";
@@ -2448,6 +2465,7 @@ declare module "defaultCss/defaultV2Css" {
             itemStarDisabled: string;
             itemStarHighlighted: string;
             itemStarUnhighlighted: string;
+            itemStarSmall: string;
             itemSmiley: string;
             itemSmileyOnError: string;
             itemSmileyHover: string;
@@ -2456,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;
@@ -2628,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";
@@ -2642,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;
@@ -2679,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;
@@ -2720,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**
@@ -3847,6 +3875,7 @@ declare module "question_baseselect" {
         private newItemValue;
         private canShowOptionItemCallback;
         private isUsingCarrayForward;
+        private waitingGetChoiceDisplayValueResponse;
         protected selectedItemValues: any;
         constructor(name: string);
         getType(): string;
@@ -7670,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>;
         /**
@@ -7957,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;
@@ -8869,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
@@ -9119,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
@@ -9929,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;
@@ -10225,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;
@@ -10865,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;
@@ -11748,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;
@@ -11929,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;
@@ -11942,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;
@@ -11950,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;
@@ -11980,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);
@@ -12181,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;
@@ -13206,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" {
@@ -14535,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";
@@ -15001,6 +15071,10 @@ declare module "defaultCss/cssstandard" {
             controlEmpty: string;
             placeholderInput: string;
             filterStringInput: string;
+            hint: string;
+            hintPrefix: string;
+            hintSuffix: string;
+            hintSuffixWrapper: string;
         };
     };
 }
@@ -15467,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";