@gitlab/ui 32.28.0 → 32.29.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [32.29.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v32.28.0...v32.29.0) (2021-10-29)
+
+
+### Features
+
+* **Toggle:** Update label semantics for accessibility ([a16af22](https://gitlab.com/gitlab-org/gitlab-ui/commit/a16af22246dbd4e886ca8ac4640bf9c44da5c995))
+
 # [32.28.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v32.27.0...v32.28.0) (2021-10-28)
 
 

package/dist/components/base/toggle/toggle.js

@@ -66,7 +66,15 @@ var script = {
     },
 
     /**
-     * The label's position relative to the toggle.
+     * The id for the label. This id is used by the aria-labelledby attribute on the toggle button.
+     */
+    labelId: {
+      type: String,
+      required: true
+    },
+
+    /**
+     * The label's position relative to the toggle. If 'hidden', the toggle will add the .gl-sr-only class so the label is still accessible to screen readers.
      */
     labelPosition: {
       type: String,
@@ -84,10 +92,6 @@ var script = {
       return this.value ? 'mobile-issue-close' : 'close';
     },
 
-    shouldShowLabel() {
-      return this.label && this.labelPosition !== 'hidden';
-    },
-
     helpId() {
       return this.help ? `toggle-help-${this.uuid}` : undefined;
     },
@@ -123,11 +127,11 @@ var script = {
 const __vue_script__ = script;
 
 /* template */
-var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('label',{staticClass:"gl-display-flex gl-flex-direction-column gl-mb-0 gl-w-max-content"},[_c('span',{staticClass:"gl-toggle-wrapper",class:{ 'gl-toggle-label-inline': _vm.labelPosition === 'left', 'is-disabled': _vm.disabled }},[(_vm.shouldShowLabel)?_c('span',{staticClass:"gl-toggle-label",attrs:{"data-testid":"toggle-label"}},[_vm._t("label",[_vm._v(_vm._s(_vm.label))])],2):_vm._e(),_vm._v(" "),(_vm.name)?_c('input',{attrs:{"name":_vm.name,"type":"hidden"},domProps:{"value":_vm.value}}):_vm._e(),_vm._v(" "),_c('button',{class:{
-        'gl-toggle': true,
-        'is-checked': _vm.value,
-        'is-disabled': _vm.disabled,
-      },attrs:{"role":"switch","aria-checked":_vm.isChecked,"aria-label":_vm.label,"aria-describedby":_vm.helpId,"type":"button"},on:{"click":function($event){$event.preventDefault();return _vm.toggleFeature($event)}}},[(_vm.isLoading)?_c('gl-loading-icon',{staticClass:"toggle-loading",attrs:{"color":"light"}}):_c('span',{class:{ 'toggle-icon': true, disabled: _vm.disabled }},[_c('gl-icon',{attrs:{"name":_vm.icon,"size":16}})],1)],1)]),_vm._v(" "),(_vm.help)?_c('span',{staticClass:"gl-help-label",attrs:{"id":_vm.helpId,"data-testid":"toggle-help"}},[_vm._t("help",[_vm._v(_vm._s(_vm.help))])],2):_vm._e()])};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{staticClass:"gl-toggle-wrapper gl-display-flex gl-flex-direction-column gl-mb-0 gl-w-max-content",class:{ 'gl-toggle-label-inline': _vm.labelPosition === 'left', 'is-disabled': _vm.disabled }},[_c('span',{staticClass:"gl-toggle-label",class:{ 'gl-sr-only': _vm.labelPosition === 'hidden' },attrs:{"id":_vm.labelId,"data-testid":"toggle-label"}},[_vm._t("label",[_vm._v(_vm._s(_vm.label))])],2),_vm._v(" "),(_vm.name)?_c('input',{attrs:{"name":_vm.name,"type":"hidden"},domProps:{"value":_vm.value}}):_vm._e(),_vm._v(" "),_c('button',{class:{
+      'gl-toggle': true,
+      'is-checked': _vm.value,
+      'is-disabled': _vm.disabled,
+    },attrs:{"role":"switch","aria-checked":_vm.isChecked,"aria-labelledby":_vm.labelId,"aria-describedby":_vm.helpId,"type":"button"},on:{"click":function($event){$event.preventDefault();return _vm.toggleFeature($event)}}},[(_vm.isLoading)?_c('gl-loading-icon',{staticClass:"toggle-loading",attrs:{"color":"light"}}):_c('span',{class:{ 'toggle-icon': true, disabled: _vm.disabled }},[_c('gl-icon',{attrs:{"name":_vm.icon,"size":16}})],1)],1),_vm._v(" "),(_vm.help)?_c('span',{staticClass:"gl-help-label",attrs:{"id":_vm.helpId,"data-testid":"toggle-help"}},[_vm._t("help",[_vm._v(_vm._s(_vm.help))])],2):_vm._e()])};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "32.28.0",
+  "version": "32.29.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/base/toggle/toggle.spec.js

@@ -8,12 +8,14 @@ describe('toggle', () => {
   let wrapper;
 
   const label = 'toggle label';
+  const labelId = 'toggle-label-id';
   const helpText = 'help text';
 
   const createWrapper = (props = {}) => {
     wrapper = shallowMount(Toggle, {
       propsData: {
         label,
+        labelId,
         ...props,
       },
     });
@@ -24,7 +26,6 @@ describe('toggle', () => {
 
   afterEach(() => {
     wrapper.destroy();
-    wrapper = null;
   });
 
   it('has role=switch', () => {
@@ -112,21 +113,25 @@ describe('toggle', () => {
 
   describe('label position', () => {
     describe.each`
-      state       | labelPosition                 | labelVisibility
-      ${'top'}    | ${toggleLabelPosition.top}    | ${true}
-      ${'left'}   | ${toggleLabelPosition.left}   | ${true}
-      ${'hidden'} | ${toggleLabelPosition.hidden} | ${false}
-    `('when $state', ({ labelPosition, labelVisibility }) => {
+      state       | labelPosition                 | hasGlSrOnlyClass
+      ${'top'}    | ${toggleLabelPosition.top}    | ${false}
+      ${'left'}   | ${toggleLabelPosition.left}   | ${false}
+      ${'hidden'} | ${toggleLabelPosition.hidden} | ${true}
+    `('when $state', ({ labelPosition, hasGlSrOnlyClass }) => {
       beforeEach(() => {
         createWrapper({ labelPosition });
       });
 
-      it(`${labelVisibility ? 'shows' : 'hides'} label`, () => {
-        expect(wrapper.find('[data-testid="toggle-label"]').exists()).toBe(labelVisibility);
+      it(`${hasGlSrOnlyClass ? 'adds' : 'does not add'} 'gl-sr-only' class to the label`, () => {
+        const cssClasses = wrapper.find('[data-testid="toggle-label"]').classes();
+
+        return hasGlSrOnlyClass
+          ? expect(cssClasses).toContain('gl-sr-only')
+          : expect(cssClasses).not.toContain('gl-sr-only');
       });
 
       it('has accessible name for the button', () => {
-        expect(findButton().attributes('aria-label')).toBe(label);
+        expect(findButton().attributes('aria-labelledby')).toBe(labelId);
       });
     });
   });

package/src/components/base/toggle/toggle.stories.js

@@ -9,6 +9,7 @@ const generateProps = ({
   disabled = defaultValue('disabled'),
   isLoading = defaultValue('isLoading'),
   label = 'Dark mode',
+  labelId = 'dark-mode-toggle',
   help = 'Toggle dark mode for the website',
   labelPosition = defaultValue('labelPosition'),
 } = {}) => ({
@@ -16,6 +17,7 @@ const generateProps = ({
   disabled,
   isLoading,
   label,
+  labelId,
   help,
   labelPosition,
 });
@@ -29,6 +31,7 @@ const Template = (args, { argTypes }) => ({
       v-model="value"
       :disabled="disabled"
       :help="help"
+      :label-id="labelId"
       :is-loading="isLoading"
       :label="label"
       :label-position="labelPosition"

package/src/components/base/toggle/toggle.vue

@@ -61,7 +61,14 @@ export default {
       default: undefined,
     },
     /**
-     * The label's position relative to the toggle.
+     * The id for the label. This id is used by the aria-labelledby attribute on the toggle button.
+     */
+    labelId: {
+      type: String,
+      required: true,
+    },
+    /**
+     * The label's position relative to the toggle. If 'hidden', the toggle will add the .gl-sr-only class so the label is still accessible to screen readers.
      */
     labelPosition: {
       type: String,
@@ -77,9 +84,6 @@ export default {
     icon() {
       return this.value ? 'mobile-issue-close' : 'close';
     },
-    shouldShowLabel() {
-      return this.label && this.labelPosition !== 'hidden';
-    },
     helpId() {
       return this.help ? `toggle-help-${this.uuid}` : undefined;
     },
@@ -110,38 +114,41 @@ export default {
 </script>
 
 <template>
-  <label class="gl-display-flex gl-flex-direction-column gl-mb-0 gl-w-max-content">
+  <div
+    class="gl-toggle-wrapper gl-display-flex gl-flex-direction-column gl-mb-0 gl-w-max-content"
+    :class="{ 'gl-toggle-label-inline': labelPosition === 'left', 'is-disabled': disabled }"
+  >
     <span
-      class="gl-toggle-wrapper"
-      :class="{ 'gl-toggle-label-inline': labelPosition === 'left', 'is-disabled': disabled }"
+      :id="labelId"
+      :class="{ 'gl-sr-only': labelPosition === 'hidden' }"
+      class="gl-toggle-label"
+      data-testid="toggle-label"
     >
-      <span v-if="shouldShowLabel" class="gl-toggle-label" data-testid="toggle-label">
-        <!-- @slot The toggle's label. -->
-        <slot name="label">{{ label }}</slot>
-      </span>
-      <input v-if="name" :name="name" :value="value" type="hidden" />
-      <button
-        role="switch"
-        :aria-checked="isChecked"
-        :aria-label="label"
-        :aria-describedby="helpId"
-        :class="{
-          'gl-toggle': true,
-          'is-checked': value,
-          'is-disabled': disabled,
-        }"
-        type="button"
-        @click.prevent="toggleFeature"
-      >
-        <gl-loading-icon v-if="isLoading" color="light" class="toggle-loading" />
-        <span v-else :class="{ 'toggle-icon': true, disabled: disabled }">
-          <gl-icon :name="icon" :size="16" />
-        </span>
-      </button>
+      <!-- @slot The toggle's label. -->
+      <slot name="label">{{ label }}</slot>
     </span>
+    <input v-if="name" :name="name" :value="value" type="hidden" />
+    <button
+      role="switch"
+      :aria-checked="isChecked"
+      :aria-labelledby="labelId"
+      :aria-describedby="helpId"
+      :class="{
+        'gl-toggle': true,
+        'is-checked': value,
+        'is-disabled': disabled,
+      }"
+      type="button"
+      @click.prevent="toggleFeature"
+    >
+      <gl-loading-icon v-if="isLoading" color="light" class="toggle-loading" />
+      <span v-else :class="{ 'toggle-icon': true, disabled: disabled }">
+        <gl-icon :name="icon" :size="16" />
+      </span>
+    </button>
     <span v-if="help" :id="helpId" class="gl-help-label" data-testid="toggle-help">
       <!-- @slot A help text to be shown below the toggle. -->
       <slot name="help">{{ help }}</slot>
     </span>
-  </label>
+  </div>
 </template>