@gitlab/ui 112.1.0 → 112.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/components/charts/line/line.js +11 -7
- package/dist/components/charts/stacked_column/stacked_column.js +9 -6
- package/dist/index.css +1 -1
- package/dist/index.css.map +1 -1
- package/dist/index.js +0 -1
- package/package.json +1 -1
- package/src/components/base/label/label.scss +1 -1
- package/src/components/charts/line/line.vue +9 -6
- package/src/components/charts/stacked_column/stacked_column.vue +7 -4
- package/src/index.js +0 -1
- package/src/vendor/bootstrap-vue/src/components/collapse/package.json +0 -3
- package/dist/directives/collapse_toggle.js +0 -1
- package/dist/vendor/bootstrap-vue/src/directives/toggle/index.js +0 -1
- package/dist/vendor/bootstrap-vue/src/directives/toggle/toggle.js +0 -253
- package/src/directives/collapse_toggle.js +0 -1
- package/src/vendor/bootstrap-vue/src/directives/toggle/README.md +0 -145
- package/src/vendor/bootstrap-vue/src/directives/toggle/index.js +0 -3
- package/src/vendor/bootstrap-vue/src/directives/toggle/package.json +0 -26
- package/src/vendor/bootstrap-vue/src/directives/toggle/toggle.js +0 -274
- package/src/vendor/bootstrap-vue/src/directives/toggle/toggle.spec.js +0 -452
package/dist/index.js
CHANGED
|
@@ -106,7 +106,6 @@ export { GlModalDirective } from './directives/modal';
|
|
|
106
106
|
export { GlTooltipDirective } from './directives/tooltip/tooltip';
|
|
107
107
|
export { setGlTooltipDefaultContainer } from './directives/tooltip/container';
|
|
108
108
|
export { GlResizeObserverDirective } from './directives/resize_observer/resize_observer';
|
|
109
|
-
export { GlCollapseToggleDirective } from './directives/collapse_toggle';
|
|
110
109
|
export { SafeLinkDirective as GlSafeLinkDirective } from './directives/safe_link/safe_link';
|
|
111
110
|
export { SafeHtmlDirective as GlSafeHtmlDirective } from './directives/safe_html/safe_html';
|
|
112
111
|
export { OutsideDirective as GlOutsideDirective } from './directives/outside/outside';
|
package/package.json
CHANGED
|
@@ -138,6 +138,7 @@ export default {
|
|
|
138
138
|
// https://gitlab.com/gitlab-org/gitlab-ui/-/issues/618
|
|
139
139
|
return {
|
|
140
140
|
chart: null,
|
|
141
|
+
compiledOptions: null,
|
|
141
142
|
showAnnotationsTooltip: false,
|
|
142
143
|
annotationsTooltipTitle: '',
|
|
143
144
|
annotationsTooltipContent: '',
|
|
@@ -233,23 +234,21 @@ export default {
|
|
|
233
234
|
shouldShowAnnotationsTooltip() {
|
|
234
235
|
return this.chart && this.hasAnnotations;
|
|
235
236
|
},
|
|
236
|
-
compiledOptions() {
|
|
237
|
-
return this.chart ? this.chart.getOption() : null;
|
|
238
|
-
},
|
|
239
237
|
legendStyle() {
|
|
240
238
|
return { paddingLeft: `${grid.left}px` };
|
|
241
239
|
},
|
|
242
240
|
hasLegend() {
|
|
243
|
-
return this.
|
|
241
|
+
return this.showLegend && this.compiledOptions;
|
|
244
242
|
},
|
|
245
243
|
seriesInfo() {
|
|
246
|
-
|
|
244
|
+
const compiledSeries = this.compiledOptions?.series || [];
|
|
245
|
+
return compiledSeries.reduce((acc, series, index) => {
|
|
247
246
|
if (series.type === 'line') {
|
|
248
247
|
acc.push({
|
|
249
248
|
name: series.name,
|
|
250
249
|
type: series.lineStyle.type,
|
|
251
250
|
color: series.lineStyle.color || colorFromDefaultPalette(index),
|
|
252
|
-
data: this.includeLegendAvgMax ? series.data
|
|
251
|
+
data: this.includeLegendAvgMax ? series.data?.map((data) => data[1]) : undefined,
|
|
253
252
|
});
|
|
254
253
|
}
|
|
255
254
|
return acc;
|
|
@@ -289,6 +288,9 @@ export default {
|
|
|
289
288
|
this.chart = chart;
|
|
290
289
|
this.$emit('created', chart);
|
|
291
290
|
},
|
|
291
|
+
onUpdated() {
|
|
292
|
+
this.compiledOptions = this.chart.getOption();
|
|
293
|
+
},
|
|
292
294
|
onChartDataPointMouseOut() {
|
|
293
295
|
this.showAnnotationsTooltip = false;
|
|
294
296
|
},
|
|
@@ -325,6 +327,7 @@ export default {
|
|
|
325
327
|
:options="options"
|
|
326
328
|
v-on="$listeners"
|
|
327
329
|
@created="onCreated"
|
|
330
|
+
@updated="onUpdated"
|
|
328
331
|
/>
|
|
329
332
|
<chart-tooltip
|
|
330
333
|
v-if="shouldShowAnnotationsTooltip"
|
|
@@ -159,6 +159,7 @@ export default {
|
|
|
159
159
|
data() {
|
|
160
160
|
return {
|
|
161
161
|
chart: null,
|
|
162
|
+
compiledOptions: null,
|
|
162
163
|
};
|
|
163
164
|
},
|
|
164
165
|
computed: {
|
|
@@ -251,11 +252,9 @@ export default {
|
|
|
251
252
|
legendStyle() {
|
|
252
253
|
return { paddingLeft: `${grid.left}px` };
|
|
253
254
|
},
|
|
254
|
-
compiledOptions() {
|
|
255
|
-
return this.chart ? this.chart.getOption() : null;
|
|
256
|
-
},
|
|
257
255
|
seriesInfo() {
|
|
258
|
-
|
|
256
|
+
const compiledSeries = this.compiledOptions?.series || [];
|
|
257
|
+
return compiledSeries.reduce((acc, series, index) => {
|
|
259
258
|
acc.push({
|
|
260
259
|
name: series.name,
|
|
261
260
|
type: series.type,
|
|
@@ -278,6 +277,9 @@ export default {
|
|
|
278
277
|
this.chart = chart;
|
|
279
278
|
this.$emit('created', chart);
|
|
280
279
|
},
|
|
280
|
+
onUpdated() {
|
|
281
|
+
this.compiledOptions = this.chart.getOption();
|
|
282
|
+
},
|
|
281
283
|
getTooltipTitle({ params }) {
|
|
282
284
|
if (!params) return '';
|
|
283
285
|
|
|
@@ -310,6 +312,7 @@ export default {
|
|
|
310
312
|
:options="options"
|
|
311
313
|
v-on="$listeners"
|
|
312
314
|
@created="onCreated"
|
|
315
|
+
@updated="onUpdated"
|
|
313
316
|
/>
|
|
314
317
|
<chart-tooltip v-if="chart" :chart="chart" :use-default-tooltip-formatter="!formatTooltipText">
|
|
315
318
|
<template #title="scope">
|
package/src/index.js
CHANGED
|
@@ -122,7 +122,6 @@ export { GlModalDirective } from './directives/modal';
|
|
|
122
122
|
export { GlTooltipDirective } from './directives/tooltip/tooltip';
|
|
123
123
|
export { setGlTooltipDefaultContainer } from './directives/tooltip/container';
|
|
124
124
|
export { GlResizeObserverDirective } from './directives/resize_observer/resize_observer';
|
|
125
|
-
export { GlCollapseToggleDirective } from './directives/collapse_toggle';
|
|
126
125
|
export { SafeLinkDirective as GlSafeLinkDirective } from './directives/safe_link/safe_link';
|
|
127
126
|
export { SafeHtmlDirective as GlSafeHtmlDirective } from './directives/safe_html/safe_html';
|
|
128
127
|
export { OutsideDirective as GlOutsideDirective } from './directives/outside/outside';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { VBToggle as GlCollapseToggleDirective } from '../vendor/bootstrap-vue/src/directives/toggle/toggle';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { VBToggle } from './toggle';
|
|
@@ -1,253 +0,0 @@
|
|
|
1
|
-
import { NAME_COLLAPSE } from '../../constants/components';
|
|
2
|
-
import { IS_BROWSER } from '../../constants/env';
|
|
3
|
-
import { EVENT_OPTIONS_PASSIVE } from '../../constants/events';
|
|
4
|
-
import { CODE_ENTER, CODE_SPACE } from '../../constants/key-codes';
|
|
5
|
-
import { RX_SPACE_SPLIT, RX_HASH_ID, RX_HASH } from '../../constants/regex';
|
|
6
|
-
import { arrayIncludes, concat } from '../../utils/array';
|
|
7
|
-
import { getInstanceFromDirective } from '../../utils/get-instance-from-directive';
|
|
8
|
-
import { removeClass, removeAttr, removeStyle, hasAttr, setAttr, setStyle, requestAF, isTag, getAttr, addClass, isDisabled } from '../../utils/dom';
|
|
9
|
-
import { getRootActionEventName, getRootEventName, eventOff, eventOn } from '../../utils/events';
|
|
10
|
-
import { isString } from '../../utils/inspect';
|
|
11
|
-
import { looseEqual } from '../../utils/loose-equal';
|
|
12
|
-
import { keys } from '../../utils/object';
|
|
13
|
-
import { getEventRoot } from '../../utils/get-event-root';
|
|
14
|
-
|
|
15
|
-
// --- Constants ---
|
|
16
|
-
|
|
17
|
-
// Classes to apply to trigger element
|
|
18
|
-
const CLASS_BV_TOGGLE_COLLAPSED = 'collapsed';
|
|
19
|
-
const CLASS_BV_TOGGLE_NOT_COLLAPSED = 'not-collapsed';
|
|
20
|
-
|
|
21
|
-
// Property key for handler storage
|
|
22
|
-
const BV_BASE = '__BV_toggle';
|
|
23
|
-
// Root event listener property (Function)
|
|
24
|
-
const BV_TOGGLE_ROOT_HANDLER = `${BV_BASE}_HANDLER__`;
|
|
25
|
-
// Trigger element click handler property (Function)
|
|
26
|
-
const BV_TOGGLE_CLICK_HANDLER = `${BV_BASE}_CLICK__`;
|
|
27
|
-
// Target visibility state property (Boolean)
|
|
28
|
-
const BV_TOGGLE_STATE = `${BV_BASE}_STATE__`;
|
|
29
|
-
// Target ID list property (Array)
|
|
30
|
-
const BV_TOGGLE_TARGETS = `${BV_BASE}_TARGETS__`;
|
|
31
|
-
|
|
32
|
-
// Commonly used strings
|
|
33
|
-
const STRING_FALSE = 'false';
|
|
34
|
-
const STRING_TRUE = 'true';
|
|
35
|
-
|
|
36
|
-
// Commonly used attribute names
|
|
37
|
-
const ATTR_ARIA_CONTROLS = 'aria-controls';
|
|
38
|
-
const ATTR_ARIA_EXPANDED = 'aria-expanded';
|
|
39
|
-
const ATTR_ROLE = 'role';
|
|
40
|
-
const ATTR_TABINDEX = 'tabindex';
|
|
41
|
-
|
|
42
|
-
// Commonly used style properties
|
|
43
|
-
const STYLE_OVERFLOW_ANCHOR = 'overflow-anchor';
|
|
44
|
-
|
|
45
|
-
// Emitted control event for collapse (emitted to collapse)
|
|
46
|
-
const ROOT_ACTION_EVENT_NAME_TOGGLE = getRootActionEventName(NAME_COLLAPSE, 'toggle');
|
|
47
|
-
|
|
48
|
-
// Listen to event for toggle state update (emitted by collapse)
|
|
49
|
-
const ROOT_EVENT_NAME_STATE = getRootEventName(NAME_COLLAPSE, 'state');
|
|
50
|
-
|
|
51
|
-
// Private event emitted on `$root` to ensure the toggle state is always synced
|
|
52
|
-
// Gets emitted even if the state of b-collapse has not changed
|
|
53
|
-
// This event is NOT to be documented as people should not be using it
|
|
54
|
-
const ROOT_EVENT_NAME_SYNC_STATE = getRootEventName(NAME_COLLAPSE, 'sync-state');
|
|
55
|
-
|
|
56
|
-
// Private event we send to collapse to request state update sync event
|
|
57
|
-
const ROOT_ACTION_EVENT_NAME_REQUEST_STATE = getRootActionEventName(NAME_COLLAPSE, 'request-state');
|
|
58
|
-
const KEYDOWN_KEY_CODES = [CODE_ENTER, CODE_SPACE];
|
|
59
|
-
|
|
60
|
-
// --- Helper methods ---
|
|
61
|
-
|
|
62
|
-
const isNonStandardTag = el => !arrayIncludes(['button', 'a'], el.tagName.toLowerCase());
|
|
63
|
-
const getTargets = (_ref, el) => {
|
|
64
|
-
let {
|
|
65
|
-
modifiers,
|
|
66
|
-
arg,
|
|
67
|
-
value
|
|
68
|
-
} = _ref;
|
|
69
|
-
// Any modifiers are considered target IDs
|
|
70
|
-
const targets = keys(modifiers || {});
|
|
71
|
-
|
|
72
|
-
// If value is a string, split out individual targets (if space delimited)
|
|
73
|
-
value = isString(value) ? value.split(RX_SPACE_SPLIT) : value;
|
|
74
|
-
|
|
75
|
-
// Support target ID as link href (`href="#id"`)
|
|
76
|
-
if (isTag(el.tagName, 'a')) {
|
|
77
|
-
const href = getAttr(el, 'href') || '';
|
|
78
|
-
if (RX_HASH_ID.test(href)) {
|
|
79
|
-
targets.push(href.replace(RX_HASH, ''));
|
|
80
|
-
}
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
// Add ID from `arg` (if provided), and support value
|
|
84
|
-
// as a single string ID or an array of string IDs
|
|
85
|
-
// If `value` is not an array or string, then it gets filtered out
|
|
86
|
-
concat(arg, value).forEach(t => isString(t) && targets.push(t));
|
|
87
|
-
|
|
88
|
-
// Return only unique and truthy target IDs
|
|
89
|
-
return targets.filter((t, index, arr) => t && arr.indexOf(t) === index);
|
|
90
|
-
};
|
|
91
|
-
const removeClickListener = el => {
|
|
92
|
-
const handler = el[BV_TOGGLE_CLICK_HANDLER];
|
|
93
|
-
if (handler) {
|
|
94
|
-
eventOff(el, 'click', handler, EVENT_OPTIONS_PASSIVE);
|
|
95
|
-
eventOff(el, 'keydown', handler, EVENT_OPTIONS_PASSIVE);
|
|
96
|
-
}
|
|
97
|
-
el[BV_TOGGLE_CLICK_HANDLER] = null;
|
|
98
|
-
};
|
|
99
|
-
const addClickListener = (el, instance) => {
|
|
100
|
-
removeClickListener(el);
|
|
101
|
-
if (instance) {
|
|
102
|
-
const handler = event => {
|
|
103
|
-
if (!(event.type === 'keydown' && !arrayIncludes(KEYDOWN_KEY_CODES, event.keyCode)) && !isDisabled(el)) {
|
|
104
|
-
const targets = el[BV_TOGGLE_TARGETS] || [];
|
|
105
|
-
targets.forEach(target => {
|
|
106
|
-
getEventRoot(instance).$emit(ROOT_ACTION_EVENT_NAME_TOGGLE, target);
|
|
107
|
-
});
|
|
108
|
-
}
|
|
109
|
-
};
|
|
110
|
-
el[BV_TOGGLE_CLICK_HANDLER] = handler;
|
|
111
|
-
eventOn(el, 'click', handler, EVENT_OPTIONS_PASSIVE);
|
|
112
|
-
if (isNonStandardTag(el)) {
|
|
113
|
-
eventOn(el, 'keydown', handler, EVENT_OPTIONS_PASSIVE);
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
};
|
|
117
|
-
const removeRootListeners = (el, instance) => {
|
|
118
|
-
if (el[BV_TOGGLE_ROOT_HANDLER] && instance) {
|
|
119
|
-
getEventRoot(instance).$off([ROOT_EVENT_NAME_STATE, ROOT_EVENT_NAME_SYNC_STATE], el[BV_TOGGLE_ROOT_HANDLER]);
|
|
120
|
-
}
|
|
121
|
-
el[BV_TOGGLE_ROOT_HANDLER] = null;
|
|
122
|
-
};
|
|
123
|
-
const addRootListeners = (el, instance) => {
|
|
124
|
-
removeRootListeners(el, instance);
|
|
125
|
-
if (instance) {
|
|
126
|
-
const handler = (id, state) => {
|
|
127
|
-
// `state` will be `true` if target is expanded
|
|
128
|
-
if (arrayIncludes(el[BV_TOGGLE_TARGETS] || [], id)) {
|
|
129
|
-
// Set/Clear 'collapsed' visibility class state
|
|
130
|
-
el[BV_TOGGLE_STATE] = state;
|
|
131
|
-
// Set `aria-expanded` and class state on trigger element
|
|
132
|
-
setToggleState(el, state);
|
|
133
|
-
}
|
|
134
|
-
};
|
|
135
|
-
el[BV_TOGGLE_ROOT_HANDLER] = handler;
|
|
136
|
-
// Listen for toggle state changes (public) and sync (private)
|
|
137
|
-
getEventRoot(instance).$on([ROOT_EVENT_NAME_STATE, ROOT_EVENT_NAME_SYNC_STATE], handler);
|
|
138
|
-
}
|
|
139
|
-
};
|
|
140
|
-
const setToggleState = (el, state) => {
|
|
141
|
-
// State refers to the visibility of the collapse
|
|
142
|
-
if (state) {
|
|
143
|
-
removeClass(el, CLASS_BV_TOGGLE_COLLAPSED);
|
|
144
|
-
addClass(el, CLASS_BV_TOGGLE_NOT_COLLAPSED);
|
|
145
|
-
setAttr(el, ATTR_ARIA_EXPANDED, STRING_TRUE);
|
|
146
|
-
} else {
|
|
147
|
-
removeClass(el, CLASS_BV_TOGGLE_NOT_COLLAPSED);
|
|
148
|
-
addClass(el, CLASS_BV_TOGGLE_COLLAPSED);
|
|
149
|
-
setAttr(el, ATTR_ARIA_EXPANDED, STRING_FALSE);
|
|
150
|
-
}
|
|
151
|
-
};
|
|
152
|
-
|
|
153
|
-
// Reset and remove a property from the provided element
|
|
154
|
-
const resetProp = (el, prop) => {
|
|
155
|
-
el[prop] = null;
|
|
156
|
-
delete el[prop];
|
|
157
|
-
};
|
|
158
|
-
|
|
159
|
-
// Handle directive updates
|
|
160
|
-
const handleUpdate = (el, binding, vnode) => {
|
|
161
|
-
/* istanbul ignore next: should never happen */
|
|
162
|
-
if (!IS_BROWSER || !getInstanceFromDirective(vnode, binding)) {
|
|
163
|
-
return;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
// If element is not a button or link, we add `role="button"`
|
|
167
|
-
// and `tabindex="0"` for accessibility reasons
|
|
168
|
-
if (isNonStandardTag(el)) {
|
|
169
|
-
if (!hasAttr(el, ATTR_ROLE)) {
|
|
170
|
-
setAttr(el, ATTR_ROLE, 'button');
|
|
171
|
-
}
|
|
172
|
-
if (!hasAttr(el, ATTR_TABINDEX)) {
|
|
173
|
-
setAttr(el, ATTR_TABINDEX, '0');
|
|
174
|
-
}
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
// Ensure the collapse class and `aria-*` attributes persist
|
|
178
|
-
// after element is updated (either by parent re-rendering
|
|
179
|
-
// or changes to this element or its contents)
|
|
180
|
-
setToggleState(el, el[BV_TOGGLE_STATE]);
|
|
181
|
-
|
|
182
|
-
// Parse list of target IDs
|
|
183
|
-
const targets = getTargets(binding, el);
|
|
184
|
-
|
|
185
|
-
// Ensure the `aria-controls` hasn't been overwritten
|
|
186
|
-
// or removed when vnode updates
|
|
187
|
-
// Also ensure to set `overflow-anchor` to `none` to prevent
|
|
188
|
-
// the browser's scroll anchoring behavior
|
|
189
|
-
/* istanbul ignore else */
|
|
190
|
-
if (targets.length > 0) {
|
|
191
|
-
setAttr(el, ATTR_ARIA_CONTROLS, targets.join(' '));
|
|
192
|
-
setStyle(el, STYLE_OVERFLOW_ANCHOR, 'none');
|
|
193
|
-
} else {
|
|
194
|
-
removeAttr(el, ATTR_ARIA_CONTROLS);
|
|
195
|
-
removeStyle(el, STYLE_OVERFLOW_ANCHOR);
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
// Add/Update our click listener(s)
|
|
199
|
-
// Wrap in a `requestAF()` to allow any previous
|
|
200
|
-
// click handling to occur first
|
|
201
|
-
requestAF(() => {
|
|
202
|
-
addClickListener(el, getInstanceFromDirective(vnode, binding));
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
// If targets array has changed, update
|
|
206
|
-
if (!looseEqual(targets, el[BV_TOGGLE_TARGETS])) {
|
|
207
|
-
// Update targets array to element storage
|
|
208
|
-
el[BV_TOGGLE_TARGETS] = targets;
|
|
209
|
-
// Ensure `aria-controls` is up to date
|
|
210
|
-
// Request a state update from targets so that we can
|
|
211
|
-
// ensure expanded state is correct (in most cases)
|
|
212
|
-
targets.forEach(target => {
|
|
213
|
-
getEventRoot(getInstanceFromDirective(vnode, binding)).$emit(ROOT_ACTION_EVENT_NAME_REQUEST_STATE, target);
|
|
214
|
-
});
|
|
215
|
-
}
|
|
216
|
-
};
|
|
217
|
-
|
|
218
|
-
/*
|
|
219
|
-
* Export our directive
|
|
220
|
-
*/
|
|
221
|
-
const VBToggle = {
|
|
222
|
-
bind(el, binding, vnode) {
|
|
223
|
-
// State is initially collapsed until we receive a state event
|
|
224
|
-
el[BV_TOGGLE_STATE] = false;
|
|
225
|
-
// Assume no targets initially
|
|
226
|
-
el[BV_TOGGLE_TARGETS] = [];
|
|
227
|
-
// Add our root listeners
|
|
228
|
-
addRootListeners(el, getInstanceFromDirective(vnode, binding));
|
|
229
|
-
// Initial update of trigger
|
|
230
|
-
handleUpdate(el, binding, vnode);
|
|
231
|
-
},
|
|
232
|
-
componentUpdated: handleUpdate,
|
|
233
|
-
updated: handleUpdate,
|
|
234
|
-
unbind(el, binding, vnode) {
|
|
235
|
-
removeClickListener(el);
|
|
236
|
-
// Remove our $root listener
|
|
237
|
-
removeRootListeners(el, getInstanceFromDirective(vnode, binding));
|
|
238
|
-
// Reset custom props
|
|
239
|
-
resetProp(el, BV_TOGGLE_ROOT_HANDLER);
|
|
240
|
-
resetProp(el, BV_TOGGLE_CLICK_HANDLER);
|
|
241
|
-
resetProp(el, BV_TOGGLE_STATE);
|
|
242
|
-
resetProp(el, BV_TOGGLE_TARGETS);
|
|
243
|
-
// Reset classes/attrs/styles
|
|
244
|
-
removeClass(el, CLASS_BV_TOGGLE_COLLAPSED);
|
|
245
|
-
removeClass(el, CLASS_BV_TOGGLE_NOT_COLLAPSED);
|
|
246
|
-
removeAttr(el, ATTR_ARIA_EXPANDED);
|
|
247
|
-
removeAttr(el, ATTR_ARIA_CONTROLS);
|
|
248
|
-
removeAttr(el, ATTR_ROLE);
|
|
249
|
-
removeStyle(el, STYLE_OVERFLOW_ANCHOR);
|
|
250
|
-
}
|
|
251
|
-
};
|
|
252
|
-
|
|
253
|
-
export { VBToggle };
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { VBToggle as GlCollapseToggleDirective } from '../vendor/bootstrap-vue/src/directives/toggle/toggle';
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
# Toggle
|
|
2
|
-
|
|
3
|
-
> `v-b-toggle` is a light-weight directive for toggling the visibility of collapses, and includes
|
|
4
|
-
> automated [WAI-ARIA accessibility](?path=/docs/base-tooltip--docs#accessibility) attribute
|
|
5
|
-
> handling.
|
|
6
|
-
|
|
7
|
-
## Overview
|
|
8
|
-
|
|
9
|
-
The `v-b-toggle` directive can be used on interactive elements, such as buttons and to toggle the
|
|
10
|
-
visibility state of the [`<gl-collapse>`](?path=/docs/base-collapse--docs) component.
|
|
11
|
-
|
|
12
|
-
Besides toggling the visibility of the target component, the directive automatically updates ARIA
|
|
13
|
-
accessibility attributes on the element it is applied to so that they reflect the visibility state
|
|
14
|
-
of the target component. Refer to the [Accessibility section](#accessibility) below for additional
|
|
15
|
-
details and caveats.
|
|
16
|
-
|
|
17
|
-
## Directive syntax and usage
|
|
18
|
-
|
|
19
|
-
The directive is applied to the element or component that triggers the visibility of the target. The
|
|
20
|
-
target component can be specified (via its ID) as either a directive modifier(s), the directive
|
|
21
|
-
argument, or as a string/array passed to as the directive value:
|
|
22
|
-
|
|
23
|
-
- `v-b-toggle.my-collapse` - the directive modifier (multiple targets allowed, each modifier is a
|
|
24
|
-
target ID)
|
|
25
|
-
- `v-b-toggle:my-collapse` - the directive argument
|
|
26
|
-
([Vue dynamic argument](https://vuejs.org/v2/guide/syntax.html#Dynamic-Arguments) is supported)
|
|
27
|
-
<span class="badge badge-info small" aria-label="Available in BootstrapVue v2.14.0+">v2.14.0+</span>
|
|
28
|
-
- `v-b-toggle="'my-collapse'"` - the directive value as a string ID
|
|
29
|
-
- `v-b-toggle="'my-collapse1 my-collapse2'"` - the directive value as a space separated string of
|
|
30
|
-
IDs
|
|
31
|
-
<span class="badge badge-info small" aria-label="Available in BootstrapVue v2.14.0+">v2.14.0+</span>
|
|
32
|
-
- `v-b-toggle="['my-collapse1', 'my-collapse2']"` - the directive value as an array of string IDs
|
|
33
|
-
<span class="badge badge-info small" aria-label="Available in BootstrapVue v2.14.0+">v2.14.0+</span>
|
|
34
|
-
|
|
35
|
-
Modifiers, argument, and the value can be used at the same time when targeting multiple components.
|
|
36
|
-
|
|
37
|
-
**Example usage:**
|
|
38
|
-
|
|
39
|
-
```html
|
|
40
|
-
<template>
|
|
41
|
-
<div>
|
|
42
|
-
<div class="mb-3">
|
|
43
|
-
<b-button v-b-toggle.my-collapse>Toggle Collapse</b-button>
|
|
44
|
-
</div>
|
|
45
|
-
|
|
46
|
-
<b-collapse id="my-collapse">
|
|
47
|
-
<b-card title="Collapsible card">
|
|
48
|
-
Hello world!
|
|
49
|
-
</b-card>
|
|
50
|
-
</b-collapse>
|
|
51
|
-
</div>
|
|
52
|
-
</template>
|
|
53
|
-
|
|
54
|
-
<!-- v-b-toggle-directive.vue -->
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Usage on links
|
|
58
|
-
|
|
59
|
-
<span class="badge badge-info small">2.15.0+</span>
|
|
60
|
-
|
|
61
|
-
If placing the directive on a link (or a component that renders a link), the target ID can
|
|
62
|
-
alternatively be specified via the `href` attribute.
|
|
63
|
-
|
|
64
|
-
Note that the browser URL will change and the page may scroll the target into view. To prevent the
|
|
65
|
-
URL from changing and the page from scrolling, add `@click.prevent` to the link.
|
|
66
|
-
|
|
67
|
-
**Example usage:**
|
|
68
|
-
|
|
69
|
-
```html
|
|
70
|
-
<template>
|
|
71
|
-
<div>
|
|
72
|
-
<div class="mb-3">
|
|
73
|
-
<a v-b-toggle href="#example-collapse" @click.prevent>Toggle Collapse</a>
|
|
74
|
-
</div>
|
|
75
|
-
|
|
76
|
-
<b-collapse id="example-collapse">
|
|
77
|
-
<b-card title="Collapsible card">
|
|
78
|
-
Hello world!
|
|
79
|
-
</b-card>
|
|
80
|
-
</b-collapse>
|
|
81
|
-
</div>
|
|
82
|
-
</template>
|
|
83
|
-
|
|
84
|
-
<!-- v-b-toggle-links.vue -->
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Hiding and showing content in the toggle trigger element
|
|
88
|
-
|
|
89
|
-
When using the `v-b-toggle` directive, the class `collapsed` will automatically be placed on the
|
|
90
|
-
trigger element when the target component is closed, and removed when open. As of BootstrapVue
|
|
91
|
-
`2.14.0`, the class `not-collapsed` will be applied when the target is _not_ closed.
|
|
92
|
-
|
|
93
|
-
**Example HTML markup:**
|
|
94
|
-
|
|
95
|
-
```html
|
|
96
|
-
<div>
|
|
97
|
-
<b-button v-b-toggle:my-collapse>
|
|
98
|
-
<span class="when-open">Close</span><span class="when-closed">Open</span> My Collapse
|
|
99
|
-
</b-button>
|
|
100
|
-
<b-collapse id="my-collapse">
|
|
101
|
-
<!-- Content here -->
|
|
102
|
-
</b-collapse>
|
|
103
|
-
</div>
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
**Example Custom CSS:**
|
|
107
|
-
|
|
108
|
-
```css
|
|
109
|
-
.collapsed > .when-open,
|
|
110
|
-
.not-collapsed > .when-closed {
|
|
111
|
-
display: none;
|
|
112
|
-
}
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
## Preventing the target from opening or closing
|
|
116
|
-
|
|
117
|
-
To prevent the trigger element from toggling the target, set the `disabled` prop on `<button>`,
|
|
118
|
-
`<b-button>`, or `<b-link>` (or components based on from `<b-link>`) and the toggle event will _not_
|
|
119
|
-
dispatched to the target(s).
|
|
120
|
-
|
|
121
|
-
## Accessibility
|
|
122
|
-
|
|
123
|
-
The directive, for accessibility reasons, should be placed on an clickable interactive element such
|
|
124
|
-
as a `<button>` or `<b-button>`, which can easily be accessed by keyboard-only users and screen
|
|
125
|
-
reader users. Elements that do not natively have an accessibility role of `button` (or `link`) will
|
|
126
|
-
have the attributes `role="button"` and `tabindex="0"` applied, and will have the appropriate click
|
|
127
|
-
handler instantiated. Therefore it is _highly recommended_ to _not_ place the directive on form
|
|
128
|
-
controls other than buttons.
|
|
129
|
-
|
|
130
|
-
The directive applies, and dynamically updates, the following ARIA attributes on the trigger
|
|
131
|
-
element:
|
|
132
|
-
|
|
133
|
-
- `aria-controls` - the ID(s) of the collapse component(s) being toggled
|
|
134
|
-
- `aria-expanded` - the visibility state of the collapse (see the
|
|
135
|
-
[caveats section](#caveats-with-multiple-targets) below)
|
|
136
|
-
|
|
137
|
-
### Caveats with multiple targets
|
|
138
|
-
|
|
139
|
-
When multiple targets are specified, the value of the `aria-expanded` attribute may not be correct
|
|
140
|
-
if the individual target components can have their collapsed state controlled independently (either
|
|
141
|
-
via `v-model`, other controls with `v-b-toggle` directive, or CSS visibility).
|
|
142
|
-
|
|
143
|
-
## See also
|
|
144
|
-
|
|
145
|
-
- [collapse](?path=/docs/base-collapse--docs) Collapsible content with accordion support
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@bootstrap-vue/v-b-toggle",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"meta": {
|
|
5
|
-
"title": "Toggle",
|
|
6
|
-
"description": "A light-weight directive for toggling visibility state for collapses by ID. It automatically handles the accessibility attributes on the trigger element.",
|
|
7
|
-
"directive": "VBToggle",
|
|
8
|
-
"expression": [
|
|
9
|
-
"String",
|
|
10
|
-
"Array"
|
|
11
|
-
],
|
|
12
|
-
"arg": {
|
|
13
|
-
"version": "2.14.0",
|
|
14
|
-
"pattern": "[a-zA-Z][a-zA-Z0-9_\\-]*",
|
|
15
|
-
"description": "ID of component to toggle",
|
|
16
|
-
"required": false
|
|
17
|
-
},
|
|
18
|
-
"modifiers": [
|
|
19
|
-
{
|
|
20
|
-
"name": "{componentId}",
|
|
21
|
-
"pattern": "[a-zA-Z][a-zA-Z0-9_\\-]*",
|
|
22
|
-
"description": "ID of component to toggle"
|
|
23
|
-
}
|
|
24
|
-
]
|
|
25
|
-
}
|
|
26
|
-
}
|