survey-core 1.12.4 → 1.12.6

package/typings/packages/survey-core/src/survey.d.ts

@@ -627,11 +627,17 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     * An event that is raised every second while the timer is running.
     *
     * Use the [`timeSpent`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timeSpent) property to find out how many seconds have elapsed.
-    * @see maxTimeToFinish
-    * @see maxTimeToFinishPage
-    * @see showTimerPanel
+    * @see timeLimit
+    * @see timeLimitPerPage
+    * @see showTimer
+    * @see timerLocation
     * @see startTimer
     */
+    onTimerTick: EventBase<SurveyModel, {}>;
+    /**
+     * Obsolete. Use the [`onTimerTick`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onTimerTick) event instead.
+     * @deprecated
+     */
     onTimer: EventBase<SurveyModel, {}>;
     onTimerPanelInfoText: EventBase<SurveyModel, any>;
     /**
@@ -776,6 +782,18 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
      */
     headerView: "advanced" | "basic";
     protected insertAdvancedHeader(advHeader: Cover): void;
+    /**
+     * Specifies whether the [Complete page](https://surveyjs.io/form-library/documentation/design-survey/create-a-multi-page-survey#complete-page) should display the [survey header](https://surveyjs.io/form-library/examples/brand-your-survey-header/).
+     *
+     * Possible values:
+     *
+     * - `true` - Displays the survey header on the Complete page.
+     * - `false` - Hides the header when users reach the Complete page.
+     * - `"auto"` (default) - Displays a header with the basic view, but hides a header with the advanced view (see the [`headerView`](https://surveyjs.io/form-library/documentation/api-reference/itheme#headerView) property description).
+     *
+     * > This property cannot be specified in the survey JSON schema. Use dot notation to specify it.
+     */
+    showHeaderOnCompletePage: true | false | "auto";
     private getNavigationCss;
     private lazyRenderingValue;
     showBrandInfo: boolean;
@@ -2179,6 +2197,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     private getProgressTextCore;
     rootCss: string;
     getRootCss(): string;
+    private isSmoothScrollEnabled;
     private resizeObserver;
     afterRenderSurvey(htmlElement: any): void;
     /**
@@ -2250,7 +2269,7 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     private getUpdatedPageTitleActions;
     getUpdatedMatrixRowActions(question: QuestionMatrixDropdownModelBase, row: any, actions: Array<IAction>): IAction[];
     skeletonHeight: number;
-    scrollElementToTop(element: ISurveyElement, question: Question, page: PageModel, id: string, scrollIfVisible?: boolean, scrollIntoViewOptions?: ScrollIntoViewOptions, passedRootElement?: HTMLElement): any;
+    scrollElementToTop(element: ISurveyElement, question: Question, page: PageModel, id: string, scrollIfVisible?: boolean, scrollIntoViewOptions?: ScrollIntoViewOptions, passedRootElement?: HTMLElement, onScolledCallback?: () => void): any;
     /**
      * Opens a dialog window for users to select files.
      * @param input A [file input HTML element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
@@ -2660,39 +2679,60 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     getCorrectedAnswers(): number;
     getInCorrectedAnswers(): number;
     /**
-     * Displays the timer panel and specifies its position. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
+     * Obsolete. Use the [`showTimer`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTimer) and [`timerLocation`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timerLocation) properties instead.
+     * @deprecated
+     */
+    get showTimerPanel(): string;
+    set showTimerPanel(val: string);
+    /**
+     * Specifies the timer's visibility. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
      *
-     * Possible values:
+     * Default value: `false`
      *
-     * - `"top"` - Displays the timer panel at the top of the survey.
-     * - `"bottom"` - Displays the timer panel at the bottom of the survey.
-     * - `"none"` (default) - Hides the timer panel.
+     * If you set this property to `true`, the timer starts automatically when the survey begins. To specify time limits, use the [`timeLimit`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timeLimit) and [`timeLimitPerPage`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timeLimitPerPage) properties.
      *
-     * If the timer panel is displayed, the timer starts automatically when the survey begins. To specify time limits, use the [`maxTimeToFinish`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#maxTimeToFinish) and [`maxTimeToFinishPage`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#maxTimeToFinishPage) properties.
+     * The timer displays information about time spent on an individual page and the entire survey. If you want to display only the page timer or the survey timer, set the [`timerInfoMode`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timerInfoMode) property to `"page"` or `"survey"`.
      *
-     * The timer panel displays information about time spent on an individual page and the entire survey. If you want to display only the page timer or the survey timer, set the [`showTimerPanelMode`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTimerPanelMode) property to `"page"` or `"survey"`.
-     * @see startTimer
-     * @see stopTimer
+     * You can enable the timer without displaying it. In this case, you need to specify the required time limits and use the [`startTimer()`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#startTimer) and [`stopTimer()`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#stopTimer) methods to control the timer.
+     * @see timerLocation
      * @see timeSpent
-     * @see onTimer
+     * @see onTimerTick
      */
-    get showTimerPanel(): string;
-    set showTimerPanel(val: string);
+    get showTimer(): boolean;
+    set showTimer(val: boolean);
+    /**
+     * Specifies the timer's position relative to the survey. Applies only if the [`showTimer`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTimer) property is set to `true`.
+     *
+     * Possible values:
+     *
+     * - `"top"` (default) - Displays the timer at the top of the survey.
+     * - `"bottom"` - Displays the timer at the bottom of the survey.
+     * @see onTimerTick
+     */
+    get timerLocation(): string;
+    set timerLocation(val: string);
     get isTimerPanelShowingOnTop(): boolean;
     get isTimerPanelShowingOnBottom(): boolean;
     /**
-     * Specifies whether the timer panel displays timers for the current page, the entire survey, or both. Applies only if the timer panel is [visible](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTimerPanel).
+     * Specifies whether the timer panel displays timers for the current page, the entire survey, or both. Applies only if the timer panel is [visible](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTimer).
      *
      * Possible values:
      *
      * - `"survey"` - Displays only the survey timer.
      * - `"page"` - Displays only the page timer.
-     * - `"all"` (default) - Displays both the survey and page timers.
+     * - `"combined"` (default) - Displays both the survey and page timers.
      * @see timeSpent
-     * @see onTimer
+     * @see onTimerTick
      * @see startTimer
      * @see stopTimer
      */
+    get timerInfoMode(): string;
+    set timerInfoMode(val: string);
+    private getTimerInfoVal;
+    /**
+     * Obsolete. Use the [`timerInfoMode`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timerInfoMode) property instead.
+     * @deprecated
+     */
     get showTimerPanelMode(): string;
     set showTimerPanelMode(val: string);
     gridLayoutEnabled: boolean;
@@ -2739,20 +2779,20 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     /**
      * Starts a timer that calculates how many seconds a respondent has spent on the survey. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
      * @see stopTimer
-     * @see maxTimeToFinish
-     * @see maxTimeToFinishPage
+     * @see timeLimit
+     * @see timeLimitPerPage
      * @see timeSpent
-     * @see onTimer
+     * @see onTimerTick
      */
     startTimer(): void;
     startTimerFromUI(): void;
     /**
      * Stops the timer. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
      * @see startTimer
-     * @see maxTimeToFinish
-     * @see maxTimeToFinishPage
+     * @see timeLimit
+     * @see timeLimitPerPage
      * @see timeSpent
-     * @see onTimer
+     * @see onTimerTick
      */
     stopTimer(): void;
     /**
@@ -2761,8 +2801,8 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
      * Assign a number to this property if you need to start the quiz timer from a specific time (for instance, if you want to continue an interrupted quiz).
      *
      * You can also find out how many seconds a respondent has spent on an individual survey page. To do this, use the [`timeSpent`](https://surveyjs.io/form-library/documentation/api-reference/page-model#timeSpent) property of a [`PageModel`](https://surveyjs.io/form-library/documentation/api-reference/page-model) object.
-     * @see maxTimeToFinish
-     * @see maxTimeToFinishPage
+     * @see timeLimit
+     * @see timeLimitPerPage
      * @see startTimer
      */
     get timeSpent(): number;
@@ -2770,27 +2810,39 @@ export declare class SurveyModel extends SurveyElementCore implements ISurvey, I
     /**
      * A time period that a respondent has to complete the survey; measured in seconds. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
      *
-     * A negative value or 0 sets an unlimited time period.
+     * Default value: 0 (time is unlimited)
      *
      * [View Demo](https://surveyjs.io/form-library/examples/make-quiz-javascript/ (linkStyle))
-     * @see maxTimeToFinishPage
+     * @see timeLimitPerPage
      * @see startTimer
      * @see timeSpent
      */
+    get timeLimit(): number;
+    set timeLimit(val: number);
+    /**
+     * Obsolete. Use the [`timeLimit`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timeLimit) property instead.
+     * @deprecated
+     */
     get maxTimeToFinish(): number;
     set maxTimeToFinish(val: number);
     /**
      * A time period that a respondent has to complete each survey page; measured in seconds. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).
      *
-     * A negative value or 0 sets an unlimited time period.
+     * Default value: 0 (time is unlimited)
      *
-     * You can also use `PageModel`'s [`maxTimeToFinish`](https://surveyjs.io/form-library/documentation/api-reference/page-model#maxTimeToFinish) property to specify a time period for an individual survey page.
+     * You can also use `PageModel`'s [`timeLimit`](https://surveyjs.io/form-library/documentation/api-reference/page-model#timeLimit) property to specify a time period for an individual survey page.
      *
      * [View Demo](https://surveyjs.io/form-library/examples/make-quiz-javascript/ (linkStyle))
-     * @see maxTimeToFinish
+     * @see timeLimit
      * @see startTimer
      * @see timeSpent
      */
+    get timeLimitPerPage(): number;
+    set timeLimitPerPage(val: number);
+    /**
+     * Obsolete. Use the [`timeLimitPerPage`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#timeLimitPerPage) property instead.
+     * @deprecated
+     */
     get maxTimeToFinishPage(): number;
     set maxTimeToFinishPage(val: number);
     private doTimer;

package/typings/packages/survey-core/src/surveyTimerModel.d.ts

@@ -18,7 +18,7 @@ export interface ISurveyTimerText {
     onCurrentPageChanged: EventBase<SurveyModel>;
 }
 export declare class SurveyTimerModel extends Base {
-    onTimer: (page: PageModel) => void;
+    onTimerTick: (page: PageModel) => void;
     private surveyValue;
     constructor(survey: ISurvey);
     text: string;

package/typings/packages/survey-core/src/surveytimer.d.ts

@@ -14,6 +14,7 @@ export declare class SurveyTimer {
     private listenerCounter;
     private timerId;
     private prevTimeInMs;
+    onTimerTick: EventBase<SurveyTimer, SurveyTimerEvent>;
     onTimer: EventBase<SurveyTimer, SurveyTimerEvent>;
     start(func?: (timer: SurveyTimer, options: SurveyTimerEvent) => void): void;
     stop(func?: (timer: SurveyTimer, options: SurveyTimerEvent) => any): void;

package/typings/packages/survey-core/src/themes.d.ts

@@ -91,7 +91,13 @@ export interface IHeader {
      *
      * Default value: 256
      */
-    height: number;
+    height?: number;
+    /**
+     * The height of the survey header on smartphones, measured in pixels.
+     *
+     * Default value: 0 (the height is calculated automatically to accommodate the header's content).
+     */
+    mobileHeight?: number;
     /**
      * A string value that specifies whether the header spans the width of the survey or that of the survey container.
      *
@@ -105,27 +111,27 @@ export interface IHeader {
      * @see [SurveyModel.width](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#width)
      * @see [SurveyModel.widthMode](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#widthMode)
      */
-    inheritWidthFrom: "survey" | "container";
+    inheritWidthFrom?: "survey" | "container";
     /**
      * The width of the header area that contains the survey [title](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#title) and [description](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#description), measured in pixels.
      *
      * Default value: 512
      */
-    textAreaWidth: number;
+    textAreaWidth?: number;
     /**
      * A Boolean value that specifies whether the header overlaps the survey content.
      *
      * Default value: `false`
      */
-    overlapEnabled: boolean;
+    overlapEnabled?: boolean;
     /**
      * An image to display in the background of the header. Accepts a base64 or URL string value.
      */
-    backgroundImage: string;
+    backgroundImage?: string;
     /**
      * A value from 0 to 1 that specifies how transparent the [background image](#backgroundImage) should be: 0 makes the image completely transparent, and 1 makes it opaque.
      */
-    backgroundImageOpacity: number;
+    backgroundImageOpacity?: number;
     /**
      * A string value that specifies how to resize a [background image](#backgroundImage) to fit it into the header.
      *
@@ -140,7 +146,7 @@ export interface IHeader {
      * - `"tile"`\
      * Tiles as many copies of the image as needed to fill the entire header.
      */
-    backgroundImageFit: "cover" | "fill" | "contain" | "tile";
+    backgroundImageFit?: "cover" | "fill" | "contain" | "tile";
     /**
      * A string value that specifies the logo position within the header in the horizontal direction.
      *
@@ -152,7 +158,7 @@ export interface IHeader {
      *
      * To specify a logo, set `SurveyModel`'s [`logo`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#logo) property.
      */
-    logoPositionX: HorizontalAlignment;
+    logoPositionX?: HorizontalAlignment;
     /**
      * A string value that specifies the logo position within the header in the vertical direction.
      *
@@ -164,7 +170,7 @@ export interface IHeader {
      *
      * To specify a logo, set `SurveyModel`'s [`logo`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#logo) property.
      */
-    logoPositionY: VerticalAlignment;
+    logoPositionY?: VerticalAlignment;
     /**
      * A string value that specifies the survey title position within the header in the horizontal direction.
      *
@@ -176,7 +182,7 @@ export interface IHeader {
      *
      * To specify a survey title, set `SurveyModel`'s [`title`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#title) property.
      */
-    titlePositionX: HorizontalAlignment;
+    titlePositionX?: HorizontalAlignment;
     /**
      * A string value that specifies the survey title position within the header in the vertical direction.
      *
@@ -188,7 +194,7 @@ export interface IHeader {
      *
      * To specify a survey title, set `SurveyModel`'s [`title`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#title) property.
      */
-    titlePositionY: VerticalAlignment;
+    titlePositionY?: VerticalAlignment;
     /**
      * A string value that specifies the survey description position within the header in the horizontal direction.
      *
@@ -200,7 +206,7 @@ export interface IHeader {
      *
      * To specify a survey description, set `SurveyModel`'s [`description`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#description) property.
      */
-    descriptionPositionX: HorizontalAlignment;
+    descriptionPositionX?: HorizontalAlignment;
     /**
      * A string value that specifies the survey description position within the header in the vertical direction.
      *
@@ -212,5 +218,5 @@ export interface IHeader {
      *
      * To specify a survey description, set `SurveyModel`'s [`description`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#description) property.
      */
-    descriptionPositionY: VerticalAlignment;
+    descriptionPositionY?: VerticalAlignment;
 }

package/typings/packages/survey-core/src/utils/text-area.d.ts

@@ -27,6 +27,7 @@ export interface ITextArea {
 export declare class TextAreaModel {
     private options;
     private element;
+    private updateElement;
     private onPropertyChangedCallback;
     constructor(options: ITextArea);
     setElement(element: HTMLTextAreaElement | null): void;

package/typings/packages/survey-core/src/validator.d.ts

@@ -16,6 +16,7 @@ export declare class SurveyValidator extends Base {
     errorOwner: ISurveyErrorOwner;
     onAsyncCompleted: (result: ValidatorResult) => void;
     constructor();
+    get isValidator(): boolean;
     getSurvey(live?: boolean): ISurvey;
     /**
      * An error message to display when a value fails validation.