forked from kartik-v/yii2-tabs-x
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TabsX.php
328 lines (294 loc) · 10.5 KB
/
TabsX.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<?php
/**
* @copyright Copyright © Kartik Visweswaran, Krajee.com, 2014 - 2016
* @package yii2-tabs-x
* @version 1.2.3
*/
namespace kartik\tabs;
use Yii;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\ArrayHelper;
use yii\bootstrap\Dropdown;
use yii\bootstrap\Tabs;
use yii\base\InvalidConfigException;
use kartik\base\WidgetTrait;
/**
* An extended Bootstrap Tabs widget for Yii Framework 2 based on the bootstrap-tabs-x
* plugin by Krajee. This widget enhances the default bootstrap tabs plugin with various
* new styling enhancements.
*
* ```php
* echo TabsX::widget([
* 'position' => TabsX::POS_ABOVE,
* 'align' => TabsX::ALIGN_LEFT,
* 'items' => [
* [
* 'label' => 'One',
* 'content' => 'Anim pariatur cliche...',
* 'active' => true
* ],
* [
* 'label' => 'Two',
* 'content' => 'Anim pariatur cliche...',
* 'headerOptions' => [],
* 'options' => ['id' => 'myveryownID'],
* ],
* [
* 'label' => 'Dropdown',
* 'items' => [
* [
* 'label' => 'DropdownA',
* 'content' => 'DropdownA, Anim pariatur cliche...',
* ],
* [
* 'label' => 'DropdownB',
* 'content' => 'DropdownB, Anim pariatur cliche...',
* ],
* ],
* ],
* ],
* ]);
* ```
*
* @see http://plugins.krajee.com/tabs-x
* @see http://github.com/kartik-v/bootstrap-tabs-x
* @author Kartik Visweswaran <kartikv2@gmail.com>
* @since 1.0
*/
class TabsX extends Tabs
{
use WidgetTrait;
/**
* Tabs direction / position
*/
const POS_ABOVE = 'above';
const POS_BELOW = 'below';
const POS_LEFT = 'left';
const POS_RIGHT = 'right';
/**
* Tab align
*/
const ALIGN_LEFT = 'left';
const ALIGN_CENTER = 'center';
const ALIGN_RIGHT = 'right';
/**
* Tab content fixed heights
*/
const SIZE_TINY = 'xs';
const SIZE_SMALL = 'sm';
const SIZE_MEDIUM = 'md';
const SIZE_LARGE = 'lg';
/**
* @var string the position of the tabs with respect to the tab content Should be one of the [[TabsX::POS]]
* constants. Defaults to [[TabsX::POS_ABOVE]].
*/
public $position = self::POS_ABOVE;
/**
* @var string the alignment of the tab headers with respect to the tab content. Should be one of the
* [[TabsX::ALIGN]] constants. Defaults to [[TabsX::ALIGN_LEFT]].
*/
public $align = self::ALIGN_LEFT;
/**
* @var boolean whether the tab content should be boxed within a bordered container. Defaults to `false`.
*/
public $bordered = false;
/**
* @var boolean whether the tab header text orientation should be rotated sideways. Applicable only when position
* is one of [[TabsX::POS_LEFT]] or [[TabsX::POS_RIGHT]]. Defaults to `false`.
*/
public $sideways = false;
/**
* @var boolean whether to fade in each tab pane using the fade animation effect. Defaults to `true`.
*/
public $fade = true;
/**
* @var string whether the tab body content height should be of a fixed size. You should pass one of the
* [[TabsX::SIZE]] constants. Applicable only when position is one of [[TabsX::POS_ABOVE]] or
* [[TabsX::POS_BELOW]]. Defaults to empty string (meaning dynamic height).
*/
public $height = '';
/**
* @var array the HTML attributes for the TabsX container
*/
public $containerOptions = [];
/**
* @var bool whether to enable sticky tabs plugin to maintain tabs push state on browser back and forward
*/
public $enableStickyTabs = false;
/**
* @var array widget plugin options
*/
public $pluginOptions = [];
/**
* @var array sticky tabs plugin options
*/
public $stickyTabsOptions = [];
/**
* @var array widget JQuery events. You must define events in event-name => event-function format for example:
* ~~~
* pluginEvents = [
* "change" => "function() { log("change"); }",
* "open" => "function() { log("open"); }",
* ];
* ~~~
*/
public $pluginEvents = [];
/**
* @inheritdoc
*/
public $pluginName = 'tabsX';
/**
* @inheritdoc
*/
public $pluginDestroyJs;
/**
* @var string the hashed global variable name storing the pluginOptions
*/
protected $_hashVar;
/**
* @var string the element's HTML5 data variable name storing the pluginOptions
*/
protected $_dataVar;
/**
* @var string the Json encoded options
*/
protected $_encOptions = '';
/**
* Initializes the widget.
*/
public function initWidget()
{
if (empty($this->containerOptions['id'])) {
$this->containerOptions['id'] = $this->options['id'] . '-container';
}
if (ArrayHelper::getValue($this->containerOptions, 'data-enable-cache', true) === false) {
$this->containerOptions['data-enable-cache'] = "false";
}
$this->registerAssets();
Html::addCssClass($this->options, 'nav ' . $this->navType);
$this->options['role'] = 'tablist';
$css = self::getCss("tabs-{$this->position}", $this->position != null) .
self::getCss("tab-align-{$this->align}", $this->align != null) .
self::getCss("tab-bordered", $this->bordered) .
self::getCss(
"tab-sideways",
$this->sideways && ($this->position == self::POS_LEFT || $this->position == self::POS_RIGHT)
) .
self::getCss(
"tab-height-{$this->height}",
$this->height != null && ($this->position == self::POS_ABOVE || $this->position == self::POS_BELOW)
) .
' ' . ArrayHelper::getValue($this->pluginOptions, 'addCss', 'tabs-krajee');
Html::addCssClass($this->containerOptions, $css);
}
/**
* Renders the widget.
*/
public function run()
{
$this->initWidget();
echo $this->renderItems();
}
/**
* Parse the CSS content to append based on condition
*
* @param string $prop the css property
* @param boolean $condition the validation to append the CSS class
*
* @return string the parsed CSS
*/
protected static function getCss($prop = '', $condition = true)
{
return $condition ? ' ' . $prop : '';
}
/**
* Renders tab items as specified on [[items]].
*
* @return string the rendering result.
* @throws InvalidConfigException.
*/
protected function renderItems()
{
$headers = [];
$panes = [];
if (!$this->hasActiveTab() && !empty($this->items)) {
$this->items[0]['active'] = true;
}
foreach ($this->items as $n => $item) {
if (!ArrayHelper::remove($item, 'visible', true)) {
continue;
}
if (!isset($item['label'])) {
throw new InvalidConfigException("The 'label' option is required.");
}
$encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
$label = $encodeLabel ? Html::encode($item['label']) : $item['label'];
$headerOptions = array_merge($this->headerOptions, ArrayHelper::getValue($item, 'headerOptions', []));
$linkOptions = array_merge($this->linkOptions, ArrayHelper::getValue($item, 'linkOptions', []));
$content = ArrayHelper::getValue($item, 'content', '');
if (isset($item['items'])) {
$label .= ' <b class="caret"></b>';
Html::addCssClass($headerOptions, 'dropdown');
if ($this->renderDropdown($n, $item['items'], $panes)) {
Html::addCssClass($headerOptions, 'active');
}
Html::addCssClass($linkOptions, 'dropdown-toggle');
$linkOptions['data-toggle'] = 'dropdown';
$header = Html::a($label, "#", $linkOptions) . "\n"
. Dropdown::widget([
'items' => $item['items'],
'clientOptions' => false,
'view' => $this->getView()
]);
} else {
$options = array_merge($this->itemOptions, ArrayHelper::getValue($item, 'options', []));
$options['id'] = ArrayHelper::getValue($options, 'id', $this->options['id'] . '-tab' . $n);
$css = 'tab-pane';
$isActive = ArrayHelper::remove($item, 'active');
if ($this->fade) {
$css = $isActive ? "{$css} fade in" : "{$css} fade";
}
Html::addCssClass($options, $css);
if ($isActive) {
Html::addCssClass($options, 'active');
Html::addCssClass($headerOptions, 'active');
}
if (isset($item['url'])) {
$header = Html::a($label, $item['url'], $linkOptions);
} else {
$linkOptions['data-toggle'] = 'tab';
$linkOptions['role'] = 'tab';
$header = Html::a($label, '#' . $options['id'], $linkOptions);
}
if ($this->renderTabContent) {
$panes[] = Html::tag('div', $content, $options);
}
}
$headers[] = Html::tag('li', $header, $headerOptions);
}
$outHeader = Html::tag('ul', implode("\n", $headers), $this->options);
if ($this->renderTabContent) {
$outPane = Html::tag('div', implode("\n", $panes), ['class' => 'tab-content']);
$tabs = $this->position == self::POS_BELOW ? $outPane . "\n" . $outHeader : $outHeader . "\n" . $outPane;
} else {
$tabs = $outHeader;
}
return Html::tag('div', $tabs, $this->containerOptions);
}
/**
* Registers the needed assets
*/
public function registerAssets()
{
$view = $this->getView();
TabsXAsset::register($view);
$id = 'jQuery("#' . $this->containerOptions['id'] . '")';
$this->registerPlugin($this->pluginName, $id);
if ($this->enableStickyTabs) {
StickyTabsAsset::register($view);
$opts = Json::encode($this->stickyTabsOptions);
$view->registerJs("{$id}.stickyTabs({$opts});");
}
}
}