Class kartik\tree\TreeView

Whether to load the bootstrap plugin asset

The icons list show type set under iconEditSettings

The tree management module.

Configuration of icons for Glyphicons and Font Awesome. The 3rd array value is optional and includes any additional css class to be added.

The icons list

Session identifier for the selected node id

The queried tree nodes

Animation duration (ms) for fading in and out alerts that are displayed during manipulation of nodes.

Allow new root creation.

Whether to auto load the bootstrap plugin assets if showTooltips is true OR if TreeViewInput::asDropdown is true. Defaults to true.

The breadcrumbs settings for displaying the current node title based on parent hierarchy in the node details form/view (starting from the current node). The following settings are supported:

• depth: integer, the depth to dig into the parent nodes for fetching the breadcrumb titles. If set to null or 0 this will fetch breadcrumbs till infinite parent depth. Defaults to ``.
• glue: string, the separator to glue each node name within the breadcrumbs. Defaults to › .
• activeCss: string, the CSS class to be applied to the current node name in the breadcrumbs. Defaults to kv-crumb-active.
• untitled: string, the title to be displayed if this is a new untitled node record. Defaults to Untitled.

The HTML attributes for the button groups within the toolbar.

The default HTML attributes for the toolbar button icons

The default HTML attributes for the toolbar buttons

Cache settings for displaying the detail form content for each tree node via ajax. The following options are supported:

• enableCache: boolean, defaults to true.
• cacheTimeout: integer, the cache timeout in milliseconds. Defaults to 300000 (or 5 minutes).

Whether to auto select all children when a parent node is selected. This property will be applied only if $multiple property is set to true.

The HTML attributes for the indicator which will represent a checked checkbox. The following special options are recognized:

• label: string, the label for the indicator. If not set will default to $defaultCheckedNodeIcon.

The HTML attributes for the child node icon.

The configuration of various client alert messages

The HTML attributes for the indicator for collapsing a node. The following special options are recognized:

• label: string, the label for the indicator. If not set will default to $defaultCollapseNodeIcon

Default icon for a checked node which will represent a checked checkbox. If not set will default to:

• <i class="fas fa-check-square"></i> if $bsVersion is not 3.x or $fontAwesome is true.
• <i class="glyphicon glyphicon-checked"></i> if $bsVersion is 3.x and $fontAwesome is false .

The icon markup for the child node if no icon was setup in the database.

The default icon for collapsing the node. If not set will default to:

• <i class="fas fa-minus-square"></i> if $bsVersion is not 3.x or $fontAwesome is true.
• <i class="glyphicon glyphicon-collapse-down"></i> if $bsVersion is 3.x and $fontAwesome is false .

The default icon for expanding the node. If not set will default to:

• <i class="fas fa-plus-square"></i> if $bsVersion is not 3.x or $fontAwesome is true.
• <i class="glyphicon glyphicon-expand"></i> if $bsVersion is 3.x and $fontAwesome is false .

The icon markup for the collapsed parent node if no icon was setup in the database.

The icon markup for the opened parent node if no icon was setup in the database. If not set will default to:

• <i class="fas fa-plus-square"></i> if $bsVersion is not 3.x or $fontAwesome is true.
• <i class="glyphicon glyphicon-expand"></i> if $bsVersion is 3.x and $fontAwesome is false .

The HTML attributes for an unchecked node which will represent an unchecked checkbox. If not set will default to:

• <i class="fas fa-square"></i> if $bsVersion is not 3.x or $fontAwesome is true.
• <i class="glyphicon glyphicon-unchecked"></i> if $bsVersion is 3.x and $fontAwesome is false .

The HTML attributes for the detail form container which will display the details of the selected node

The initial value (key) to be selected in the tree and displayed in the detail form. Defaults to 1.

Message shown on tree initialization when either the entire tree is empty or no node is found for the selected $displayValue.

HTML attributes for the empty node message displayed.

The HTML attributes for the indicator for expanding a node. The following special options are recognized:

• label: string, the label for the indicator. If not set will default to $defaultExpandNodeIcon.

Whether to use font awesome icons. Defaults to false.

The HTML attributes for the tree footer container.

The template for rendering the footer. The following tokens will be automatically parsed and replaced:

• {toolbar}: will be replaced with the the markup for the button actions toolbar.

The HTML attributes for the tree header container

The template for rendering the header

The HTML attributes for the heading. The following additional option is recognized: label: string, the label to display for the heading Note that when $topRootAsHeading is set to true, then $headingOptions will be entirely skipped and $rootOptions and $rootNodeToggleOptions and $rootNodeCheckboxOptions will be used to render the heading.

The CSS class to hide HTML elements on the page. If not set this will default to one of the following depending on Bootstrap Version:

• if $bsVersion = 3, then this will default to hidden_xs
• if $bsVersion = 4, then this will default to d-none

Whether to hide the topmost root node container

Whether to hide unmatched search items when searching

Settings to edit the icon. The following settings are recognized:

• show: string, whether to display the icons selection as a list. If set to 'text', the icon will be shown as a plain text input along with icon type. If set to 'list', a list will be shown. If set to 'none', then no icon settings will be shown for editing.
• type: string, the iconTypeAttribute value, defaults to TreeView::ICON_CSS. Should be one of ICON_CSS or ICON_RAW.
• listData: array, the configuration of the icon list data to be shown for selection. This is mandatory if you set show to 'list'. You must set the data as $key => $value format. The list will be parsed to display the icon list and will depend on the type.
  • If type is set to ICON_CSS, then $key will be the icon suffix name and $value will be the description for the icon. The icon markup will be automatically parsed then based on whether its a glyphicon or font-awesome when fontAwesome property is true. For example:

         [
             'folder-close' => 'Folder',
             'file' => 'File',
             'tag' => 'Tag'
         ]
     ```
    

  • If type is set to ICON_RAW $key is the icon markup to be stored and $value is the output markup to be displayed as a selection in the list. For example:

         [
             '<img src="images/folder.jpg">' => 'Folder',
             '<img src="images/file.jpg">' => 'File',
             '<img src="images/tag.jpg">' => 'Tag',
         ]
    

The icon prefix

Whether the tree is to be allowed for editing in admin mode. This will display all nodes and will allow to modify internal tree node flags. Defaults to false.

Configuration settings for the Krajee dialog widget that will be used to render alerts and confirmation dialog prompts

See also http://demos.krajee.com/dialog.

The main template for rendering the tree view navigation widget and the node detail view form. The following tokens will be automatically parsed and replaced:

• {wrapper}: will be replaced with the output markup parsed from $wrapperTemplate
• {detail}: will be replaced with the the markup for the detail form to edit/view the selected tree node

Whether to allow selection of multiple nodes via checkboxes.

The actions for managing, deleting, and moving the tree nodes. The keys must be one of 'manage', 'save', 'remove', and 'move'. Defaults to: ` [

'save' => Url::to(['/treemanager/node/save']),
'manage' => Url::to(['/treemanager/node/manage']),
'remove' => Url::to(['/treemanager/node/remove']),
'move' => Url::to(['/treemanager/node/move']),

] `

The list of additional view files that will be used to append content at various sections in the $nodeView form.

The HTML attributes for the node checkbox indicator for all items in the tree

The HTML attributes for the node detail form.

The value to customize a tree node's label.

• if set as an array, the array key must be the node key value (i.e. keyAttribute) and array value will be the new node label you want to assign.
• if set as a Closure, the callback function must be of the signature function($node){}, where $node will represent each tree node's model object instance. If a value is not traceable through above methods, the database tree node name will be displayed (as parsed via nameAttribute).

The title label to display for the tree node in the validation client messages. Defaults to node.

The title label to display for plural tree nodes in the validation client messages. Defaults to nodes.

The HTML attributes for the node toggle indicator for each parent item in the tree

The view file that will render the form for editing the node.

The markup for the submit and reset button labels in the node view form

Any additional parameters to be sent or any parameters to override within the $nodeView.

The HTML attributes for the input that will store the selected nodes for the widget

The HTML attributes for the parent node icon.

The query that will be used as the data source for the TreeView. For example: Tree::find()->addOrderBy('root, lft')

The HTML attributes for the root node's checkbox indicator

The HTML attributes for the root node's toggle indicator

The HTML attributes for the topmost root node container. The following special options are recognized:

• label: string, the label for the topmost root node (this is not HTML encoded). Defaults to 'Root'. Set this to empty to not display a label.

The HTML attributes for the search clear indicator

The HTML attributes for the search container

The HTML attributes for the search input

Whether to show a checkbox before each tree node label to allow multiple node selection.

Whether to show the form action buttons in the node details form/view.

Whether to show the key attribute (ID) in the node details form/view.

Whether to show inactive nodes

Whether to show the name attribute (name) in the node details form/view.

Show toolbar button tooltips (using bootstrap tooltip plugin). The BootstrapPluginAsset will automatically be loaded if this is set to true.

Whether the record will be soft deleted, when remove button is clicked. Defaults to true. The following actions are possible:

• if true, this will just set the active property of node to false.
• if false, it will attempt to hard delete the whole record.

The settings for the tree management toolbar

The HTML attributes for the toolbar.

The sorting order of the buttons in the toolbar. Each item in this array should be one of the button keys as set in the toolbar array keys (except for BTN_SEPARATOR which will be parsed as is). Note that, if this is set, then only the button keys configured here will be displayed (irrespective of the toolbar setup). Hence one must ensure that all the toolbar button keys are set here to display all the toolbar buttons.

Whether to show topmost root node as heading. In this case the $rootOptions will be used to format the topmost root node and $headingOptions will be skipped. The CSS class kv-root-heading will be appended to rootOptions when this is set to true.

The HTML attributes for the tree selector container

The HTML attributes for the wrapper container for the tree header, body, and footer.

The HTML attributes for the indicator which will represent an unchecked checkbox. The following special options are recognized:

• label: string, the label for the indicator. If not set will default to $defaultUncheckedNodeIcon

The comma separated initial value (keys) to be checked and selected in the tree

The wrapper template for rendering the tree view navigation widget. The following tokens will be automatically parsed and replaced:

• {header}: will be replaced with the output markup parsed from $headerTemplate.
• {tree}: will be replaced with the markup for the tree hierarchy.
• {footer}: will be replaced with the output markup parsed from $footerTemplate.