├── LICENSE.md ├── README.md ├── TreeFilterInput.php ├── TreeFilterInputAsset.php ├── TreeView.php ├── TreeViewAsset.php ├── TreeViewBowerAsset.php ├── assets ├── TreeFilterInput.css ├── TreeFilterInput.js ├── TreeFilterInput.less ├── TreeFilterInput.min.js ├── TreeView.css └── TreeView.less ├── composer.json └── examples ├── example-pjax-navigation.php └── example-simple.php /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 Yuriy Mamaev 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bootstrap Tree View widget wrapper for yii2 2 | 3 | [Widget page](https://github.com/patternfly/patternfly-bootstrap-treeview) 4 | 5 | ![Bootstrap Tree View Default](https://raw.github.com/jonmiles/bootstrap-treeview/master/screenshot/default.PNG) 6 | 7 | ## Installation 8 | 9 | The preferred way to install this extension is through [composer](http://getcomposer.org/download/). 10 | 11 | ### Install 12 | 13 | Either run 14 | 15 | ``` 16 | $ php composer.phar require execut/yii2-widget-bootstraptreeview "dev-master" 17 | ``` 18 | 19 | or add 20 | 21 | ``` 22 | "execut/yii2-widget-bootstraptreeview": "dev-master" 23 | ``` 24 | 25 | to the ```require``` section of your `composer.json` file. 26 | 27 | ## Simple example 28 | ```php 29 | use execut\widget\TreeView; 30 | use yii\web\JsExpression; 31 | 32 | $data = [ 33 | [ 34 | 'text' => 'Parent 1', 35 | 'nodes' => [ 36 | [ 37 | 'text' => 'Child 1', 38 | 'nodes' => [ 39 | [ 40 | 'text' => 'Grandchild 1' 41 | ], 42 | [ 43 | 'text' => 'Grandchild 2' 44 | ] 45 | ] 46 | ], 47 | [ 48 | 'text' => 'Child 2', 49 | ] 50 | ], 51 | ], 52 | [ 53 | 'text' => 'Parent 2', 54 | ] 55 | ]; 56 | 57 | $onSelect = new JsExpression(<< $data, 65 | 'size' => TreeView::SIZE_SMALL, 66 | 'header' => 'Categories', 67 | 'searchOptions' => [ 68 | 'inputOptions' => [ 69 | 'placeholder' => 'Search category...' 70 | ], 71 | 'clearButtonOptions' => [ 72 | 'title' => 'Clear', 73 | ], 74 | ], 75 | 'clientOptions' => [ 76 | 'onNodeSelected' => $onSelect, 77 | 'selectedBackColor' => 'rgb(40, 153, 57)', 78 | 'borderColor' => '#fff', 79 | ], 80 | ]); 81 | 82 | 83 | echo $groupsContent; 84 | ``` 85 | 86 | ## Pjax navigation example 87 | ```php 88 | use yii\widgets\Pjax; 89 | use yii\web\JsExpression; 90 | use execut\widget\TreeView; 91 | use yii\helpers\Url; 92 | Pjax::begin([ 93 | 'id' => 'pjax-container', 94 | ]); 95 | 96 | echo \yii::$app->request->get('page'); 97 | 98 | Pjax::end(); 99 | 100 | $onSelect = new JsExpression(<< 'Parent 1', 123 | 'href' => Url::to(['', 'page' => 'parent1']), 124 | 'nodes' => [ 125 | [ 126 | 'text' => 'Child 1', 127 | 'href' => Url::to(['', 'page' => 'child1']), 128 | 'nodes' => [ 129 | [ 130 | 'text' => 'Grandchild 1', 131 | 'href' => Url::to(['', 'page' => 'grandchild1']) 132 | ], 133 | [ 134 | 'text' => 'Grandchild 2', 135 | 'href' => Url::to(['', 'page' => 'grandchild2']) 136 | ] 137 | ] 138 | ], 139 | ], 140 | ], 141 | ]; 142 | 143 | echo TreeView::widget([ 144 | 'data' => $items, 145 | 'size' => TreeView::SIZE_SMALL, 146 | 'clientOptions' => [ 147 | 'onNodeSelected' => $onSelect, 148 | ], 149 | ]); 150 | ``` 151 | 152 | ## Changing widget template 153 | You can redefine widget template via template option: 154 | ```php 155 | echo TreeView::widget([ 156 | ... 157 | 'template => TreeView::TEMPLATE_SIMPLE, 158 | //'template => TreeView::TEMPLATE_ADVANCED //by default 159 | ... 160 | ]); 161 | ``` 162 | Supported template parts: 163 | 164 | Key|Description 165 | ---|--- 166 | {header} | 'header' configuration widget param 167 | {search} | Search input 168 | {tree} | Bootstrap TreeView widget content 169 | 170 | ## License 171 | 172 | **yii2-widget-bootstraptreeview** is released under the Apache License Version 2.0. See the bundled `LICENSE.md` for details. 173 | -------------------------------------------------------------------------------- /TreeFilterInput.php: -------------------------------------------------------------------------------- 1 | clientOptions['treeViewId'] = $this->treeViewId; 36 | $this->registerWidget(); 37 | \yii\helpers\Html::addCssClass($this->options, 'execut-tree-filter-input'); 38 | $inputOptions = $this->inputOptions; 39 | Html::addCssClass($inputOptions, 'form-control'); 40 | $inputOptions['autocomplete'] = 'off'; 41 | $clearButtonOptions = ArrayHelper::merge([ 42 | 'class' => 'close glyphicon glyphicon-search', 43 | 'title' => 'Clear search results', 44 | ], $this->clearButtonOptions); 45 | 46 | echo $this->_renderContainer(Html::input('text', 'search', null, $inputOptions) . Html::tag('span', '', $clearButtonOptions)); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /TreeFilterInputAsset.php: -------------------------------------------------------------------------------- 1 | 20 |
21 |
22 |
{header}
23 |
24 |
25 | {search} 26 |
27 |
28 |
29 |
30 | {tree} 31 |
32 |
33 | '; 34 | const TEMPLATE_SIMPLE = '{tree}'; 35 | 36 | /** 37 | * @var string Widget size 38 | */ 39 | public $size = TreeView::SIZE_NORMAL; 40 | 41 | /** 42 | * @var array Items list for widget 43 | */ 44 | public $data = []; 45 | 46 | /** 47 | * Main container html options 48 | * 49 | * @var array 50 | */ 51 | public $containerOptions = []; 52 | 53 | /** 54 | * Searvh widget options 55 | * 56 | * @var string 57 | */ 58 | public $searchOptions = []; 59 | 60 | /** 61 | * Widget header 62 | * 63 | * @var string 64 | */ 65 | public $header = 'Select from tree'; 66 | 67 | /** 68 | * Template for render widget 69 | * 70 | * @var string 71 | */ 72 | public $template = self::TEMPLATE_ADVANCED; 73 | 74 | /** 75 | * Run widget 76 | */ 77 | public function run() { 78 | if ($this->size !== self::SIZE_NORMAL) { 79 | Html::addCssClass($this->options, $this->size); 80 | } 81 | 82 | if (!empty($this->options['id']) && $this->options['id'] !== $this->id) { 83 | throw new Exception('Set id directly to the widget via id config key instead redefine widget config options key'); 84 | } 85 | 86 | if (strpos($this->template, '{tree}') === false) { 87 | throw new Exception('{tree} not found in widget template'); 88 | } 89 | 90 | $parts = [ 91 | '{tree}' => Html::tag('div', '', $this->options), 92 | '{header}' => $this->header, 93 | ]; 94 | 95 | if (strpos($this->template, '{search}') !== false) { 96 | $parts['{search}'] = $this->renderSearchWidget(); 97 | } 98 | 99 | echo Html::tag('div', strtr($this->template, $parts), $this->containerOptions); 100 | 101 | $this->clientOptions['data'] = $this->data; 102 | 103 | $this->registerWidget('treeview'); 104 | } 105 | 106 | protected function renderSearchWidget() { 107 | $options = $this->searchOptions; 108 | $options['treeViewId'] = $this->id; 109 | if (empty($options['inputOptions'])) { 110 | $options['inputOptions'] = []; 111 | } 112 | 113 | if (empty($options['inputOptions']['placeholder'])) { 114 | $options['inputOptions']['placeholder'] = 'Search...'; 115 | } 116 | 117 | return TreeFilterInput::widget($options); 118 | } 119 | } -------------------------------------------------------------------------------- /TreeViewAsset.php: -------------------------------------------------------------------------------- 1 | 'pjax-container', 8 | ]); 9 | 10 | echo \yii::$app->request->get('page'); 11 | 12 | Pjax::end(); 13 | 14 | $onSelect = new JsExpression(<< 'Parent 1', 37 | 'href' => Url::to(['', 'page' => 'parent1']), 38 | 'nodes' => [ 39 | [ 40 | 'text' => 'Child 1', 41 | 'href' => Url::to(['', 'page' => 'child1']), 42 | 'nodes' => [ 43 | [ 44 | 'text' => 'Grandchild 1', 45 | 'href' => Url::to(['', 'page' => 'grandchild1']) 46 | ], 47 | [ 48 | 'text' => 'Grandchild 2', 49 | 'href' => Url::to(['', 'page' => 'grandchild2']) 50 | ] 51 | ] 52 | ], 53 | ], 54 | ], 55 | ]; 56 | 57 | echo TreeView::widget([ 58 | 'data' => $items, 59 | 'size' => TreeView::SIZE_SMALL, 60 | 'clientOptions' => [ 61 | 'onNodeSelected' => $onSelect, 62 | ], 63 | ]); -------------------------------------------------------------------------------- /examples/example-simple.php: -------------------------------------------------------------------------------- 1 | 'Parent 1', 8 | 'nodes' => [ 9 | [ 10 | 'text' => 'Child 1', 11 | 'nodes' => [ 12 | [ 13 | 'text' => 'Grandchild 1' 14 | ], 15 | [ 16 | 'text' => 'Grandchild 2' 17 | ] 18 | ] 19 | ], 20 | [ 21 | 'text' => 'Child 2', 22 | ] 23 | ], 24 | ], 25 | [ 26 | 'text' => 'Parent 2', 27 | ] 28 | ]; 29 | 30 | $onSelect = new JsExpression(<< $data, 38 | 'size' => TreeView::SIZE_SMALL, 39 | 'header' => 'Categories', 40 | 'searchOptions' => [ 41 | 'inputOptions' => [ 42 | 'placeholder' => 'Search category...' 43 | ], 44 | ], 45 | 'clientOptions' => [ 46 | 'onNodeSelected' => $onSelect, 47 | 'selectedBackColor' => 'rgb(40, 153, 57)', 48 | 'borderColor' => '#fff', 49 | ], 50 | ]); 51 | 52 | 53 | echo $groupsContent; --------------------------------------------------------------------------------