survey-react 1.9.72 → 1.9.75

package/survey.react.d.ts

@@ -82,6 +82,10 @@ declare module "settings" {
          * Maximum rowCount that returns in addConditionObjectsByContext function
          */
         matrixMaxRowCountInCondition: number;
+        /**
+         * Maximum panelCount that returns in addConditionObjectsByContext function
+         */
+        panelDynamicMaxPanelCountInCondition: number;
         /**
          * Set this property to false, to render matrix dynamic remove action as button.
          * It is rendered as icon in new themes ("defaultV2") by default.
@@ -215,7 +219,7 @@ declare module "settings" {
          */
         customIcons: {};
         /**
-         * Specifies which part of a choice item item responds to a drag gesture in Ranking questions.
+         * Specifies which part of a choice item responds to a drag gesture in Ranking questions.
          *
          * Possible values:
          *
@@ -256,6 +260,7 @@ declare module "helpers" {
         static getNumber(value: any): number;
         private static prepareStringToNumber;
         static getMaxLength(maxLength: number, surveyLength: number): any;
+        static getRemainingCharacterCounterText(newValue: string | undefined, maxLength: number | null): string;
         static getNumberByIndex(index: number, startIndexStr: string): string;
         static isCharNotLetterAndDigit(ch: string): boolean;
         static isCharDigit(ch: string): boolean;
@@ -644,6 +649,7 @@ declare module "jsonobject" {
         classNamePart: string;
         baseClassName: string;
         defaultValueValue: any;
+        defaultValueFunc: () => any;
         serializationProperty: string;
         displayName: string;
         category: string;
@@ -1113,7 +1119,7 @@ declare module "conditions" {
         /**
          * The expression as string, property with get
          */
-        get expression(): string;
+        expression: string;
         /**
          * Returns true if the expression is valid and can be executed
          */
@@ -2423,6 +2429,7 @@ declare module "defaultCss/defaultV2Css" {
             titleRequired: string;
             indent: number;
             footer: string;
+            commentArea: string;
             formGroup: string;
             hasError: string;
             collapsed: string;
@@ -2537,6 +2544,8 @@ declare module "defaultCss/defaultV2Css" {
             root: string;
             small: string;
             controlDisabled: string;
+            content: string;
+            remainingCharacterCounter: string;
             onError: string;
         };
         multipletext: {
@@ -2709,6 +2718,8 @@ declare module "defaultCss/defaultV2Css" {
             root: string;
             small: string;
             controlDisabled: string;
+            content: string;
+            remainingCharacterCounter: string;
             onError: string;
         };
         expression: string;
@@ -2788,6 +2799,7 @@ declare module "defaultCss/defaultV2Css" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -3100,7 +3112,6 @@ declare module "stylesmanager" {
     };
     export class StylesManager {
         private static SurveyJSStylesSheetId;
-        private sheet;
         static Logger: Logger;
         static Styles: {
             [key: string]: string;
@@ -3132,7 +3143,7 @@ declare module "stylesmanager" {
         static applyTheme(themeName?: string, themeSelector?: string): void;
         static Enabled: boolean;
         constructor();
-        initializeStyles(sheet: CSSStyleSheet): any;
+        static insertStylesRulesIntoDocument(): any;
     }
 }
 declare module "surveytimer" {
@@ -3793,6 +3804,7 @@ declare module "question_baseselect" {
          */
         get colCount(): number;
         set colCount(value: number);
+        clickItemHandler(item: ItemValue, checked: boolean): void;
         protected onParentChanged(): void;
         protected onParentQuestionChanged(): void;
         protected getSearchableItemValueKeys(keys: Array<string>): void;
@@ -4934,6 +4946,19 @@ declare module "survey" {
          * @see QuestionHtmlModel.html
          */
         onProcessHtml: EventBase<SurveyModel>;
+        /**
+         * Use this event to change a question's display text.
+         *
+         * Parameters:
+         *
+         * - `sender`: `SurveyModel`\
+         * A survey instance that raised the event.
+         * - `options.question`: [`Question`](https://surveyjs.io/form-library/documentation/api-reference/question)\
+         * A Question instance for which the event is raised.
+         * - `options.displayValue`: `String`\
+         * A question's display text. You can assign a custom value to this parameter.
+         */
+        onGetQuestionDisplayValue: EventBase<SurveyModel>;
         /**
          * Use this event to change the question title in code. If you want to remove question numbering then set showQuestionNumbers to "off".
          * - `sender`: `SurveyModel` - A survey instance that raised the event.
@@ -5905,6 +5930,7 @@ declare module "survey" {
         getLocString(str: string): string;
         getErrorCustomText(text: string, error: SurveyError): string;
         getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
+        getQuestionDisplayValue(question: IElement, displayValue: any): any;
         /**
          * Returns the text displayed when a survey has no visible pages and questions.
          */
@@ -6106,7 +6132,7 @@ declare module "survey" {
          *
          * [View Demo](https://surveyjs.io/form-library/examples/survey-options/ (linkStyle))
          */
-        get showQuestionNumbers(): string;
+        get showQuestionNumbers(): string | boolean;
         set showQuestionNumbers(value: string | boolean);
         /**
          * Gets or sets the survey progress bar position.
@@ -7883,7 +7909,7 @@ declare module "panel" {
         protected getCssError(cssClasses: any): string;
         protected onVisibleChanged(): void;
         needResponsiveWidth(): boolean;
-        focusIn: () => void;
+        focusIn(): void;
         getContainerCss(): string;
     }
 }
@@ -8035,6 +8061,7 @@ declare module "question" {
         afterRenderQuestionCallback: (question: Question, element: any) => any;
         valueFromDataCallback: (val: any) => any;
         valueToDataCallback: (val: any) => any;
+        onUpdateCssClassesCallback: (css: any) => void;
         onGetSurvey: () => ISurvey;
         private locProcessedTitle;
         protected isReadyValue: boolean;
@@ -8353,7 +8380,7 @@ declare module "question" {
          */
         focus(onError?: boolean): void;
         private expandAllParents;
-        focusIn: () => void;
+        focusIn(): void;
         protected fireCallback(callback: () => void): void;
         getOthersMaxLength(): any;
         protected onCreating(): void;
@@ -8590,6 +8617,7 @@ declare module "question" {
          */
         get comment(): string;
         set comment(newValue: string);
+        getCommentAreaCss(isOther?: boolean): string;
         protected getQuestionComment(): string;
         protected setQuestionComment(newValue: string): void;
         /**
@@ -10145,6 +10173,7 @@ declare module "base-interfaces" {
         requiredText: string;
         beforeSettingQuestionErrors(question: IQuestion, errors: Array<SurveyError>): void;
         beforeSettingPanelErrors(question: IPanel, errors: Array<SurveyError>): void;
+        getQuestionDisplayValue(question: IElement, displayValue: any): any;
         getSurveyErrorCustomText(obj: Base, text: string, error: SurveyError): string;
         getElementTitleTagName(element: Base, tagName: string): string;
         questionTitlePattern: string;
@@ -10246,8 +10275,8 @@ declare module "base-interfaces" {
         toggleState(): void;
         stateChangedCallback(): void;
         getTitleToolbar(): AdaptiveActionContainer;
-        get isCollapsed(): boolean;
-        get isExpanded(): boolean;
+        isCollapsed: boolean;
+        isExpanded: boolean;
         expand(): void;
         collapse(): void;
     }
@@ -10522,7 +10551,7 @@ declare module "base" {
          * The name of the property to which an array of `ItemValue` objects is assigned (for example, `"choices"` or `"rows"`).
          * - `options.name`: `"text"` | `"value"`\
          * The name of the changed property.
-         * - `options.newValue: `any`\
+         * - `options.newValue`: `any`\
          * A new value for the property.
          */
         onItemValuePropertyChanged: Event<(sender: Base, options: any) => any, Base, any>;
@@ -11231,6 +11260,11 @@ declare module "question_matrix" {
 declare module "question_textbase" {
     import { Question } from "question";
     import { LocalizableString } from "localizablestring";
+    import { Base } from "base";
+    export class CharacterCounter extends Base {
+        remainingCharacterCounter: string;
+        updateRemainingCharacterCounter(newValue: string, maxLength: number): void;
+    }
     /**
      * A base class for the [Text](https://surveyjs.io/form-library/documentation/questiontextmodel) and [Comment](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types.
      */
@@ -11245,6 +11279,8 @@ declare module "question_textbase" {
         get maxLength(): number;
         set maxLength(val: number);
         getMaxLength(): any;
+        characterCounter: CharacterCounter;
+        updateRemainingCharacterCounter(newValue: string): void;
         /**
          * A placeholder for the input field.
          */
@@ -11275,6 +11311,7 @@ declare module "question_textbase" {
         localeChanged(): void;
         protected calcRenderedPlaceholder(): void;
         protected hasPlaceHolder(): boolean;
+        protected setNewValue(newValue: any): void;
         getControlClass(): string;
         get ariaRole(): string;
     }
@@ -11426,6 +11463,11 @@ declare module "question_multipletext" {
         getItemDefaultValue(name: string): any;
         getIsRequiredText(): string;
     }
+    /**
+     * A class that describes an item in a [Multiple Text](https://surveyjs.io/form-library/documentation/api-reference/multiple-text-entry-question-model) question.
+     *
+     * [View Demo](/form-library/examples/multiple-text-box-question/)
+     */
     export class MultipleTextItemModel extends Base implements IValidatorOwner, ISurveyData, ISurveyImpl {
         private editorValue;
         private data;
@@ -11850,6 +11892,7 @@ declare module "dropdownMultiSelectListModel" {
     import { MultiSelectListModel } from "multiSelectListModel";
     import { Question } from "question";
     export class DropdownMultiSelectListModel extends DropdownListModel {
+        protected popupCssClasses: string;
         filterStringPlaceholder: string;
         closeOnSelect: boolean;
         private updateListState;
@@ -12109,7 +12152,6 @@ declare module "question_ranking" {
     import { DragDropRankingChoices } from "dragdrop/ranking-choices";
     import { ItemValue } from "itemvalue";
     import { QuestionCheckboxModel } from "question_checkbox";
-    import { QuestionSelectBase } from "question_baseselect";
     /**
      * A class that describes the Ranking question type.
      *
@@ -12125,6 +12167,7 @@ declare module "question_ranking" {
         protected getItemClassCore(item: ItemValue, options: any): string;
         protected isItemCurrentDropTarget(item: ItemValue): boolean;
         get ghostPositionCssClass(): string;
+        getItemIndexClasses(): string;
         getNumberByIndex(index: number): string;
         setSurveyImpl(value: ISurveyImpl, isLight?: boolean): void;
         isAnswerCorrect(): boolean;
@@ -12152,10 +12195,6 @@ declare module "question_ranking" {
         private handleArrowDown;
         private focusItem;
         setValue: () => void;
-        protected getChoicesFromQuestion(question: QuestionSelectBase): Array<ItemValue>;
-        private setValueFromUI;
-        private syncNumbers;
-        private setGhostText;
         getIconHoverCss(): string;
         getIconFocusCss(): string;
         /**
@@ -12445,6 +12484,7 @@ declare module "question_radiogroup" {
         get clearButtonCaption(): string;
         supportGoNextPageAutomatic(): boolean;
         get showClearButtonInContent(): boolean;
+        clickItemHandler(item: ItemValue): void;
         protected getDefaultTitleActions(): Array<Action>;
     }
 }
@@ -12593,7 +12633,7 @@ declare module "question_rating" {
         get locPlaceholder(): LocalizableString;
         get allowClear(): boolean;
         get searchEnabled(): boolean;
-        get renderedValue(): boolean;
+        get renderedValue(): any;
         set renderedValue(val: any);
         isItemSelected(item: ItemValue): boolean;
         get visibleChoices(): ItemValue[];
@@ -12612,6 +12652,7 @@ declare module "question_rating" {
 declare module "question_boolean" {
     import { Question } from "question";
     import { LocalizableString } from "localizablestring";
+    import { ActionContainer } from "actions/container";
     /**
      * A class that describes the Boolean question type.
      *
@@ -12703,6 +12744,7 @@ declare module "question_boolean" {
         getRadioItemClass(css: any, value: any): string;
         protected supportResponsiveness(): boolean;
         protected getCompactRenderAs(): string;
+        protected createActionContainer(allowAdaptiveActions?: boolean): ActionContainer;
     }
 }
 declare module "question_image" {
@@ -13045,6 +13087,19 @@ declare module "question_custom" {
          * An HTML element that represents a nested question.
          */
         onAfterRenderContentElement?(question: Question, element: 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) requires an update of its CSS classes.
+         *
+         * Parameters:
+         *
+         * - `question`: [Question](https://surveyjs.io/Documentation/Library?id=Question)\
+         * A composite question.
+         * - `element`: [Question](https://surveyjs.io/Documentation/Library?id=Question)\
+         * A nested question.
+         * - `cssClasses`: `any`\
+         * An object with CSS classes applied to a nested question, for example, `{ root: "class1", button: "class2" }`. You can modify this object to apply custom CSS classes.
+         */
+        onUpdateQuestionCssClasses?(question: Question, element: Question, cssClasses: any): void;
         /**
          * A function that is called when a custom question type property is changed. Use it to handle property changes.
          *
@@ -13129,6 +13184,7 @@ declare module "question_custom" {
         onLoaded(question: Question): void;
         onAfterRender(question: Question, htmlElement: any): void;
         onAfterRenderContentElement(question: Question, element: Question, htmlElement: any): void;
+        onUpdateQuestionCssClasses(question: Question, element: Question, css: any): void;
         onPropertyChanged(question: Question, propertyName: string, newValue: any): void;
         onValueChanged(question: Question, name: string, newValue: any): void;
         onItemValuePropertyChanged(question: Question, item: ItemValue, propertyName: string, name: string, newValue: any): void;
@@ -13165,6 +13221,7 @@ declare module "question_custom" {
         onSurveyLoad(): void;
         afterRenderQuestionElement(el: HTMLElement): void;
         afterRender(el: any): void;
+        protected onUpdateQuestionCssClasses(element: Question, css: any): void;
         protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
         protected setNewValue(newValue: any): void;
         getSurveyData(): ISurveyData;
@@ -13505,7 +13562,7 @@ declare module "entries/chunks/model" {
     export { QuestionRadiogroupModel } from "question_radiogroup";
     export { QuestionRatingModel, RenderedRatingItem } from "question_rating";
     export { QuestionExpressionModel } from "question_expression";
-    export { QuestionTextBase } from "question_textbase";
+    export { QuestionTextBase, CharacterCounter } from "question_textbase";
     export { QuestionTextModel } from "question_text";
     export { QuestionBooleanModel } from "question_boolean";
     export { QuestionImagePickerModel, ImageItemValue } from "question_imagepicker";
@@ -13684,6 +13741,7 @@ declare module "defaultCss/cssstandard" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -13693,7 +13751,9 @@ declare module "defaultCss/cssstandard" {
             itemGhostMod: string;
             itemDragMod: string;
         };
-        comment: string;
+        comment: {
+            remainingCharacterCounter: string;
+        };
         dropdown: {
             root: string;
             popup: string;
@@ -13840,7 +13900,10 @@ declare module "defaultCss/cssstandard" {
             itemText: string;
             maxText: string;
         };
-        text: string;
+        text: {
+            root: string;
+            remainingCharacterCounter: string;
+        };
         expression: string;
         file: {
             root: string;
@@ -14063,6 +14126,7 @@ declare module "defaultCss/cssmodern" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -14131,6 +14195,7 @@ declare module "defaultCss/cssmodern" {
         text: {
             root: string;
             small: string;
+            remainingCharacterCounter: string;
             onError: string;
         };
         multipletext: {
@@ -14269,6 +14334,7 @@ declare module "defaultCss/cssmodern" {
         comment: {
             root: string;
             small: string;
+            remainingCharacterCounter: string;
         };
         expression: string;
         file: {
@@ -14501,6 +14567,7 @@ declare module "plugins/themes/bootstrap/cssbootstrap" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -14845,6 +14912,7 @@ declare module "plugins/themes/bootstrapmaterial/cssbootstrapmaterial" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -15305,6 +15373,7 @@ declare module "entries/plugins" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -15647,6 +15716,7 @@ declare module "entries/plugins" {
             item: string;
             itemContent: string;
             itemIndex: string;
+            itemIndexEmptyMode: string;
             controlLabel: string;
             itemGhostNode: string;
             itemIconContainer: string;
@@ -19471,6 +19541,18 @@ declare module "react/reactquestion_factory" {
         createQuestion(questionType: string, params: any): JSX.Element | null;
     }
 }
+declare module "react/components/character-counter" {
+    import { Base, CharacterCounter } from "entries/core";
+    import { SurveyElementBase } from "react/reactquestion_element";
+    export interface ICharacterCounterComponentProps {
+        counter: CharacterCounter;
+        remainingCharacterCounter: string;
+    }
+    export class CharacterCounterComponent extends SurveyElementBase<ICharacterCounterComponentProps, any> {
+        protected getStateElement(): Base;
+        renderElement(): JSX.Element | null;
+    }
+}
 declare module "react/reactquestion_comment" {
     import { ReactSurveyElement, SurveyQuestionUncontrolledElement } from "react/reactquestion_element";
     import { QuestionCommentModel } from "entries/core";
@@ -20509,15 +20591,33 @@ declare module "react/reactSurveyProgressButtons" {
         componentWillUnmount(): void;
     }
 }
+declare module "react/components/rating/rating-item" {
+    import { QuestionRatingModel, RenderedRatingItem } from "entries/core";
+    import { SurveyElementBase } from "react/reactquestion_element";
+    interface IRatingItemProps {
+        question: QuestionRatingModel;
+        data: RenderedRatingItem;
+        index: any;
+        handleOnClick: any;
+        isDisplayMode: boolean;
+    }
+    export class RatingItem extends SurveyElementBase<IRatingItemProps, any> {
+        get question(): QuestionRatingModel;
+        get item(): RenderedRatingItem;
+        get index(): any;
+        getStateElement(): RenderedRatingItem;
+        render(): JSX.Element | null;
+        componentDidMount(): void;
+    }
+}
 declare module "react/reactquestion_rating" {
     import { SurveyQuestionElementBase } from "react/reactquestion_element";
-    import { QuestionRatingModel, RenderedRatingItem } from "entries/core";
+    import { QuestionRatingModel } from "entries/core";
     export class SurveyQuestionRating extends SurveyQuestionElementBase {
         constructor(props: any);
         protected get question(): QuestionRatingModel;
         handleOnClick(event: any): void;
         protected renderElement(): JSX.Element;
-        protected renderItem(key: string, item: RenderedRatingItem, index: number, cssClasses: any): JSX.Element;
     }
 }
 declare module "react/rating-dropdown" {
@@ -20810,6 +20910,7 @@ declare module "entries/react-ui-model" {
     export { MatrixRow } from "react/components/matrix/row";
     export { Skeleton } from "react/components/skeleton";
     export { NotifierComponent } from "react/components/notifier";
+    export { CharacterCounterComponent } from "react/components/character-counter";
     export { SurveyLocStringViewer } from "react/string-viewer";
     export { SurveyLocStringEditor } from "react/string-editor";
 }