Documentation Docs
Documentation Docs

IQuestionToolboxItem

A toolbox item configuration.

IQuestionToolboxItem objects are used in such Toolbox API methods as getItemByName(name), addItem(name, index), replaceItem(name), and others.

Toolbox Customization

Inherited from the following class(es):

action property

A function that is executed when users click the action item.

View Demo

Type:
(context?: any) => void readonly
Implemented in:
IAction
active property

Specifies whether the action item is active.

Use this property as a flag to specify different action item appearances in different states.

Type:
boolean readonly
Implemented in:
IAction
See also:
enabled * , visible
category property

A category to which this toolbox item belongs.

Out-of-the-box categories include "general", "choice", "text", "containers", "matrix", and "misc".

Default value: "general"

Type:
string readonly
Implemented in:
IQuestionToolboxItem
component property

Specifies the name of a component used to render the action item.

Type:
string readonly
Implemented in:
IAction
css property

One or several CSS classes that you want to apply to the outer <div> element.

In the markup, an action item is rendered as an <input> wrapped in a <div>. The css property applies classes to the <div>.

To apply several classes, separate them with a space character: "myclass1 myclass2".

View Demo

Type:
string readonly
Implemented in:
IAction
See also:
innerCss
data property

The action item's data object. Use it to pass required data to a custom template or component.

Type:
any readonly
Implemented in:
IAction
disableShrink property

Set this property to true if you want the item's title to be always visible. If you set it to false, the title hides when the screen space is limited, and the item displays only the icon.

Type:
boolean readonly
Implemented in:
IAction
See also:
title * , iconName
disableTabStop property

Set this property to true if you want to disable keyboard navigation for the action item (sets the tabIndex attribute to -1).

Type:
boolean readonly
Implemented in:
IAction
enabled property

Specifies whether users can interact with the toolbox item.

Default value: true

Type:
boolean readonly
Implemented in:
IQuestionToolboxItem
iconName property

An icon name.

UI Icons

Type:
string readonly
Implemented in:
IQuestionToolboxItem
iconSize property

The action item's icon size in pixels.

Type:
string | number readonly
Implemented in:
IAction
See also:
iconName
id property

A unique action item identifier.

View Demo

Type:
string readonly
Implemented in:
IAction
innerCss property

One or several CSS classes that you want to apply to the inner <input> element.

In the markup, an action item is rendered as an <input> wrapped in a <div>. The innerCss property applies classes to the <input>.

To apply several classes, separate them with a space character: "myclass1 myclass2".

View Demo

Type:
string readonly
Implemented in:
IAction
See also:
css
json property

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

Type:
any readonly
Implemented in:
IQuestionToolboxItem
location property

The action item's location in a matrix question's row.

The following values are available:

  • "start" - The action item is located at the beginning of the row.
  • "end" - The action is located at the end of the row.
Type:
string readonly
Implemented in:
IAction
name property

A toolbox item identifier.

Toolbox item names must be unique.

Type:
string readonly
Implemented in:
IQuestionToolboxItem
showTitle property

Specifies the visibility of the action item's title.

Type:
boolean readonly
Implemented in:
IAction
See also:
title * , disableShrink
template property

Specifies the name of a template used to render the action item.

Type:
string readonly
Implemented in:
IAction
See also:
component
title property

A user-friendly toolbox item title.

Type:
string readonly
Implemented in:
IQuestionToolboxItem
tooltip property

A toolbox item tooltip.

If tooltip is undefined, the title property value is used instead.

Type:
string readonly
Implemented in:
IQuestionToolboxItem
visible property

Specifies the action item's visibility.

Type:
boolean | ComputedUpdater<boolean> readonly
Implemented in:
IAction
See also:
enabled * , active
visibleIndex property

A number that specifies the action's position relative to other actions.

View Demo

Type:
number readonly
Implemented in:
IAction

Copyright © 2024 Devsoft Baltic OÜ. All rights reserved.

Your cookie settings

We use cookies on our site to make your browsing experience more convenient and personal. In some cases, they are essential to making the site work properly. By clicking "Accept All", you consent to the use of all cookies in accordance with our Terms of Use & Privacy Statement. However, you may visit "Cookie settings" to provide a controlled consent.

Your renewal subscription expires soon.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.

Your renewal subscription has expired.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.