survey-core 1.12.21 → 1.12.23

package/typings/src/question_boolean.d.ts

@@ -0,0 +1,116 @@
+import { Question } from "./question";
+import { LocalizableString } from "./localizablestring";
+import { ActionContainer } from "./actions/container";
+/**
+ * A class that describes the Yes/No (Boolean) question type.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-boolean/ (linkStyle))
+ */
+export declare class QuestionBooleanModel extends Question {
+    constructor(name: string);
+    getType(): string;
+    isLayoutTypeSupported(layoutType: string): boolean;
+    supportAutoAdvance(): boolean;
+    get isIndeterminate(): boolean;
+    get hasTitle(): boolean;
+    /**
+     * Gets or sets the question value as a Boolean value.
+     *
+     * If you set the `valueTrue` and `valueFalse` properties, the `value` property contains their values instead of Boolean values. This may be inconvenient when you operate the question value in code. To access the standard Boolean values, use the `booleanValue` property.
+     * @see valueTrue
+     * @see valueFalse
+     */
+    get booleanValue(): any;
+    set booleanValue(val: any);
+    booleanValueRendered: boolean;
+    get checkedValue(): any;
+    set checkedValue(val: any);
+    private setBooleanValue;
+    get defaultValue(): any;
+    set defaultValue(val: any);
+    getDefaultValue(): any;
+    get locTitle(): LocalizableString;
+    get labelRenderedAriaID(): string;
+    beforeDestroyQuestionElement(el: HTMLElement): void;
+    showTitle: boolean;
+    /**
+     * @deprecated Use the [`title`](https://surveyjs.io/form-library/documentation/api-reference/boolean-question-model#title) property instead.
+     */
+    label: string;
+    useTitleAsLabel: boolean;
+    get isLabelRendered(): boolean;
+    get canRenderLabelDescription(): boolean;
+    /**
+     * Gets or sets a text label that corresponds to a positive answer.
+     *
+     * Default value: "Yes"
+     * @see valueTrue
+     * @see valueFalse
+     */
+    get labelTrue(): string;
+    set labelTrue(val: string);
+    get locLabelTrue(): LocalizableString;
+    get isDeterminated(): boolean;
+    /**
+     * Specifies whether to swap the order of the Yes and No answers.
+     *
+     * Default value: `false`
+     *
+     * By default, the order is [ "No", "Yes"]. Enable this property to reorder the answers as follows: [ "Yes", "No" ].
+     */
+    swapOrder: boolean;
+    get locLabelLeft(): LocalizableString;
+    get locLabelRight(): LocalizableString;
+    /**
+     * Gets or sets a text label that corresponds to a negative answer.
+     *
+     * Default value: "No"
+     * @see valueTrue
+     * @see valueFalse
+     */
+    get labelFalse(): string;
+    set labelFalse(val: string);
+    get locLabelFalse(): LocalizableString;
+    /**
+     * A value to save in survey results when respondents give a positive answer.
+     *
+     * Default value: `true`
+     * @see labelTrue
+     * @see labelFalse
+     */
+    valueTrue: any;
+    /**
+     * A value to save in survey results when respondents give a negative answer.
+     *
+     * Default value: `false`
+     * @see labelTrue
+     * @see labelFalse
+     */
+    valueFalse: any;
+    getValueTrue(): any;
+    getValueFalse(): any;
+    protected setDefaultValue(): void;
+    private isDefaultValueSet;
+    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
+    private getItemCssValue;
+    getItemCss(): string;
+    getCheckboxItemCss(): string;
+    getLabelCss(checked: boolean): string;
+    updateValueFromSurvey(newValue: any, clearData?: boolean): void;
+    protected onValueChanged(): void;
+    get svgIcon(): string;
+    get itemSvgIcon(): string;
+    get allowClick(): boolean;
+    getCheckedLabel(): LocalizableString;
+    protected setQuestionValue(newValue: any, updateIsAnswered?: boolean): void;
+    onLabelClick(event: any, value: boolean): boolean;
+    private calculateBooleanValueByEvent;
+    onSwitchClickModel(event: any): boolean;
+    onKeyDownCore(event: any): boolean;
+    getRadioItemClass(css: any, value: any): string;
+    protected supportResponsiveness(): boolean;
+    protected getCompactRenderAs(): string;
+    protected createActionContainer(allowAdaptiveActions?: boolean): ActionContainer;
+    get isNewA11yStructure(): boolean;
+    get a11y_input_ariaRole(): string;
+}

package/typings/src/question_buttongroup.d.ts

@@ -0,0 +1,51 @@
+import { ItemValue } from "./itemvalue";
+import { QuestionCheckboxBase } from "./question_baseselect";
+import { LocalizableString } from "./localizablestring";
+export declare class ButtonGroupItemValue extends ItemValue {
+    protected typeName: string;
+    constructor(value: any, text?: string, typeName?: string);
+    iconName: string;
+    iconSize: number;
+    /**
+     * By default item caption is visible.
+     * Set it 'false' to hide item caption.
+     */
+    showCaption: boolean;
+    getType(): string;
+}
+/**
+ * A Model for a button group question.
+ */
+export declare class QuestionButtonGroupModel extends QuestionCheckboxBase {
+    constructor(name: string);
+    getType(): string;
+    protected getItemValueType(): string;
+    supportOther(): boolean;
+}
+export declare class ButtonGroupItemModel {
+    question: QuestionButtonGroupModel;
+    item: ItemValue;
+    index: number;
+    constructor(question: QuestionButtonGroupModel, item: ItemValue, index: number);
+    get value(): any;
+    get iconName(): string;
+    get iconSize(): string | number;
+    get caption(): LocalizableString;
+    get showCaption(): any;
+    get isRequired(): boolean;
+    get selected(): boolean;
+    get readOnly(): boolean;
+    get name(): string;
+    get id(): string;
+    get hasErrors(): boolean;
+    get describedBy(): string;
+    private get labelClass();
+    get css(): {
+        label: string;
+        icon: any;
+        control: any;
+        caption: any;
+        decorator: any;
+    };
+    onChange(): void;
+}

package/typings/src/question_checkbox.d.ts

@@ -0,0 +1,158 @@
+import { QuestionCheckboxBase } from "./question_baseselect";
+import { ItemValue } from "./itemvalue";
+import { LocalizableString } from "./localizablestring";
+import { IQuestion } from "./base-interfaces";
+import { SurveyError } from "./survey-error";
+/**
+ * A class that describes the Checkboxes question type.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-checkbox/ (linkStyle))
+ */
+export declare class QuestionCheckboxModel extends QuestionCheckboxBase {
+    private selectAllItemValue;
+    protected selectAllItemText: LocalizableString;
+    private invisibleOldValues;
+    protected defaultSelectedItemValues: Array<ItemValue>;
+    constructor(name: string);
+    protected getDefaultItemComponent(): string;
+    getType(): string;
+    protected onCreating(): void;
+    protected getFirstInputElementId(): string;
+    /**
+     * Specifies a property name used to store selected values.
+     *
+     * Set this property if you want to store selected values in an array of objects instead of an array of primitive values. For example, if you set `valuePropertyName` to `"car"`, the `value` property will contain an array of objects `[{ car: "Ford" }, { car: "Tesla" }]`, not an array of string values `[ "Ford", "Tesla" ]`.
+     */
+    get valuePropertyName(): string;
+    set valuePropertyName(val: string);
+    getQuestionFromArray(name: string, index: number): IQuestion;
+    /**
+     * Returns the "Select All" choice item. Use this property to change the item's `value` or `text`.
+     * @see showSelectAllItem
+     */
+    get selectAllItem(): ItemValue;
+    /**
+     * Gets or sets a caption for the "Select All" choice item.
+     * @see showSelectAllItem
+     */
+    get selectAllText(): string;
+    set selectAllText(val: string);
+    get locSelectAllText(): LocalizableString;
+    /**
+     * Enable this property to display a "Select All" item. When users select it, all other choice items, except "Other" and "None", also become selected.
+     * @see selectAll
+     * @see isAllSelected
+     * @see separateSpecialChoices
+     */
+    get showSelectAllItem(): boolean;
+    set showSelectAllItem(val: boolean);
+    get hasSelectAll(): boolean;
+    set hasSelectAll(val: boolean);
+    /**
+     * Returns `true` if all choice items, except "Other" and "None", are selected.
+     * @see showSelectAllItem
+     */
+    get isAllSelected(): boolean;
+    set isAllSelected(val: boolean);
+    toggleSelectAll(): void;
+    protected allElementsSelected(): boolean;
+    /**
+     * Selects all choice items, except "Other" and "None".
+     *
+     * To clear selection, call the `clearValue()` method.
+     * @see clearValue
+     */
+    selectAll(): void;
+    clickItemHandler(item: ItemValue, checked?: boolean): void;
+    protected isItemSelectedCore(item: ItemValue): boolean;
+    protected hasUnknownValueItem(val: any, includeOther?: boolean, isFilteredChoices?: boolean, checkEmptyValue?: boolean): boolean;
+    protected convertFuncValuetoQuestionValue(val: any): any;
+    private getRealValue;
+    get isValueArray(): boolean;
+    /**
+     * Specifies the maximum number of selected choices.
+     *
+     * Default value: 0 (unlimited)
+     *
+     * > This property only limits the number of choice items that can be selected by users. You can select any number of choice items in code, regardless of the `maxSelectedChoices` value.
+     * @see minSelectedChoices
+     */
+    get maxSelectedChoices(): number;
+    set maxSelectedChoices(val: number);
+    /**
+     * Specifies the minimum number of selected choices.
+     *
+     * Default value: 0 (unlimited)
+     *
+     * > This property only limits the number of choice items that can be selected by users. You can select any number of choice items in code, regardless of the `minSelectedChoices` value.
+     * @see maxSelectedChoices
+     */
+    get minSelectedChoices(): number;
+    set minSelectedChoices(val: number);
+    /**
+     * An array of selected choice items. Includes the "Other" and "None" choice items if they are selected, but not "Select All". Items are sorted in the order they were selected.
+     * @see visibleChoices
+     * @see enabledChoices
+     */
+    get selectedChoices(): Array<ItemValue>;
+    get selectedItems(): Array<ItemValue>;
+    get hasFilteredValue(): boolean;
+    getFilteredName(): any;
+    getFilteredValue(): any;
+    protected getMultipleSelectedItems(): Array<ItemValue>;
+    protected validateItemValues(itemValues: Array<ItemValue>): Array<ItemValue>;
+    protected getAnswerCorrectIgnoreOrder(): boolean;
+    protected onCheckForErrors(errors: Array<SurveyError>, isOnValueChanged: boolean, fireCallback: boolean): void;
+    protected onVisibleChoicesChanged(): void;
+    protected onEnableItemCallBack(item: ItemValue): boolean;
+    protected onAfterRunItemsEnableCondition(): void;
+    private updateSelectAllItemProps;
+    private getSelectAllEnabled;
+    private getVisibleEnableItems;
+    private shouldCheckMaxSelectedChoices;
+    private checkMinSelectedChoicesUnreached;
+    protected getItemClassCore(item: any, options: any): string;
+    updateValueFromSurvey(newValue: any, clearData: boolean): void;
+    protected setDefaultValue(): void;
+    private addIntoInvisibleOldValues;
+    protected hasValueToClearIncorrectValues(): boolean;
+    protected setNewValue(newValue: any): void;
+    protected getIsMultipleValue(): boolean;
+    protected getCommentFromValue(newValue: any): string;
+    getStoreOthersAsComment(): boolean;
+    protected setOtherValueIntoValue(newValue: any): any;
+    private getFirstUnknownIndex;
+    protected removeNoneItemsValues(value: Array<any>, newValue: Array<any>): void;
+    private noneIndexInArray;
+    protected canUseFilteredChoices(): boolean;
+    protected supportSelectAll(): boolean;
+    protected addNonChoicesItems(dict: Array<{
+        index: number;
+        item: ItemValue;
+    }>, isAddAll: boolean): void;
+    protected isBuiltInChoice(item: ItemValue): boolean;
+    isItemInList(item: ItemValue): boolean;
+    protected getDisplayValueEmpty(): string;
+    protected getDisplayValueCore(keysAsText: boolean, value: any): any;
+    protected clearIncorrectValuesCore(): void;
+    protected clearDisabledValuesCore(): void;
+    private isChangingValueOnClearIncorrect;
+    private clearIncorrectAndDisabledValues;
+    private restoreValuesFromInvisible;
+    getConditionJson(operator?: string, path?: string): any;
+    isAnswerCorrect(): boolean;
+    protected setDefaultValueWithOthers(): void;
+    protected getIsItemValue(val: any, item: ItemValue): boolean;
+    protected valueFromData(val: any): any;
+    protected rendredValueFromData(val: any): any;
+    protected rendredValueToData(val: any): any;
+    protected convertValueFromObject(val: any): any;
+    protected convertValueToObject(val: any): any;
+    protected renderedValueFromDataCore(val: any): any;
+    protected rendredValueToDataCore(val: any): any;
+    protected selectOtherValueFromComment(val: boolean): void;
+    get checkBoxSvgPath(): string;
+    get isNewA11yStructure(): boolean;
+    get a11y_input_ariaRole(): string;
+    get a11y_input_ariaRequired(): "true" | "false";
+}

package/typings/src/question_comment.d.ts

@@ -0,0 +1,59 @@
+import { QuestionTextBase } from "./question_textbase";
+import { TextAreaModel } from "./utils/text-area";
+/**
+ * A class that describes the Long Text question type.
+ *
+ * [View Demo](https://surveyjs.io/form-library/examples/questiontype-comment/ (linkStyle))
+ */
+export declare class QuestionCommentModel extends QuestionTextBase {
+    private element;
+    private textAreaModelValue;
+    constructor(name: string);
+    get textAreaModel(): TextAreaModel;
+    private getTextAreaOptions;
+    /**
+     * Specifies the visible height of the comment area, measured in lines.
+     *
+     * The value of this property is passed on to the `rows` attribute of the underlying `<textarea>` element.
+     */
+    get rows(): number;
+    set rows(val: number);
+    get cols(): number;
+    set cols(val: number);
+    /**
+     * Specifies whether the question allows line breaks.
+     *
+     * When this property is enabled, a user can press Enter to insert line breaks. They are saved as `\n` in survey results. The Comment question also recognizes and interprets the `\n` sequence as a line break when you set the question `value` in code.
+     */
+    get acceptCarriageReturn(): boolean;
+    set acceptCarriageReturn(val: boolean);
+    /**
+     * Specifies whether the comment area automatically increases its height to accomodate multi-line content.
+     *
+     * Default value: `false` (inherited from `SurveyModel`'s [`autoGrowComment`](https://surveyjs.io/form-library/documentation/surveymodel#autoGrowComment) property)
+     * @see allowResize
+     */
+    get autoGrow(): boolean | undefined;
+    set autoGrow(val: boolean | undefined);
+    get renderedAutoGrow(): boolean;
+    /**
+     * Specifies whether to display a resize handle for the comment area.
+     *
+     * Default value: `true` (inherited from `SurveyModel`'s [`allowResizeComment`](https://surveyjs.io/form-library/documentation/surveymodel#allowResizeComment) property)
+     * @see autoGrow
+     */
+    get allowResize(): boolean | undefined;
+    set allowResize(val: boolean | undefined);
+    get renderedAllowResize(): boolean;
+    get resizeStyle(): "none" | "both";
+    getType(): string;
+    afterRenderQuestionElement(el: HTMLElement): void;
+    beforeDestroyQuestionElement(el: HTMLElement): void;
+    onInput(event: any): void;
+    protected onBlurCore(event: any): void;
+    onKeyDown(event: any): void;
+    protected setNewValue(newValue: string): any;
+    protected getValueSeparator(): string;
+    protected notifyStateChanged(prevState: string): void;
+    get className(): string;
+}