survey-core 1.12.21 → 1.12.22

package/typings/src/popup-survey.d.ts

@@ -0,0 +1,132 @@
+import { Base } from "./base";
+import { SurveyModel } from "./survey";
+import { LocalizableString } from "./localizablestring";
+/**
+ * A class that renders a survey in a pop-up window.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/popup-survey/ (linkStyle))
+ */
+export declare class PopupSurveyModel extends Base {
+    surveyValue: SurveyModel;
+    windowElement: HTMLDivElement;
+    templateValue: string;
+    expandedChangedCallback: () => void;
+    showingChangedCallback: () => void;
+    constructor(jsonObj: any, initialModel?: SurveyModel);
+    protected onCreating(): void;
+    getType(): string;
+    /**
+     * A [`SurveyModel`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model) instance rendered in the pop-up window.
+     */
+    get survey(): SurveyModel;
+    /**
+     * Specifies how many seconds the pop-up window should remain open after users complete the survey.
+     *
+     * Default value: 0 (the window is closed immediately)
+     *
+     * Set this property to a negative value (for instance, -1) to keep the pop-up window open without a time limit.
+     */
+    closeOnCompleteTimeout: number;
+    /**
+     * Indicates whether the pop-up survey appears on the page, regardless of its [expand state](#isExpanded).
+     *
+     * You can set this property to `true` or `false` to control visibility of the pop-up survey. Alternatively, you can use the [`show()`](#show) and [`hide()`](#hide) methods.
+     */
+    get isShowing(): boolean;
+    set isShowing(val: boolean);
+    get isFullScreen(): boolean;
+    set isFullScreen(val: boolean);
+    /**
+     * Shows the pop-up survey. The survey may appear [expanded or collapsed](#isExpanded).
+     *
+     * As an alternative to this method, you can set the [`isShowing`](#isShowing) property to `true`.
+     * @see hide
+     */
+    show(): void;
+    /**
+     * Hides the pop-up survey.
+     *
+     * As an alternative to this method, you can set the [`isShowing`](#isShowing) property to `false`.
+     * @see show
+     * @see expand
+     * @see collapse
+     */
+    hide(): void;
+    toggleFullScreen(): void;
+    /**
+     * Indicates whether the pop-up window is expanded or collapsed.
+     *
+     * You can set this property to `true` or `false` to control the expand state of the pop-up survey. Alternatively, you can use the [`expand()`](#expand) and [`collapse()`](#collapse) methods.
+     */
+    get isExpanded(): boolean;
+    set isExpanded(val: boolean);
+    get isCollapsed(): boolean;
+    protected onExpandedChanged(): void;
+    /**
+     * A title for the pop-up window. If this property is undefined, the title is taken from [`SurveyModel`](#survey)'s [`title`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#title) property.
+     */
+    get title(): string;
+    set title(value: string);
+    get locTitle(): LocalizableString;
+    get locDescription(): LocalizableString;
+    /**
+     * Expands the pop-up window.
+     *
+     * As an alternative to this method, you can set the [`isExpanded`](#isExpanded) property to `true`.
+     * @see collapse
+     */
+    expand(): void;
+    /**
+     * Collapses the pop-up window, leaving only the survey title visible.
+     *
+     * As an alternative to this method, you can set the [`isExpanded`](#isExpanded) property to `false`.
+     * @see expand
+     */
+    collapse(): void;
+    changeExpandCollapse(): void;
+    /**
+     * Specifies whether to display a button that closes the pop-up window.
+     *
+     * Default value: `false`
+     *
+     * If you allow users to close the pop-up window, make sure to implement a UI element that opens it. This element should call the [`show()`](#show) method or enable the [`isShowing`](#isShowing) property.
+     * @see expand
+     * @see collapse
+     * @see hide
+     */
+    get allowClose(): boolean;
+    set allowClose(val: boolean);
+    /**
+     * Specifies whether to display a button that allows respondents to show the pop-up survey in full screen mode.
+     *
+     * Default value: `false`
+     */
+    get allowFullScreen(): boolean;
+    set allowFullScreen(val: boolean);
+    get css(): any;
+    get cssButton(): string;
+    get cssRoot(): string;
+    get cssRootCollapsedMod(): string;
+    get cssRootContent(): string;
+    get cssBody(): string;
+    get cssHeaderRoot(): string;
+    get cssHeaderTitleCollapsed(): string;
+    get cssHeaderButtonsContainer(): string;
+    get cssHeaderCollapseButton(): string;
+    get cssHeaderCloseButton(): string;
+    get cssHeaderFullScreenButton(): string;
+    get renderedWidth(): string;
+    width: string;
+    private updateCss;
+    private setCssRoot;
+    private updateCssButton;
+    private setCssButton;
+    protected createSurvey(jsonObj: any): SurveyModel;
+    protected onSurveyComplete(): void;
+    onScroll(): void;
+}
+/**
+ * @deprecated Use `PopupSurveyModel` instead.
+ */
+export declare class SurveyWindowModel extends PopupSurveyModel {
+}

package/typings/src/popup-utils.d.ts

@@ -0,0 +1,4 @@
+import { IDialogOptions, PopupModel } from "./popup";
+import { PopupBaseViewModel } from "./popup-view-model";
+export declare function createPopupModalViewModel(options: IDialogOptions, rootElement?: HTMLElement): PopupBaseViewModel;
+export declare function createPopupViewModel(model: PopupModel): PopupBaseViewModel;

package/typings/src/popup-view-model.d.ts

@@ -0,0 +1,81 @@
+import { Base, EventBase } from "./base";
+import { PopupModel } from "./popup";
+import { CssClassBuilder } from "./utils/cssClassBuilder";
+import { ActionContainer } from "./actions/container";
+import { AnimationOptions, IAnimationConsumer } from "./utils/animation";
+export declare const FOCUS_INPUT_SELECTOR = "input:not(:disabled):not([readonly]):not([type=hidden]),select:not(:disabled):not([readonly]),textarea:not(:disabled):not([readonly]), button:not(:disabled):not([readonly]), [tabindex]:not([tabindex^=\"-\"])";
+export declare class PopupBaseViewModel extends Base implements IAnimationConsumer {
+    protected popupSelector: string;
+    protected fixedPopupContainer: string;
+    protected containerSelector: string;
+    protected scrollingContentSelector: string;
+    protected prevActiveElement: HTMLElement;
+    protected footerToolbarValue: ActionContainer;
+    top: string;
+    left: string;
+    height: string;
+    width: string;
+    minWidth: string;
+    _isVisible: boolean;
+    locale: string;
+    private updateIsVisible;
+    private updateBeforeShowing;
+    private updateAfterHiding;
+    private visibilityAnimation;
+    getLeaveOptions(): AnimationOptions;
+    getEnterOptions(): AnimationOptions;
+    getAnimatedElement(): HTMLElement;
+    isAnimationEnabled(): boolean;
+    getRerenderEvent(): EventBase<Base>;
+    private getAnimationContainer;
+    get isVisible(): boolean;
+    set isVisible(val: boolean);
+    onVisibilityChanged: EventBase<PopupBaseViewModel, any>;
+    get container(): HTMLElement;
+    private containerElement;
+    private createdContainer;
+    getLocale(): string;
+    protected hidePopup(): void;
+    protected getStyleClass(): CssClassBuilder;
+    protected getShowFooter(): boolean;
+    protected getShowHeader(): boolean;
+    protected getPopupHeaderTemplate(): string;
+    protected createFooterActionBar(): void;
+    protected resetDimensionsAndPositionStyleProperties(): void;
+    protected onModelChanging(newModel: PopupModel): void;
+    private onModelIsVisibleChangedCallback;
+    private setupModel;
+    private _model;
+    get model(): PopupModel;
+    set model(model: PopupModel);
+    constructor(model: PopupModel);
+    get title(): string;
+    get contentComponentName(): string;
+    get contentComponentData(): any;
+    get isModal(): boolean;
+    get isFocusedContent(): boolean;
+    get isFocusedContainer(): boolean;
+    get showFooter(): boolean;
+    get showHeader(): boolean;
+    get popupHeaderTemplate(): string;
+    get isOverlay(): boolean;
+    get styleClass(): string;
+    get cancelButtonText(): string;
+    get footerToolbar(): ActionContainer;
+    onKeyDown(event: any): void;
+    private trapFocus;
+    switchFocus(): void;
+    protected _isPositionSetValue: boolean;
+    get isPositionSet(): boolean;
+    updateOnShowing(): void;
+    updateOnHiding(): void;
+    private focusContainer;
+    private focusFirstInput;
+    clickOutside(event?: Event): void;
+    cancel(): void;
+    dispose(): void;
+    initializePopupContainer(): void;
+    setComponentElement(componentRoot: HTMLElement): void;
+    resetComponentElement(): void;
+    protected preventScrollOuside(event: any, deltaY: number): void;
+}

package/typings/src/popup.d.ts

@@ -0,0 +1,66 @@
+import { Base, EventBase } from "./base";
+import { IAction } from "./actions/action";
+import { VerticalPosition, HorizontalPosition, PositionMode } from "./utils/popup";
+export interface IPopupOptionsBase {
+    onHide?: () => void;
+    onShow?: () => void;
+    onCancel?: () => void;
+    onDispose?: () => void;
+    getTargetCallback?: (container: HTMLElement) => HTMLElement;
+    getAreaCallback?: (container: HTMLElement) => HTMLElement;
+    cssClass?: string;
+    title?: string;
+    verticalPosition?: VerticalPosition;
+    horizontalPosition?: HorizontalPosition;
+    showPointer?: boolean;
+    isModal?: boolean;
+    canShrink?: boolean;
+    displayMode?: "popup" | "overlay";
+}
+export interface IDialogOptions extends IPopupOptionsBase {
+    componentName: string;
+    data: any;
+    onApply: () => boolean;
+    isFocusedContent?: boolean;
+}
+export declare class PopupModel<T = any> extends Base implements IPopupOptionsBase {
+    setWidthByTarget: boolean;
+    focusFirstInputSelector: string;
+    locale: string;
+    onCancel: () => void;
+    onApply: () => boolean;
+    onHide: () => void;
+    onShow: () => void;
+    onDispose: () => void;
+    getTargetCallback?: (container: HTMLElement) => HTMLElement;
+    getAreaCallback?: (container: HTMLElement) => HTMLElement;
+    contentComponentName: string;
+    contentComponentData: T;
+    verticalPosition: VerticalPosition;
+    horizontalPosition: HorizontalPosition;
+    showPointer: boolean;
+    isModal: boolean;
+    canShrink: boolean;
+    isFocusedContent: boolean;
+    isFocusedContainer: boolean;
+    cssClass: string;
+    title: string;
+    overlayDisplayMode: "auto" | "tablet-dropdown-overlay" | "dropdown-overlay" | "plain";
+    displayMode: "popup" | "overlay";
+    positionMode: PositionMode;
+    onVisibilityChanged: EventBase<PopupModel>;
+    onFooterActionsCreated: EventBase<Base>;
+    onRecalculatePosition: EventBase<Base>;
+    private refreshInnerModel;
+    constructor(contentComponentName: string, contentComponentData: T, options?: IPopupOptionsBase);
+    get isVisible(): boolean;
+    set isVisible(value: boolean);
+    toggleVisibility(): void;
+    show(): void;
+    hide(): void;
+    recalculatePosition(isResetHeight: boolean): void;
+    updateFooterActions(footerActions: Array<IAction>): Array<IAction>;
+    updateDisplayMode(menuType: "dropdown" | "popup" | "overlay"): void;
+    onHiding(): void;
+    dispose(): void;
+}

package/typings/src/progress-buttons.d.ts

@@ -0,0 +1,44 @@
+import { Base, EventBase } from "./base";
+import { PageModel } from "./page";
+import { SurveyModel } from "./survey";
+export declare class ProgressButtons extends Base {
+    survey: SurveyModel;
+    constructor(survey: SurveyModel);
+    isListElementClickable(index: number | any): boolean;
+    getRootCss(container?: string): string;
+    getListElementCss(index: number | any): string;
+    getScrollButtonCss(hasScroller: boolean, isLeftScroll: boolean): string;
+    clickListElement(element: number | PageModel): void;
+    isListContainerHasScroller(element: HTMLElement): boolean;
+    isCanShowItemTitles(element: HTMLElement): boolean;
+    clearConnectorsWidth(element: HTMLElement): void;
+    adjustConnectors(element: HTMLElement): void;
+    get isFitToSurveyWidth(): boolean;
+    get progressWidth(): string;
+    get showItemNumbers(): boolean;
+    get showItemTitles(): boolean;
+    getItemNumber(page: PageModel): string;
+    get headerText(): string;
+    get footerText(): string;
+    onResize: EventBase<ProgressButtons, any>;
+    processResponsiveness(width: number): void;
+}
+export interface IProgressButtonsViewModel {
+    container: string;
+    onResize(canShowItemTitles: boolean): void;
+    onUpdateScroller(hasScroller: boolean): void;
+    onUpdateSettings(): void;
+}
+export declare class ProgressButtonsResponsivityManager {
+    private model;
+    private element;
+    private viewModel;
+    private criticalProperties;
+    private timer;
+    private prevWidth;
+    private canShowItemTitles;
+    constructor(model: ProgressButtons, element: HTMLElement, viewModel: IProgressButtonsViewModel);
+    private forceUpdate;
+    private processResponsiveness;
+    dispose(): void;
+}