survey-creator-core 1.11.5 → 1.11.7

package/typings/toolbox.d.ts

@@ -3,38 +3,58 @@ import { SurveyCreatorModel, toolboxLocationType } from "./creator-base";
 import { SearchManagerToolbox } from "./property-grid/search-manager";
 export declare type overflowBehaviorType = "hideInMenu" | "scroll";
 /**
- * The Toolbox item description.
+ * A toolbox item configuration.
+ *
+ * `IQuestionToolboxItem` objects are used in such Toolbox API methods as [`getItemByName(name)`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#getItemByName), [`addItem(name, index)`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#addItem), [`replaceItem(name)`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#replaceItem), and others.
+ *
+ * [Toolbox Customization](https://surveyjs.io/survey-creator/documentation/toolbox-customization (linkStyle))
  */
 export interface IQuestionToolboxItem extends IAction {
     /**
-     * A unique name
+     * A toolbox item identifier.
+     *
+     * > Toolbox item names must be unique.
      */
     name: string;
     /**
-     * Icon name
+     * An icon name.
+     *
+     * [UI Icons](https://surveyjs.io/form-library/documentation/icons (linkStyle))
      */
     iconName: string;
     /**
-     * The JSON that used to create a new question/panel. The 'type' attribute is required.
+     * A JSON object used to create a new question or panel when users click this toolbox item. It must contain the `type` property.
+     *
+     * [View Toolbox Customization Demo](https://surveyjs.io/survey-creator/examples/survey-toolbox-customization/ (linkStyle))
      */
     json: any;
     /**
-     * Toolbox item title
+     * A user-friendly toolbox item title.
      */
     title: string;
     className: string;
     /**
-     * Toolbox item tooltip. It equals to title if it is empty
+     * A toolbox item tooltip.
+     *
+     * If `tooltip` is undefined, the [`title`](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem#title) property value is used instead.
      */
     tooltip?: string;
-    /**
-     * True, if an end user added this item into Toolbox from the survey.
-     */
     isCopied: boolean;
     /**
-     * Toolbox item category. If it is empty, it goes to 'General' category.
+     * A category to which this toolbox item belongs.
+     *
+     * Out-of-the-box categories include `"general"`, `"choice"`, `"text"`, `"containers"`, `"matrix"`, and `"misc"`.
+     *
+     * Default value: `"general"`
      */
     category: string;
+    /**
+     * Specifies whether users can interact with the toolbox item.
+     *
+     * Default value: `true`
+     */
+    enabled?: boolean;
+    getArea?: (el: HTMLElement) => HTMLElement;
 }
 export interface IQuestionToolbox {
     toggleCategoryState(name: string): any;
@@ -73,10 +93,26 @@ export declare class QuestionToolboxItem extends Action implements IQuestionTool
     toJSON(): IQuestionToolboxItem;
     get typeName(): string;
     get isPanel(): boolean;
+    getArea(target: HTMLElement): HTMLElement;
     hasText(text: string): boolean;
 }
 /**
- * The list of Toolbox items.
+ * An object that enables you to modify Survey Creator's Toolbox. To access this object, use the [`toolbox`](https://surveyjs.io/survey-creator/documentation/api-reference/survey-creator#toolbox) property on a Survey Creator instance:
+ *
+ * ```js
+ * const creatorOptions = { ... };
+ * const creator = new SurveyCreator.SurveyCreator(creatorOptions);
+ * creator.toolbox.settingName = "value";
+ *
+ * // In modular applications:
+ * import { SurveyCreatorModel } from "survey-creator-core";
+ *
+ * const creatorOptions = { ... };
+ * const creator = new SurveyCreatorModel(creatorOptions);
+ * creator.toolbox.settingName = "value";
+ * ```
+ *
+ * [Toolbox Customization](https://surveyjs.io/survey-creator/documentation/toolbox-customization (linkStyle))
  */
 export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToolboxItem> implements IQuestionToolbox {
     private supportedQuestions;
@@ -95,14 +131,9 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     get itemSelector(): string;
     get containerSelector(): string;
     static getQuestionDefaultSettings(questionType: string): any;
-    /**
-     * Modify this array to change the toolbox items order.
-     */
+    static getSubTypePropertyName(questionType: string): string;
     get orderedQuestions(): string[];
     set orderedQuestions(questions: string[]);
-    /**
-     * The maximum number of copied toolbox items. If an user adding copiedItemMaxCount + 1 item, the first added item will be removed.
-     */
     copiedItemMaxCount: number;
     private allowExpandMultipleCategoriesValue;
     private keepAllCategoriesExpandedValue;
@@ -113,11 +144,14 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
      * Contains toolbox categories and allows you to modify them.
      *
      * [View Demo](https://surveyjs.io/Examples/Survey-Creator?id=toolboxcategories (linkStyle))
+     * @see defineCategories
+     * @see showCategoryTitles
      */
     categories: Array<QuestionToolboxCategory>;
     /**
-     * Set and get and active category. This property doesn't work if allowExpandMultipleCategories is true. Its default value is empty.
-     * @see allowExpandMultipleCategories
+     * Gets or sets the currently expanded category. Applies only if [`allowExpandMultipleCategories`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#allowExpandMultipleCategories) and [`keepAllCategoriesExpanded`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#keepAllCategoriesExpanded) are `false` and [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) is `true`.
+     *
+     * Default value: `""`
      * @see expandCategory
      * @see collapseCategory
      */
@@ -126,27 +160,35 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     canCollapseCategories: boolean;
     updateResponsiveness(isCompact: boolean, overflowBehavior: overflowBehaviorType): void;
     /**
-     * Indicates whether the toolbox is currently in compact mode.
-     * @see forceCompact
+     * Indicates whether the Toolbox is currently in [compact mode](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#forceCompact).
      */
     isCompact: boolean;
     isFocused: boolean;
     /**
-     * Indicates whether the toolbox is currently can have scrollbar.
+     * Specifies how the Toolbox behaves when it contains more items than can fit on the screen.
+     *
+     * Possible values:
+     *
+     * - `"scroll"` (default) - Enables scrolling to help users reach the items that do not fit on the screen.
+     * - `"hideInMenu"` - Hides the overflow items in a three-dot menu.
      */
     overflowBehavior: overflowBehaviorType;
     /**
-     * Specifies whether the toolbox should be in compact or full mode.
-     * Accepts the following values:
+     * Specifies whether the Toolbox should be in compact or full mode.
+     *
+     * Possible values:
+     *
      * - `true` - Toolbox is always in compact mode.
      * - `false` - Toolbox is always in full mode.
-     * - `undefined` - Toolbox switches between the full and compact modes automatically based on available width.
+     * - `undefined` (default) - Toolbox switches between the full and compact modes automatically based on available width.
+     *
+     * [View Toolbox Customization Demo](https://surveyjs.io/survey-creator/examples/survey-toolbox-customization/ (linkStyle))
      * @see isCompact
      */
     forceCompact: boolean;
     private categoriesTitles;
     /**
-     * Specifies whether to display a search field that allows users to find question and panel types within the toolbox.
+     * Specifies whether to display a search field that allows users to find question and panel types within the Toolbox.
      *
      * Default value: `true`
      */
@@ -169,88 +211,87 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     searchItem: IAction;
     get classNames(): string;
     setLocation(toolboxLocation: toolboxLocationType): void;
-    /**
-     * The Array of Toolbox items as Text JSON.
-     */
     get jsonText(): string;
     set jsonText(value: string);
-    /**
-     * The Array of copied Toolbox items as Text JSON.
-     */
     get copiedJsonText(): string;
     set copiedJsonText(value: string);
     /**
-     * The Array of Toolbox items.
+     * An array of toolbox items.
+     * @see getItemByName
+     * @see addItem
+     * @see removeItem
      */
     get items(): Array<QuestionToolboxItem>;
     get itemNames(): Array<string>;
-    /**
-     * The Array of copied Toolbox items
-     */
     get copiedItems(): Array<QuestionToolboxItem>;
-    /**
-     * Add toolbox items into the Toolbox
-     * @param items the list of new items
-     * @param clearAll set it to true to clear all previous items.
-     */
     addItems(items: Array<IQuestionToolboxItem>, clearAll?: boolean): void;
-    /**
-     * Add a copied Question into Toolbox
-     * @param question a copied Survey.Question
-     * @param options a json object that allows you to override question properties. Attributes are: name, title, tooltip, isCopied, iconName, json and category.
-     */
     addCopiedItem(question: Question, options?: any): void;
+    private getActionByItem;
+    private addSubTypes;
     /**
-     * Add a toolbox item
-     * @param item the toolbox item description
-     * @param index the toolbox index to place the item, the item is added to the end if index not passed
-     * @see IQuestionToolboxItem
+     * Adds a new item to the Toolbox.
+     * @param item A [toolbox item configuration](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem).
+     * @param index *(Optional)* A zero-based index at which to insert the item. If you do not specify this parameter, the item is added to the end.
+     * @see removeItem
+     * @see replaceItem
+     * @see items
      */
-    private getActionByItem;
     addItem(item: IQuestionToolboxItem, index?: number): void;
     private correctItem;
     private get dragDropHelper();
     /**
-     * Add a new toolbox item, add delete the old item with the same name
-     * @param item the toolbox item description
-     * @see IQuestionToolboxItem
+     * Adds a new toolbox item and deletes an existing item with the same name (if there is any).
+     * @param item A [toolbox item configuration](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem).
+     * @see addItem
      */
     replaceItem(item: IQuestionToolboxItem): boolean;
     /**
-     * Remove a toolbox item by its name
-     * @param name toolbox item name
-     * @see IQuestionToolboxItem
+     * Removes a [toolbox item](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem) with a specified name.
+     * @param name A toolbox item's [`name`](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem#name).
+     * @returns `true` if the item is successfully deleted or `false` otherwise.
+     * @see clearItems
+     * @see addItem
+     * @see items
      */
     removeItem(name: string): boolean;
     /**
-     * Remove all toolbox items.
+     * Removes all items from the Toolbox.
+     * @see removeItem
+     * @see addItem
+     * @see items
      */
     clearItems(): void;
-    /**
-     * Remove all copied toolbox items.
-     */
     clearCopiedItems(): void;
     /**
-     * Returns toolbox item by its name. Returns null if there is no toolbox item with this name
-     * @param name
+     * Returns a [toolbox item](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem) with a specified name.
+     * @param name A toolbox item's [`name`](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem#name).
+     * @returns A toolbox item or `null` if a toolbox item with the specified name isn't found.
      */
     getItemByName(name: string): IQuestionToolboxItem;
     /**
-     * Set it to true, to allow end-user to expand more than one category. There will no active category in this case
-     * @see activeCategory
+     * Specifies whether more than one category can be in the expanded state at a time. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) is `true`.
+     *
+     * If this property is `false`, the currently expanded category collapses when a user expands another category.
+     *
+     * Default value: `false`
+     * @see keepAllCategoriesExpanded
      */
     get allowExpandMultipleCategories(): boolean;
     set allowExpandMultipleCategories(val: boolean);
     /**
-     * Set it to true to expand all categories and hide expand/collapse category buttons
+     * Specifies whether to expand all categories without the capability to collapse any of them. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) is `true`.
+     * @see allowExpandMultipleCategories
      */
     get keepAllCategoriesExpanded(): boolean;
     set keepAllCategoriesExpanded(val: boolean);
     /**
      * Specifies whether to display category titles in the Toolbox.
      *
-     * If you disable this property, the Toolbox hides the titles but continues to display horizontal lines that divide categories. To remove these lines as well, call the `removeCategories()` method.
-     * @see removeCategories
+     * Default value: `false`
+     *
+     * If this property is disabled, the Toolbox hides the titles but continues to display horizontal lines that divide categories. To remove these lines as well, call the [`removeCategories()`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#removeCategories) method.
+     * @see allowExpandMultipleCategories
+     * @see keepAllCategoriesExpanded
      */
     get showCategoryTitles(): boolean;
     set showCategoryTitles(val: boolean);
@@ -258,16 +299,18 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     private updateActionTitle;
     private updateCategoriesState;
     /**
-     * Change the category of the toolbox item
-     * @param name the toolbox item name
-     * @param category new category name
+     * Changes the category of a toolbox item.
+     * @param itemName A toolbox item's [`name`](https://surveyjs.io/survey-creator/documentation/api-reference/iquestiontoolboxitem#name).
+     * @param categoryName A new category name. Out-of-the-box category names include `"general"`, `"choice"`, `"text"`, `"containers"`, `"matrix"`, and `"misc"`.
+     * @see defineCategories
      */
-    changeCategory(name: string, category: string): void;
+    changeCategory(itemName: string, categoryName: string): void;
     /**
-     * Change categories for several toolbox items.
-     * @param changedItems the array of objects {name: "your toolbox item name", category: "new category name"}
+     * Changes the categories of multiple toolbox items.
+     * @param items An array of objects with the following structure: `{ name: "toolboxItemName", category: "newCategoryName" }`.
+     * @see defineCategories
      */
-    changeCategories(changedItems: Array<any>): void;
+    changeCategories(items: Array<any>): void;
     /**
      * Defines toolbox categories from scratch.
      *
@@ -298,31 +341,32 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
      */
     defineCategories(categories: Array<IToolboxCategoryDefinition>, displayMisc?: boolean): void;
     /**
-     * Removes categories from the Toolbox.
+     * Removes all categories from the Toolbox.
      */
     removeCategories(): void;
     toggleCategoryState(categoryName: string): void;
     /**
-     * Expand a category by its name. If allowExpandMultipleCategories is false (default value), all other categories become collapsed
-     * @param categoryName the category name
-     * @see allowExpandMultipleCategories
+     * Expands a category with a specified name. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) is `true`.
+     *
+     * If [`allowExpandMultipleCategories`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#allowExpandMultipleCategories) is `false`, all other categories become collapsed.
+     * @param categoryName A category name. Out-of-the-box category names include `"general"`, `"choice"`, `"text"`, `"containers"`, `"matrix"`, and `"misc"`.
      * @see collapseCategory
      */
     expandCategory(categoryName: string): void;
     /**
-     * Collapse a category by its name. If allowExpandMultipleCategories is false (default value) this function does nothing
-     * @param categoryName the category name
-     * @see allowExpandMultipleCategories
+     * Collapses a category with a specified name. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) and [`allowExpandMultipleCategories`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#allowExpandMultipleCategories) are `true`.
+     * @param categoryName A category name. Out-of-the-box category names include `"general"`, `"choice"`, `"text"`, `"containers"`, `"matrix"`, and `"misc"`.
+     * @see expandCategory
      */
     collapseCategory(categoryName: string): void;
     /**
-     * Expand all categories. If allowExpandMultipleCategories is false (default value) this function does nothing
-     * @see allowExpandMultipleCategories
+     * Expands all categories. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) and [`allowExpandMultipleCategories`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#allowExpandMultipleCategories) are `true`.
+     * @see collapseAllCategories
      */
     expandAllCategories(): void;
     /**
-     * Collapse all categories. If allowExpandMultipleCategories is false (default value) this function does nothing
-     * @see allowExpandMultipleCategories
+     * Collapses all categories. Applies only if [`showCategoryTitles`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#showCategoryTitles) and [`allowExpandMultipleCategories`](https://surveyjs.io/survey-creator/documentation/api-reference/questiontoolbox#allowExpandMultipleCategories) are `true`.
+     * @see expandAllCategories
      */
     collapseAllCategories(): void;
     private expandCollapseAllCategories;
@@ -341,8 +385,11 @@ export declare class QuestionToolbox extends AdaptiveActionContainer<QuestionToo
     private registerCustomWidgets;
     private registerComponentQuestions;
     private getComponentItems;
+    private getItemClassNames;
     private addItemFromJSON;
     private getQuestionJSON;
     private isHiddenCustomWidget;
     private getQuestionTypes;
+    hideAllInnerPopups(): void;
+    onScroll(model: any, event: any): void;
 }