survey-react 1.9.79 → 1.9.80

package/survey.react.d.ts

@@ -1471,6 +1471,7 @@ declare module "list" {
         onSelectionChanged: (item: T, ...params: any[]) => void;
         allowSelection: boolean;
         private onFilterStringChangedCallback?;
+        elementId?: string;
         private listContainerHtmlElement;
         private loadingIndicatorValue;
         searchEnabled: boolean;
@@ -1492,7 +1493,7 @@ declare module "list" {
         get visibleItems(): Array<T>;
         private get shouldProcessFilter();
         private onFilterStringChanged;
-        constructor(items: Array<IAction>, onSelectionChanged: (item: T, ...params: any[]) => void, allowSelection: boolean, selectedItem?: IAction, onFilterStringChangedCallback?: (text: string) => void);
+        constructor(items: Array<IAction>, onSelectionChanged: (item: T, ...params: any[]) => void, allowSelection: boolean, selectedItem?: IAction, onFilterStringChangedCallback?: (text: string) => void, elementId?: string);
         setItems(items: Array<IAction>, sortByVisibleIndex?: boolean): void;
         protected onSet(): void;
         protected getDefaultCssClasses(): {
@@ -1759,6 +1760,7 @@ declare module "actions/action" {
         ariaChecked?: boolean;
         ariaExpanded?: boolean;
         ariaRole?: string;
+        elementId?: string;
     }
     export interface IActionDropdownPopupOptions extends IListModel, IPopupOptionsBase {
     }
@@ -1829,7 +1831,6 @@ declare module "actions/action" {
         private raiseUpdate;
         constructor(innerItem: IAction);
         private createLocTitle;
-        owner: ILocalizableOwner;
         location?: string;
         id: string;
         private _visible;
@@ -2276,9 +2277,14 @@ declare module "survey-element" {
         protected getIsErrorsModeTooltip(): boolean;
         protected getIsTooltipErrorSupportedByParent(): boolean;
         protected getIsTooltipErrorInsideSupported(): boolean;
-        get hasParent(): boolean;
+        get hasParent(): any;
         isSingleInRow: boolean;
-        protected get hasFrameV2(): boolean;
+        private shouldAddRunnerStyles;
+        protected getHasFrameV2(): boolean;
+        protected getIsNested(): boolean;
+        protected getCssRoot(cssClasses: {
+            [index: string]: string;
+        }): string;
         /**
          * Sets survey element width in CSS values.
          *
@@ -2487,6 +2493,7 @@ declare module "defaultCss/defaultV2Css" {
             edit: string;
         };
         panel: {
+            asPage: string;
             number: string;
             title: string;
             titleExpandable: string;
@@ -2726,6 +2733,7 @@ declare module "defaultCss/defaultV2Css" {
             itemLabelOnError: string;
             item: string;
             itemTitle: string;
+            content: string;
             row: string;
             cell: string;
         };
@@ -2838,6 +2846,7 @@ declare module "defaultCss/defaultV2Css" {
             empty: string;
             root: string;
             tableWrapper: string;
+            content: string;
             cell: string;
             row: string;
             itemCell: string;
@@ -2883,6 +2892,11 @@ declare module "defaultCss/defaultV2Css" {
             itemStarDisabled: string;
             itemStarHighlighted: string;
             itemStarUnhighlighted: string;
+            itemSmiley: string;
+            itemSmileyOnError: string;
+            itemSmileyHover: string;
+            itemSmileySelected: string;
+            itemSmileyDisabled: string;
             minText: string;
             itemText: string;
             maxText: string;
@@ -3681,6 +3695,7 @@ declare module "question_baseselect" {
         protected runItemsEnableCondition(values: HashTable<any>, properties: HashTable<any>): any;
         protected onAfterRunItemsEnableCondition(): void;
         protected onEnableItemCallBack(item: ItemValue): boolean;
+        protected onSelectedItemValuesChangedHandler(newValue: any): void;
         private setConditionalChoicesRunner;
         private setConditionalEnableChoicesRunner;
         private canSurveyChangeItemVisibility;
@@ -3876,7 +3891,7 @@ declare module "question_baseselect" {
         private getFilteredChoices;
         protected get activeChoices(): Array<ItemValue>;
         private getQuestionWithChoices;
-        protected getChoicesFromQuestion(question: QuestionSelectBase): Array<ItemValue>;
+        private getChoicesFromQuestion;
         private copyChoiceItem;
         protected get hasActiveChoices(): boolean;
         protected isHeadChoice(item: ItemValue, question: QuestionSelectBase): boolean;
@@ -5893,9 +5908,13 @@ declare module "survey-events-api" {
     }
     export interface ProcessHtmlEvent {
         /**
-         * an HTML that you may change before text processing and then rendering. specifies the modified HTML content
+         * HTML markup. You can modify this parameter's value.
          */
         html: string;
+        /**
+         * Indicates a page, question, or message for which HTML content is intended: [`"completed"`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#completedHtml) | [`"completed-before"`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#completedBeforeHtml) | [`"loading"`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#loadingHtml) | [`"html-question"`](https://surveyjs.io/form-library/documentation/api-reference/add-custom-html-to-survey#html).
+         */
+        reason: string;
     }
     export interface GetQuestionTitleEvent extends QuestionEventMixin {
         /**
@@ -7130,7 +7149,7 @@ declare module "survey" {
          */
         onValidatedErrorsOnCurrentPage: EventBase<SurveyModel, ValidatedErrorsOnCurrentPageEvent>;
         /**
-         * Use this event to modify the HTML content before rendering, for example `completeHtml` or `loadingHtml`.
+         * An event that is raised when the survey processes HTML content. Handle this event to modify HTML content before displaying.
          * @see completedHtml
          * @see loadingHtml
          * @see QuestionHtmlModel.html
@@ -7501,6 +7520,7 @@ declare module "survey" {
          */
         onGetExpressionDisplayValue: EventBase<SurveyModel, GetExpressionDisplayValueEvent>;
         constructor(jsonObj?: any, renderedElement?: any);
+        protected createTryAgainAction(): IAction;
         private createHtmlLocString;
         /**
          * The list of errors on loading survey JSON. If the list is empty after loading a JSON, then the JSON is correct and has no errors.
@@ -7637,6 +7657,8 @@ declare module "survey" {
          * Gets or sets the visibility of the table of contents.
          *
          * Default value: `false`
+         *
+         * [View Demo](https://surveyjs.io/form-library/examples/toc-feature/ (linkStyle))
          * @see tocLocation
          */
         get showTOC(): boolean;
@@ -7648,6 +7670,8 @@ declare module "survey" {
          *
          * - `"left"` (default)
          * - `"right"`
+         *
+         * [View Demo](https://surveyjs.io/form-library/examples/toc-feature/ (linkStyle))
          * @see showTOC
          */
         get tocLocation(): "left" | "right";
@@ -8512,7 +8536,7 @@ declare module "survey" {
         navigationMouseDown(): boolean;
         private resetNavigationButton;
         private mouseDownPage;
-        nextPageUIClick(): void;
+        nextPageUIClick(): boolean;
         nextPageMouseDown(): boolean;
         /**
          * Shows preview for the survey. Switches the survey to the "preview" state.
@@ -8542,12 +8566,13 @@ declare module "survey" {
         get isSinglePage(): boolean;
         set isSinglePage(val: boolean);
         /**
-         * Gets or sets a value that specifies how the survey combines questions, panels, and pages.
+         * Specifies how to distribute survey elements between pages.
          *
-         * The following options are available:
+         * Possible values:
          *
-         * - `singlePage` - combine all survey pages in a single page. Pages will be converted to panels.
-         * - `questionPerPage` - show one question per page. Survey will create a separate page for every question.
+         * - `"singlePage"` - Combines all survey pages into a single page.
+         * - `"questionPerPage"` - Creates a separate page for every question.
+         * - `"standard"` (default) - Retains the original structure specified in the JSON schema.
          */
         get questionsOnPageMode(): string;
         set questionsOnPageMode(val: string);
@@ -8632,6 +8657,7 @@ declare module "survey" {
          * @see navigateToUrlOnCondition
          */
         doComplete(isCompleteOnTrigger?: boolean): boolean;
+        private saveDataOnComplete;
         private checkOnCompletingEvent;
         /**
          * Starts the survey. Changes the survey mode from "starting" to "running". Call this function if your survey has a start page, otherwise this function does nothing.
@@ -9038,7 +9064,7 @@ declare module "survey" {
         panelRemoved(panel: PanelModel): void;
         validateQuestion(question: Question): SurveyError;
         validatePanel(panel: PanelModel): SurveyError;
-        processHtml(html: string): string;
+        processHtml(html: string, reason?: string): string;
         processText(text: string, returnDisplayValue: boolean): string;
         processTextEx(text: string, returnDisplayValue: boolean, doEncoding: boolean): any;
         private processTextCore;
@@ -9203,6 +9229,27 @@ declare module "survey" {
         skeletonComponentName: string;
         getSkeletonComponentName(element: ISurveyElement): string;
         private layoutElements;
+        /**
+         * Adds an element to the survey layout.
+         *
+         * This method accepts an object with the following layout element properties:
+         *
+         * - `id`: `String` | `"timerpanel"` | `"progress-buttons"` | `"progress-questions"` | `"progress-pages"` | `"progress-correctquestions"` | `"progress-requiredquestions"` | `"toc-navigation"` | `"navigationbuttons"`\
+         * A layout element identifier. You can use possible values to access and relocate or customize predefined layout elements.
+         *
+         * - `container`: `"header"` | `"footer"` | `"left"` | `"right"` | `"contentTop"` | `"contentBottom"`\
+         * A layout container that holds the element. If you want to display the element within multiple containers, set this property to an array of possible values.
+         *
+         * - `component`: `String`\
+         * The name of the component that renders the layout element.
+         *
+         * - `data`: `any`\
+         * Data passed as props to `component`.
+         *
+         * [View Demo](https://surveyjs.io/form-library/examples/progress-bar-with-percentage/ (linkStyle))
+         * @param layoutElement A layout element configuration.
+         * @returns The configuration of the previous layout element with the same `id`.
+         */
         addLayoutElement(layoutElement: ISurveyLayoutElement): ISurveyLayoutElement;
         removeLayoutElement(layoutElementId: string): ISurveyLayoutElement;
         getContainerContent(container: LayoutElementContainer): any[];
@@ -9231,9 +9278,9 @@ declare module "page" {
         protected canShowPageNumber(): boolean;
         protected canShowTitle(): boolean;
         /**
-         * A caption displayed on a navigation button in the progress bar. Applies only when [`showProgressBar`](https://surveyjs.io/form-library/documentation/surveymodel#showProgressBar) is `true` and [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) is `"buttons"`.
+         * A caption displayed on a navigation button in the TOC or progress bar. Applies when [`showTOC`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTOC) is `true` or when [`showProgressBar`](https://surveyjs.io/form-library/documentation/surveymodel#showProgressBar) is `true` and [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) is `"buttons"`.
          *
-         * If this property is undefined, the navigation button displays the page's [`name`](https://surveyjs.io/form-library/documentation/pagemodel#name).
+         * If this property is undefined, the navigation buttons display page [titles](https://surveyjs.io/form-library/documentation/api-reference/page-model#title) or [names](https://surveyjs.io/form-library/documentation/pagemodel#name).
          */
         get navigationTitle(): string;
         set navigationTitle(val: string);
@@ -9849,6 +9896,11 @@ declare module "panel" {
         protected onVisibleChanged(): void;
         needResponsiveWidth(): boolean;
         focusIn(): void;
+        protected getHasFrameV2(): boolean;
+        protected getIsNested(): boolean;
+        protected getCssRoot(cssClasses: {
+            [index: string]: string;
+        }): string;
         getContainerCss(): string;
     }
 }
@@ -10069,7 +10121,6 @@ declare module "question" {
          * You can use question values as placeholders in the following places:
          *
          * - Survey element titles and descriptions
-         * - The [`expression`](https://surveyjs.io/form-library/documentation/questionexpressionmodel#expression) property of the [Expression](https://surveyjs.io/form-library/documentation/questionexpressionmodel) question
          * - The [`html`](https://surveyjs.io/form-library/documentation/questionhtmlmodel#html) property of the [HTML](https://surveyjs.io/form-library/documentation/questionhtmlmodel) question
          *
          * To use a question value as a placeholder, specify the question `name` in curly brackets: `{questionName}`. Refer to the following help topic for more information: [Dynamic Texts - Question Values](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#question-values).
@@ -10279,7 +10330,9 @@ declare module "question" {
         protected calcCssClasses(css: any): any;
         get cssRoot(): string;
         protected setCssRoot(val: string): void;
-        protected getCssRoot(cssClasses: any): string;
+        protected getCssRoot(cssClasses: {
+            [index: string]: string;
+        }): string;
         get cssHeader(): string;
         protected setCssHeader(val: string): void;
         protected getCssHeader(cssClasses: any): string;
@@ -11327,7 +11380,7 @@ declare module "base-interfaces" {
         validatePanel(panel: IPanel): SurveyError;
         hasVisibleQuestionByValueName(valueName: string): boolean;
         questionCountByValueName(valueName: string): number;
-        processHtml(html: string): string;
+        processHtml(html: string, reason: string): string;
         getSurveyMarkdownHtml(element: Base, text: string, name: string): string;
         getRendererForString(element: Base, name: string): string;
         getRendererContextForString(element: Base, locStr: LocalizableString): any;
@@ -12046,6 +12099,8 @@ declare module "validator" {
     }
     /**
      * Use it to validate the text by regular expressions.
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/javascript-form-validation/ (linkStyle))
      */
     export class RegexValidator extends SurveyValidator {
         constructor(regex?: string);
@@ -12181,11 +12236,13 @@ declare module "dropdownListModel" {
         inputString: string;
         showSelectedItemLocText: boolean;
         showInputFieldComponent: boolean;
+        ariaActivedescendant: string;
         private applyInputString;
         private applyHintString;
         get inputStringRendered(): string;
         set inputStringRendered(val: string);
         get placeholderRendered(): any;
+        get listElementId(): string;
         hasScroll: boolean;
         hintString: string;
         private get hintStringLC();
@@ -12209,6 +12266,7 @@ declare module "dropdownListModel" {
         onScroll(event: Event): void;
         onBlur(event: any): void;
         onFocus(event: any): void;
+        setInputStringFromSelectedItem(newValue?: any): void;
         scrollToFocusedItem(): void;
     }
 }
@@ -12225,7 +12283,7 @@ declare module "question_dropdown" {
      * [View Demo](https://surveyjs.io/form-library/examples/questiontype-dropdown/ (linkStyle))
      */
     export class QuestionDropdownModel extends QuestionSelectBase {
-        dropdownListModel: DropdownListModel;
+        dropdownListModelValue: DropdownListModel;
         lastSelectedItemValue: ItemValue;
         updateReadOnlyText(): void;
         constructor(name: string);
@@ -12320,9 +12378,13 @@ declare module "question_dropdown" {
         get showSelectedItemLocText(): boolean;
         get showInputFieldComponent(): boolean;
         private get selectedItemText();
+        get dropdownListModel(): DropdownListModel;
+        set dropdownListModel(val: DropdownListModel);
         get popupModel(): PopupModel;
+        get ariaExpanded(): boolean;
         onOpened: EventBase<QuestionDropdownModel>;
         onOpenedCallBack(): void;
+        protected onSelectedItemValuesChangedHandler(newValue: any): void;
         protected hasUnknownValue(val: any, includeOther: boolean, isFilteredChoices: boolean, checkEmptyValue: boolean): boolean;
         protected onVisibleChoicesChanged(): void;
         protected getFirstInputElementId(): string;
@@ -12686,7 +12748,7 @@ declare module "multiSelectListModel" {
         selectedItems: Array<IAction>;
         hideSelectedItems: boolean;
         private updateItemState;
-        constructor(items: Array<IAction>, onSelectionChanged: (item: T, status: string) => void, allowSelection: boolean, selectedItems?: Array<IAction>, onFilterStringChangedCallback?: (text: string) => void);
+        constructor(items: Array<IAction>, onSelectionChanged: (item: T, status: string) => void, allowSelection: boolean, selectedItems?: Array<IAction>, onFilterStringChangedCallback?: (text: string) => void, elementId?: string);
         onItemClick: (item: T) => void;
         isItemDisabled: (itemValue: T) => boolean;
         isItemSelected: (itemValue: T) => boolean;
@@ -12723,6 +12785,7 @@ declare module "dropdownMultiSelectListModel" {
         removeLastSelectedItem(): void;
         constructor(question: Question, onSelectionChanged?: (item: IAction, ...params: any[]) => void);
         inputKeyHandler(event: any): void;
+        setInputStringFromSelectedItem(newValue: any): void;
     }
 }
 declare module "question_tagbox" {
@@ -12784,6 +12847,7 @@ declare module "question_tagbox" {
         getType(): string;
         get ariaRole(): string;
         get popupModel(): PopupModel;
+        get ariaExpanded(): boolean;
         getControlClass(): string;
         onOpened: EventBase<QuestionTagboxModel>;
         onOpenedCallBack(): void;
@@ -13104,6 +13168,7 @@ declare module "question_html" {
         set html(val: string);
         get locHtml(): LocalizableString;
         get processedHtml(): string;
+        private processHtml;
     }
 }
 declare module "question_radiogroup" {
@@ -13281,12 +13346,15 @@ declare module "question_rating" {
         rateType: "numbers" | "labels" | "stars" | "smileys";
         smileysColorMode: "monochrome" | "colored";
         get isStar(): boolean;
-        get itemComponentName(): "sv-rating-item-star" | "sv-rating-item";
+        get isSmiley(): boolean;
+        get itemComponentName(): "sv-rating-item-star" | "sv-rating-item-smiley" | "sv-rating-item";
         protected valueToData(val: any): any;
         setValueFromClick(value: any): void;
         onItemMouseIn(item: RenderedRatingItem): void;
         onItemMouseOut(item: RenderedRatingItem): void;
         get ratingRootCss(): string;
+        getItemSmiley(item: ItemValue): string;
+        getItemSmileyIconName(item: ItemValue): string;
         getItemClass(item: ItemValue, highlight?: "none" | "highlighted" | "unhighlighted"): string;
         getControlClass(): string;
         get placeholder(): string;
@@ -13786,7 +13854,7 @@ declare module "question_custom" {
          */
         onPropertyChanged?(question: Question, propertyName: string, newValue: any): void;
         /**
-         * A function that is called when the question value is changed.
+         * A function that is called after the question value is changed.
          *
          * Parameters:
          *
@@ -13799,8 +13867,9 @@ declare module "question_custom" {
          */
         onValueChanged?(question: Question, name: string, newValue: any): void;
         /**
-         * A function that is called before a question value is changed. It returns a new value. If you want to change a new value you can return your own value
-         * If function returns undefined the question value will be cleared.
+         * A function that is called before a question value is changed.
+         *
+         * This function should return the value you want to save: `newValue`, a custom value, or `undefined` if you want to clear the question value.
          *
          * Parameters:
          *
@@ -20903,6 +20972,18 @@ declare module "react/components/rating/rating-item-star" {
         render(): JSX.Element | null;
     }
 }
+declare module "react/components/rating/rating-item-smiley" {
+    import { QuestionRatingModel, RenderedRatingItem } from "entries/core";
+    import { SurveyElementBase } from "react/reactquestion_element";
+    import { IRatingItemProps } from "react/components/rating/rating-item";
+    export class RatingItemSmiley extends SurveyElementBase<IRatingItemProps, any> {
+        get question(): QuestionRatingModel;
+        get item(): RenderedRatingItem;
+        get index(): any;
+        getStateElement(): RenderedRatingItem;
+        render(): JSX.Element | null;
+    }
+}
 declare module "react/tagbox-filter" {
     import { DropdownMultiSelectListModel, QuestionTagboxModel } from "entries/core";
     import { SurveyElementBase } from "react/reactquestion_element";
@@ -21597,6 +21678,7 @@ declare module "entries/react-ui-model" {
     export { SurveyQuestionRanking, SurveyQuestionRankingItem, } from "react/reactquestion_ranking";
     export { RatingItem } from "react/components/rating/rating-item";
     export { RatingItemStar } from "react/components/rating/rating-item-star";
+    export { RatingItemSmiley } from "react/components/rating/rating-item-smiley";
     export { TagboxFilterString } from "react/tagbox-filter";
     export { SurveyQuestionOptionItem } from "react/dropdown-item";
     export { SurveyQuestionDropdownBase } from "react/dropdown-base";