@gitlab/ui 66.0.0 → 66.0.1
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 +7 -0
- package/dist/components/base/toggle/toggle.js +17 -38
- package/dist/index.css +1 -1
- package/dist/index.css.map +1 -1
- package/dist/tokens/css/tokens.css +1 -1
- package/dist/tokens/css/tokens.dark.css +1 -1
- package/dist/tokens/js/tokens.dark.js +1 -1
- package/dist/tokens/js/tokens.js +1 -1
- package/dist/tokens/scss/_tokens.dark.scss +1 -1
- package/dist/tokens/scss/_tokens.scss +1 -1
- package/dist/utility_classes.css +1 -1
- package/dist/utility_classes.css.map +1 -1
- package/dist/utils/constants.js +0 -1
- package/package.json +1 -1
- package/src/components/base/toggle/toggle.scss +6 -35
- package/src/components/base/toggle/toggle.spec.js +26 -38
- package/src/components/base/toggle/toggle.stories.js +0 -6
- package/src/components/base/toggle/toggle.vue +55 -76
- package/src/scss/utilities.scss +0 -8
- package/src/scss/utility-mixins/flex.scss +0 -4
- package/src/utils/constants.js +0 -1
package/dist/utils/constants.js
CHANGED
package/package.json
CHANGED
|
@@ -29,18 +29,18 @@
|
|
|
29
29
|
.gl-toggle {
|
|
30
30
|
@include gl-cursor-not-allowed;
|
|
31
31
|
@include gl-bg-gray-200;
|
|
32
|
-
}
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
33
|
+
.toggle-icon > svg {
|
|
34
|
+
@include gl-fill-gray-200;
|
|
35
|
+
}
|
|
36
36
|
}
|
|
37
37
|
|
|
38
38
|
.gl-toggle.is-checked {
|
|
39
39
|
@include gl-bg-blue-200;
|
|
40
|
-
}
|
|
41
40
|
|
|
42
|
-
|
|
43
|
-
|
|
41
|
+
.toggle-icon > svg {
|
|
42
|
+
@include gl-fill-blue-200;
|
|
43
|
+
}
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
.gl-toggle-label,
|
|
@@ -50,35 +50,6 @@
|
|
|
50
50
|
}
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
-
.gl-toggle-label-container {
|
|
54
|
-
@include gl-flex-shrink-0;
|
|
55
|
-
@include gl-display-flex;
|
|
56
|
-
@include gl-flex-direction-column;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
.gl-toggle-switch-container {
|
|
60
|
-
@include gl-display-flex;
|
|
61
|
-
@include gl-flex-direction-column;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
.gl-toggle-label-position-block {
|
|
65
|
-
@include gl-justify-content-space-between;
|
|
66
|
-
@include gl-align-items-center;
|
|
67
|
-
@include gl-w-full;
|
|
68
|
-
@include gl-gap-3;
|
|
69
|
-
|
|
70
|
-
.gl-toggle-label-container {
|
|
71
|
-
@include gl-gap-2;
|
|
72
|
-
@include gl-flex-shrink-1;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
.gl-toggle-switch-container {
|
|
76
|
-
@include gl-align-items-flex-end;
|
|
77
|
-
@include gl-gap-2;
|
|
78
|
-
@include gl-flex-shrink-1;
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
|
|
82
53
|
.gl-help-label {
|
|
83
54
|
@include gl-mt-3;
|
|
84
55
|
@include gl-text-gray-500;
|
|
@@ -138,43 +138,31 @@ describe('toggle', () => {
|
|
|
138
138
|
|
|
139
139
|
describe('label position', () => {
|
|
140
140
|
describe.each`
|
|
141
|
-
state | labelPosition | hasGlSrOnlyClass | flexDirection
|
|
142
|
-
${'top'} | ${toggleLabelPosition.top} | ${false} | ${'gl-flex-direction-column'}
|
|
143
|
-
${'left'} | ${toggleLabelPosition.left} | ${false} | ${'gl-toggle-label-inline'}
|
|
144
|
-
${'hidden'} | ${toggleLabelPosition.hidden} | ${true} | ${'gl-flex-direction-column'}
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
expect(findButton().attributes('aria-labelledby')).toBeDefined();
|
|
168
|
-
});
|
|
169
|
-
|
|
170
|
-
it(`${showsHelpText ? 'shows' : 'does not show'} the help text`, () => {
|
|
171
|
-
expect(findHelpElement().exists()).toBe(showsHelpText);
|
|
172
|
-
});
|
|
173
|
-
|
|
174
|
-
it(`${showsDescription ? 'shows' : 'does not show'} the description`, () => {
|
|
175
|
-
expect(findDescriptionElement().exists()).toBe(showsDescription);
|
|
176
|
-
});
|
|
177
|
-
}
|
|
178
|
-
);
|
|
141
|
+
state | labelPosition | hasGlSrOnlyClass | flexDirection
|
|
142
|
+
${'top'} | ${toggleLabelPosition.top} | ${false} | ${'gl-flex-direction-column'}
|
|
143
|
+
${'left'} | ${toggleLabelPosition.left} | ${false} | ${'gl-toggle-label-inline'}
|
|
144
|
+
${'hidden'} | ${toggleLabelPosition.hidden} | ${true} | ${'gl-flex-direction-column'}
|
|
145
|
+
`('when $state', ({ labelPosition, hasGlSrOnlyClass, flexDirection }) => {
|
|
146
|
+
beforeEach(() => {
|
|
147
|
+
createWrapper({ labelPosition });
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
it(`${flexDirection} class is added to the label`, () => {
|
|
151
|
+
const cssClasses = wrapper.find('[data-testid="toggle-wrapper"]').classes();
|
|
152
|
+
|
|
153
|
+
return expect(cssClasses).toContain(flexDirection);
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
it(`${hasGlSrOnlyClass ? 'adds' : 'does not add'} 'gl-sr-only' class to the label`, () => {
|
|
157
|
+
const cssClasses = wrapper.find('[data-testid="toggle-label"]').classes();
|
|
158
|
+
return hasGlSrOnlyClass
|
|
159
|
+
? expect(cssClasses).toContain('gl-sr-only')
|
|
160
|
+
: expect(cssClasses).not.toContain('gl-sr-only');
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
it('has accessible name for the button', () => {
|
|
164
|
+
expect(findButton().attributes('aria-labelledby')).toBeDefined();
|
|
165
|
+
});
|
|
166
|
+
});
|
|
179
167
|
});
|
|
180
168
|
});
|
|
@@ -67,12 +67,6 @@ LabelPositionLeft.args = generateProps({
|
|
|
67
67
|
labelPosition: 'left',
|
|
68
68
|
});
|
|
69
69
|
|
|
70
|
-
export const LabelPositionBlock = Template.bind({});
|
|
71
|
-
LabelPositionBlock.args = generateProps({
|
|
72
|
-
labelPosition: 'block',
|
|
73
|
-
description: withDescription,
|
|
74
|
-
});
|
|
75
|
-
|
|
76
70
|
export default {
|
|
77
71
|
title: 'base/toggle',
|
|
78
72
|
component: GlToggle,
|
|
@@ -90,42 +90,19 @@ export default {
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
computed: {
|
|
93
|
-
layoutAllowsDescription() {
|
|
94
|
-
return this.isVerticalLayout || this.isBlockLayout;
|
|
95
|
-
},
|
|
96
93
|
shouldRenderDescription() {
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
);
|
|
100
|
-
},
|
|
101
|
-
labelIsSrOnly() {
|
|
102
|
-
return this.labelPosition === 'hidden';
|
|
103
|
-
},
|
|
104
|
-
layoutAllowsHelp() {
|
|
105
|
-
return this.isVerticalLayout || this.isBlockLayout;
|
|
94
|
+
// eslint-disable-next-line @gitlab/vue-prefer-dollar-scopedslots
|
|
95
|
+
return Boolean(this.$scopedSlots.description || this.description) && this.isVerticalLayout;
|
|
106
96
|
},
|
|
107
97
|
shouldRenderHelp() {
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
if (this.labelIsSrOnly) return 'gl-sr-only';
|
|
117
|
-
return {
|
|
118
|
-
'gl-mb-2': this.shouldRenderDescription,
|
|
119
|
-
'gl-mb-3': !this.shouldRenderDescription && !this.isVerticalLayout,
|
|
120
|
-
};
|
|
121
|
-
},
|
|
122
|
-
wrapperClasses() {
|
|
123
|
-
return {
|
|
124
|
-
'gl-flex-direction-column': this.isVerticalLayout,
|
|
125
|
-
'gl-toggle-label-inline': !this.isVerticalLayout,
|
|
126
|
-
'is-disabled': this.disabled,
|
|
127
|
-
'gl-toggle-label-position-block': this.isBlockLayout,
|
|
128
|
-
};
|
|
98
|
+
// eslint-disable-next-line @gitlab/vue-prefer-dollar-scopedslots
|
|
99
|
+
return Boolean(this.$slots.help || this.help) && this.isVerticalLayout;
|
|
100
|
+
},
|
|
101
|
+
toggleClasses() {
|
|
102
|
+
return [
|
|
103
|
+
{ 'gl-sr-only': this.labelPosition === 'hidden' },
|
|
104
|
+
this.shouldRenderDescription ? 'gl-mb-2' : 'gl-mb-3',
|
|
105
|
+
];
|
|
129
106
|
},
|
|
130
107
|
icon() {
|
|
131
108
|
return this.value ? 'mobile-issue-close' : 'close';
|
|
@@ -139,9 +116,6 @@ export default {
|
|
|
139
116
|
isVerticalLayout() {
|
|
140
117
|
return this.labelPosition === 'top' || this.labelPosition === 'hidden';
|
|
141
118
|
},
|
|
142
|
-
isBlockLayout() {
|
|
143
|
-
return this.labelPosition === 'block';
|
|
144
|
-
},
|
|
145
119
|
},
|
|
146
120
|
|
|
147
121
|
beforeCreate() {
|
|
@@ -167,50 +141,55 @@ export default {
|
|
|
167
141
|
|
|
168
142
|
<template>
|
|
169
143
|
<div
|
|
170
|
-
class="gl-toggle-wrapper gl-display-flex gl-mb-0
|
|
171
|
-
:class="
|
|
144
|
+
class="gl-toggle-wrapper gl-display-flex gl-mb-0"
|
|
145
|
+
:class="{
|
|
146
|
+
'gl-flex-direction-column': isVerticalLayout,
|
|
147
|
+
'gl-toggle-label-inline': !isVerticalLayout,
|
|
148
|
+
'is-disabled': disabled,
|
|
149
|
+
}"
|
|
172
150
|
data-testid="toggle-wrapper"
|
|
173
151
|
>
|
|
174
|
-
<span
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
152
|
+
<span
|
|
153
|
+
:id="labelId"
|
|
154
|
+
:class="toggleClasses"
|
|
155
|
+
class="gl-toggle-label gl-flex-shrink-0"
|
|
156
|
+
data-testid="toggle-label"
|
|
157
|
+
>
|
|
158
|
+
<!-- @slot The toggle's label. -->
|
|
159
|
+
<slot name="label">{{ label }}</slot>
|
|
160
|
+
</span>
|
|
161
|
+
<span
|
|
162
|
+
v-if="shouldRenderDescription"
|
|
163
|
+
class="gl-description-label gl-mb-3"
|
|
164
|
+
data-testid="toggle-description"
|
|
165
|
+
>
|
|
166
|
+
<!-- @slot A description text to be shown below the label. -->
|
|
167
|
+
<slot name="description">{{ description }}</slot>
|
|
187
168
|
</span>
|
|
188
|
-
<
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
:
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
<
|
|
207
|
-
<gl-icon :name="icon" :size="16" />
|
|
208
|
-
</span>
|
|
209
|
-
</button>
|
|
210
|
-
<span v-if="shouldRenderHelp" :id="helpId" class="gl-help-label" data-testid="toggle-help">
|
|
211
|
-
<!-- @slot A help text to be shown below the toggle. -->
|
|
212
|
-
<slot name="help">{{ help }}</slot>
|
|
169
|
+
<input v-if="name" :name="name" :value="value" type="hidden" />
|
|
170
|
+
<button
|
|
171
|
+
role="switch"
|
|
172
|
+
:aria-checked="isChecked"
|
|
173
|
+
:aria-labelledby="labelId"
|
|
174
|
+
:aria-describedby="helpId"
|
|
175
|
+
:aria-disabled="disabled"
|
|
176
|
+
:class="{
|
|
177
|
+
'gl-toggle': true,
|
|
178
|
+
'is-checked': value,
|
|
179
|
+
'is-disabled': disabled,
|
|
180
|
+
}"
|
|
181
|
+
class="gl-flex-shrink-0"
|
|
182
|
+
type="button"
|
|
183
|
+
@click.prevent="toggleFeature"
|
|
184
|
+
>
|
|
185
|
+
<gl-loading-icon v-if="isLoading" color="light" class="toggle-loading" />
|
|
186
|
+
<span v-else :class="{ 'toggle-icon': true, disabled: disabled }">
|
|
187
|
+
<gl-icon :name="icon" :size="16" />
|
|
213
188
|
</span>
|
|
189
|
+
</button>
|
|
190
|
+
<span v-if="shouldRenderHelp" :id="helpId" class="gl-help-label" data-testid="toggle-help">
|
|
191
|
+
<!-- @slot A help text to be shown below the toggle. -->
|
|
192
|
+
<slot name="help">{{ help }}</slot>
|
|
214
193
|
</span>
|
|
215
194
|
</div>
|
|
216
195
|
</template>
|
package/src/scss/utilities.scss
CHANGED