survey-core 1.12.21 → 1.12.22

package/typings/src/question_tagbox.d.ts

@@ -0,0 +1,98 @@
+import { LocalizableString } from "./localizablestring";
+import { QuestionCheckboxModel } from "./question_checkbox";
+import { PopupModel } from "./popup";
+import { DropdownMultiSelectListModel } from "./dropdownMultiSelectListModel";
+import { EventBase } from "./base";
+import { ItemValue } from "./itemvalue";
+/**
+ * A class that describes the Multi-Select Dropdown (Tag Box) question type.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/how-to-create-multiselect-tag-box/ (linkStyle))
+ */
+export declare class QuestionTagboxModel extends QuestionCheckboxModel {
+    private dropdownListModelValue;
+    private itemDisplayNameMap;
+    private deselectAllItemText;
+    constructor(name: string);
+    locStrsChanged(): void;
+    private updateReadOnlyText;
+    protected getDefaultItemComponent(): string;
+    get dropdownListModel(): DropdownMultiSelectListModel;
+    set dropdownListModel(val: DropdownMultiSelectListModel);
+    /**
+     * Specifies a comparison operation used to filter the drop-down list. Applies only if [`searchEnabled`](#searchEnabled) is `true`.
+     *
+     * Possible values:
+     *
+     * - `"contains"` (default)
+     * - `"startsWith"`
+     * @see [SurveyModel.onChoicesSearch](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#onChoicesSearch)
+     */
+    searchMode: "contains" | "startsWith";
+    /**
+     * Specifies whether to display a button that clears the selected value.
+     */
+    allowClear: boolean;
+    /**
+     * Specifies whether users can enter a value into the input field to filter the drop-down list.
+     */
+    searchEnabled: boolean;
+    /**
+     * Specifies whether to remove selected items from the drop-down list.
+     */
+    hideSelectedItems: boolean;
+    /**
+     * Enables lazy loading. If you set this property to `true`, you should implement the Survey's [`onChoicesLazyLoad`](https://surveyjs.io/form-library/documentation/surveymodel#onChoicesLazyLoad) event handler.
+     * @see choicesLazyLoadPageSize
+     * @see SurveyModel.onChoicesLazyLoad
+     */
+    choicesLazyLoadEnabled: boolean;
+    /**
+     * Specifies the number of choice items to load at a time when choices are loaded on demand.
+     * @see choicesLazyLoadEnabled
+     * @see SurveyModel.onChoicesLazyLoad
+     */
+    choicesLazyLoadPageSize: number;
+    /**
+     * Specifies whether to close the drop-down menu after a user selects a value.
+     */
+    closeOnSelect: number;
+    textWrapEnabled: boolean;
+    /**
+     * A text displayed in the input field when it doesn't have a value.
+     */
+    get placeholder(): string;
+    set placeholder(val: string);
+    get locPlaceholder(): LocalizableString;
+    get clearCaption(): string;
+    set clearCaption(value: string);
+    get locClearCaption(): LocalizableString;
+    get readOnlyText(): string;
+    set readOnlyText(val: string);
+    get locReadOnlyText(): LocalizableString;
+    getType(): string;
+    get ariaRole(): string;
+    get popupModel(): PopupModel;
+    getControlClass(): string;
+    protected updateCssClasses(res: any, css: any): void;
+    protected calcCssClasses(css: any): any;
+    onOpened: EventBase<QuestionTagboxModel>;
+    onOpenedCallBack(): void;
+    protected hasUnknownValue(val: any, includeOther?: boolean, isFilteredChoices?: boolean, checkEmptyValue?: boolean): boolean;
+    protected needConvertRenderedOtherToDataValue(): boolean;
+    protected onVisibleChoicesChanged(): void;
+    protected getItemIfChoicesNotContainThisValue(value: any, text?: string): any;
+    protected validateItemValues(itemValues: Array<ItemValue>): Array<ItemValue>;
+    updateItemDisplayNameMap(): void;
+    protected getFirstInputElementId(): string;
+    getInputId(): string;
+    protected supportEmptyValidation(): boolean;
+    protected onBlurCore(event: any): void;
+    protected onFocusCore(event: any): void;
+    protected allElementsSelected(): boolean;
+    updateSelectAllItemText(isAllSelected: boolean): void;
+    dispose(): void;
+    clearValue(keepComment?: boolean): void;
+    get showClearButton(): boolean;
+    get isNewA11yStructure(): boolean;
+}

package/typings/src/question_text.d.ts

@@ -0,0 +1,206 @@
+import { LocalizableString, LocalizableStrings } from "./localizablestring";
+import { HashTable } from "./helpers";
+import { SurveyError } from "./survey-error";
+import { QuestionTextBase } from "./question_textbase";
+import { CssClassBuilder } from "./utils/cssClassBuilder";
+import { InputMaskBase } from "./mask/mask_base";
+import { IInputMask } from "./mask/mask_utils";
+/**
+ * A class that describes the Single-Line Input question type.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-text/ (linkStyle))
+ */
+export declare class QuestionTextModel extends QuestionTextBase {
+    private locDataListValue;
+    private minValueRunner;
+    private maxValueRunner;
+    private maskInputAdapter;
+    private createMaskAdapter;
+    private deleteMaskAdapter;
+    private updateMaskAdapter;
+    onSetMaskType(newValue: string): void;
+    /**
+     * Specifies the type of a mask applied to the input.
+     *
+     * Possible values:
+     *
+     * - `"none"` (default)
+     * - `"numeric"`
+     * - `"currency"`
+     * - `"datetime"`
+     * - `"pattern"`
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/masked-input-fields/ (linkStyle))
+     * @see maskSettings
+     */
+    maskType: string;
+    /**
+     * Specifies text alignment within the input field.
+     *
+     * Possible values:
+     *
+     * - `"left"` - Aligns input text to the left side.
+     * - `"right"` - Aligns input text to the right side.
+     * - `"auto"` (default) - Applies right alignment if a [numeric or currency input mask](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#maskType) is specified. Otherwise, applies left alignment.
+     */
+    inputTextAlignment: "left" | "right" | "auto";
+    get maskTypeIsEmpty(): boolean;
+    /**
+     * An object with properties that configure the mask applied to the input.
+     *
+     * Available properties depend on the specified [`maskType`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#maskType) and belong to corresponding classes. Refer to the class APIs for a full list of properties:
+     *
+     * | `maskType` | Class |
+     * | ---------- | ----- |
+     * | `"numeric"` | [`InputMaskNumeric`](https://surveyjs.io/form-library/documentation/api-reference/inputmasknumeric) |
+     * | `"currency"` | [`InputMaskCurrency`](https://surveyjs.io/form-library/documentation/api-reference/inputmaskcurrency) |
+     * | `"datetime"` | [`InputMaskDateTime`](https://surveyjs.io/form-library/documentation/api-reference/inputmaskdatetime) |
+     * | `"pattern"` | [`InputMaskPattern`](https://surveyjs.io/form-library/documentation/api-reference/inputmaskpattern) |
+     *
+     * [View Demo](https://surveyjs.io/form-library/examples/masked-input-fields/ (linkStyle))
+     */
+    get maskSettings(): InputMaskBase;
+    set maskSettings(val: InputMaskBase);
+    private setNewMaskSettingsProperty;
+    protected createMaskSettings(): InputMaskBase;
+    constructor(name: string);
+    protected isTextValue(): boolean;
+    getType(): string;
+    onSurveyLoad(): void;
+    /**
+     * A value passed on to the [`type`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types) attribute of the underlying `<input>` element.
+     *
+     * Default value: `"text"`
+     */
+    get inputType(): string;
+    set inputType(val: string);
+    getMaxLength(): any;
+    protected runConditionCore(values: HashTable<any>, properties: HashTable<any>): void;
+    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
+    isLayoutTypeSupported(layoutType: string): boolean;
+    /**
+     * A value passed on to the [`size`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/size) attribute of the underlying `<input>` element.
+     */
+    get inputSize(): number;
+    set inputSize(val: number);
+    /**
+     * @deprecated Use the [`inputSize`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model#inputSize) property instead.
+     */
+    get size(): number;
+    set size(val: number);
+    get isTextInput(): boolean;
+    get renderedInputSize(): number;
+    get inputWidth(): string;
+    private calInputSize;
+    resetInputSize(): void;
+    /**
+     * A value passed on to the [`autocomplete`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) attribute of the underlying `<input>` element.
+     */
+    get autocomplete(): string;
+    set autocomplete(val: string);
+    /**
+     * A value passed on to the [`min`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/min) attribute of the underlying `<input>` element.
+     * @see minValueExpression
+     */
+    get min(): string;
+    set min(val: string);
+    /**
+     * A value passed on to the [`max`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/max) attribute of the underlying `<input>` element.
+     * @see maxValueExpression
+     */
+    get max(): string;
+    set max(val: string);
+    /**
+     * The minimum value specified as an expression. For example, `"minValueExpression": "today(-1)"` sets the minimum value to yesterday.
+     * @see min
+     */
+    get minValueExpression(): string;
+    set minValueExpression(val: string);
+    /**
+     * The maximum value specified as an expression. For example, `"maxValueExpression": "today(1)"` sets the maximum value to tomorrow.
+     * @see max
+     */
+    get maxValueExpression(): string;
+    set maxValueExpression(val: string);
+    get renderedMin(): any;
+    get renderedMax(): any;
+    /**
+     * An error message to display when the question value is less than the minimum accepted value.
+     * @see min
+     * @see minValueExpression
+     */
+    get minErrorText(): string;
+    set minErrorText(val: string);
+    get locMinErrorText(): LocalizableString;
+    /**
+     * An error message to display when the question value exceeds the maximum accepted value.
+     * @see max
+     * @see maxValueExpression
+     */
+    get maxErrorText(): string;
+    set maxErrorText(val: string);
+    get locMaxErrorText(): LocalizableString;
+    /**
+     * Returns `true` if the specified `inputType` supports the `min` and `max` properties.
+     * @see inputType
+     * @see min
+     * @see max
+     */
+    get isMinMaxType(): boolean;
+    _inputValue: string;
+    get maskInstance(): IInputMask;
+    get inputValue(): string;
+    set inputValue(val: string);
+    protected onChangeQuestionValue(newValue: any): void;
+    private updateInputValue;
+    private hasToConvertToUTC;
+    private createDate;
+    protected valueForSurveyCore(val: any): any;
+    protected valueFromDataCore(val: any): any;
+    private dateValidationMessage;
+    protected onCheckForErrors(errors: Array<SurveyError>, isOnValueChanged: boolean, fireCallback: boolean): void;
+    protected canSetValueToSurvey(): boolean;
+    protected convertFuncValuetoQuestionValue(val: any): any;
+    private getMinMaxErrorText;
+    private get isValueLessMin();
+    private get isValueGreaterMax();
+    private get isDateInputType();
+    private isDateTimeLocaleType;
+    private getCalculatedMinMax;
+    private setRenderedMinMax;
+    /**
+     * A value passed on to the [`step`](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step) attribute of the underlying `<input>` element.
+     */
+    get step(): string;
+    set step(val: string);
+    get renderedStep(): string;
+    protected getIsInputTextUpdate(): boolean;
+    supportAutoAdvance(): boolean;
+    supportGoNextPageError(): boolean;
+    /**
+     * An array of predefined options from which users can select. This property configures an HTML [`<datalist>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist) element and associates it with the underlying `input` element.
+     */
+    get dataList(): Array<string>;
+    set dataList(val: Array<string>);
+    get locDataList(): LocalizableStrings;
+    get dataListId(): string;
+    protected setNewValue(newValue: any): void;
+    protected correctValueType(newValue: any): any;
+    protected hasPlaceholder(): boolean;
+    protected getControlCssClassBuilder(): CssClassBuilder;
+    isReadOnlyRenderDiv(): boolean;
+    get inputStyle(): any;
+    private updateTextAlign;
+    private _isWaitingForEnter;
+    private updateValueOnEvent;
+    onCompositionUpdate: (event: any) => void;
+    onKeyUp: (event: any) => void;
+    private updateDateValidationMessage;
+    onKeyDown: (event: any) => void;
+    onChange: (event: any) => void;
+    protected onBlurCore(event: any): void;
+    protected onFocusCore(event: any): void;
+    afterRenderQuestionElement(el: HTMLElement): void;
+    beforeDestroyQuestionElement(el: HTMLElement): void;
+}
+export declare function isMinMaxType(obj: any): boolean;

package/typings/src/question_textbase.d.ts

@@ -0,0 +1,62 @@
+import { Question } from "./question";
+import { CssClassBuilder } from "./utils/cssClassBuilder";
+import { LocalizableString } from "./localizablestring";
+import { Base } from "./base";
+export declare class CharacterCounter extends Base {
+    remainingCharacterCounter: string;
+    updateRemainingCharacterCounter(newValue: string, maxLength: number): void;
+}
+/**
+ * A base class for the [Single-Line Input](https://surveyjs.io/form-library/documentation/questiontextmodel) and [Long Text](https://surveyjs.io/form-library/documentation/questioncommentmodel) question types.
+ */
+export declare class QuestionTextBase extends Question {
+    constructor(name: string);
+    protected isTextValue(): boolean;
+    /**
+     * The maximum text length measured in characters. Assign 0 if the length should be unlimited.
+     *
+     * Default value: -1 (inherits the actual value from the `SurveyModel`'s [`maxTextLength`](https://surveyjs.io/form-library/documentation/surveymodel#maxTextLength) property).
+     */
+    get maxLength(): number;
+    set maxLength(val: number);
+    getMaxLength(): any;
+    characterCounter: CharacterCounter;
+    updateRemainingCharacterCounter(newValue: string): void;
+    /**
+     * A placeholder for the input field.
+     */
+    placeholder: string;
+    get placeHolder(): string;
+    set placeHolder(val: string);
+    get locPlaceHolder(): LocalizableString;
+    getType(): string;
+    isEmpty(): boolean;
+    /**
+     * Specifies when to update the question value.
+     *
+     * Possible values:
+     *
+     * - `"onBlur"` - Updates the value after the input field loses focus.
+     * - `"onTyping"` - Updates the value on every key press.
+     * - `"default"` (default) - Inherits the value from the `SurveyModel`'s [`textUpdateMode`](https://surveyjs.io/form-library/documentation/surveymodel#textUpdateMode) property.
+     *
+     * > Do not use the `"onTyping"` mode if your survey contains many expressions. Expressions are reevaluated each time a question value is changed. In `"onTyping"` mode, the question value changes frequently. This may cause performance degradation.
+     */
+    get textUpdateMode(): string;
+    set textUpdateMode(val: string);
+    protected getIsInputTextUpdate(): boolean;
+    get renderedPlaceholder(): string;
+    protected onReadOnlyChanged(): void;
+    localeChanged(): void;
+    protected supportEmptyValidation(): boolean;
+    protected resetRenderedPlaceholder(): void;
+    protected hasPlaceholder(): boolean;
+    protected setNewValue(newValue: any): void;
+    protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
+    protected convertToCorrectValue(val: any): any;
+    protected getValueSeparator(): string;
+    protected getControlCssClassBuilder(): CssClassBuilder;
+    getControlClass(): string;
+    get isNewA11yStructure(): boolean;
+    onKeyDownPreprocess: (event: any) => void;
+}

package/typings/src/questionfactory.d.ts

@@ -0,0 +1,27 @@
+import { Question } from "./question";
+import { IElement } from "./base-interfaces";
+export declare class QuestionFactory {
+    static Instance: QuestionFactory;
+    static get DefaultChoices(): string[];
+    static get DefaultColums(): string[];
+    static get DefaultRows(): string[];
+    static get DefaultMutlipleTextItems(): string[];
+    registerQuestion(questionType: string, questionCreator: (name: string) => Question, showInToolbox?: boolean): void;
+    registerCustomQuestion(questionType: string): void;
+    unregisterElement(elementType: string, removeFromSerializer?: boolean): void;
+    clear(): void;
+    getAllTypes(): Array<string>;
+    createQuestion(questionType: string, name: string): Question;
+}
+export declare class ElementFactory {
+    static Instance: ElementFactory;
+    private creatorHash;
+    registerElement(elementType: string, elementCreator: (name: string) => IElement, showInToolbox?: boolean): void;
+    registerCustomQuestion: (questionType: string, showInToolbox?: boolean) => void;
+    clear(): void;
+    unregisterElement(elementType: string, removeFromSerializer?: boolean): void;
+    getAllToolboxTypes(): Array<string>;
+    getAllTypes(): Array<string>;
+    createElement(elementType: string, name: string): IElement;
+    private getAllTypesCore;
+}

package/typings/src/questionnonvalue.d.ts

@@ -0,0 +1,22 @@
+import { Question, IConditionObject } from "./question";
+import { SurveyError } from "./survey-error";
+/**
+ * A base class for question types that cannot have a value ([Html](https://surveyjs.io/form-library/documentation/questionhtmlmodel), [Image](https://surveyjs.io/form-library/documentation/questionimagemodel)).
+ *
+ * This class does not implement new functionality—it only redefines default values of certain properties inherited from the [`Question`](https://surveyjs.io/form-library/documentation/question) class.
+ */
+export declare class QuestionNonValue extends Question {
+    constructor(name: string);
+    getType(): string;
+    get hasInput(): boolean;
+    get hasTitle(): boolean;
+    getTitleLocation(): string;
+    get hasComment(): boolean;
+    hasErrors(fireCallback?: boolean, rec?: any): boolean;
+    getAllErrors(): Array<SurveyError>;
+    supportAutoAdvance(): boolean;
+    addConditionObjectsByContext(objects: Array<IConditionObject>, context: any): void;
+    getConditionJson(operator?: string, path?: string): any;
+    get ariaRole(): string;
+    get ariaRequired(): any;
+}

package/typings/src/rendererFactory.d.ts

@@ -0,0 +1,11 @@
+import { Question } from "./question";
+export declare class RendererFactory {
+    static Instance: RendererFactory;
+    private renderersHash;
+    private defaultHash;
+    unregisterRenderer(questionType: string, rendererAs: string): void;
+    registerRenderer(questionType: string, renderAs: string, renderer: any, useAsDefault?: boolean): void;
+    getRenderer(questionType: string, renderAs: string): string;
+    getRendererByQuestion(question: Question): any;
+    clear(): void;
+}