@gitlab/ui 128.17.1 → 129.0.0

package/dist/components/base/form/form_checkbox/form_checkbox.js

@@ -93,7 +93,8 @@ var script = {
      * Value returned when this checkbox is checked.
      */
     value: {
-      type: [Array, Boolean, String],
+      // `value` prop can be any type
+      type: undefined,
       required: false,
       default: true
     },
@@ -101,7 +102,8 @@ var script = {
      * Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array.
      */
     uncheckedValue: {
-      type: [Array, Boolean, String],
+      // `uncheckedValue` prop can be any type
+      type: undefined,
       required: false,
       default: false
     }

package/dist/components/base/form/form_radio/form_radio.js

@@ -1,27 +1,225 @@
-import { BFormRadio } from '../../../../vendor/bootstrap-vue/src/components/form-radio/form-radio';
+import uniqueId from 'lodash/uniqueId';
+import isBoolean from 'lodash/isBoolean';
+import { looseEqual } from '../../../../vendor/bootstrap-vue/src/utils/loose-equal';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
-const {
-  model
-} = BFormRadio.options;
 var script = {
   name: 'GlFormRadio',
-  components: {
-    BFormRadio
+  inject: {
+    getGroup: {
+      // When we remove BFormRadioGroup from GlFormRadioGroup, we can rename
+      // the `getBvRadioGroup` provide to `getRadioGroup`.
+      from: 'getBvRadioGroup',
+      default: () => () => null
+    }
   },
   inheritAttrs: false,
   model: {
-    prop: model.prop,
-    event: model.event
+    prop: 'checked',
+    event: 'input'
   },
   props: {
     /**
-     * Whether the radio is checked
+     * Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed.
+     */
+    id: {
+      type: String,
+      required: false,
+      default: undefined
+    },
+    /**
+     * The current value of the radio. When bound to multiple radios, this is the value of the currently selected radio.
      */
     checked: {
-      type: [String, Number, Boolean, Object],
+      // `checked` prop can be any type
+      type: undefined,
+      required: false,
+      default: null
+    },
+    /**
+     * When set to `true`, disables the component's functionality and places it in a disabled state.
+     */
+    disabled: {
+      type: Boolean,
       required: false,
       default: false
+    },
+    /**
+     * Sets the value of the `name` attribute on the form control.
+     */
+    name: {
+      type: String,
+      required: false,
+      default: undefined
+    },
+    /**
+     * Adds the `required` attribute to the form control.
+     */
+    required: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state.
+     */
+    state: {
+      type: Boolean,
+      required: false,
+      default: null
+    },
+    /**
+     * Value returned when this radio is selected.
+     */
+    value: {
+      // `value` prop can be any type
+      type: undefined,
+      required: false,
+      default: true
+    }
+  },
+  data() {
+    const group = this.getGroup();
+    return {
+      internalId: this.id ? this.id : uniqueId('gitlab_ui_radio_'),
+      localChecked: group ? group.checked : this.checked
+    };
+  },
+  computed: {
+    computedLocalChecked: {
+      get() {
+        return this.isGroup ? this.group.localChecked : this.localChecked;
+      },
+      set(value) {
+        if (this.isGroup) {
+          this.group.localChecked = value;
+        } else {
+          this.localChecked = value;
+        }
+      }
+    },
+    group() {
+      return this.getGroup();
+    },
+    isGroup() {
+      // Is this radio a child of radio-group?
+      return Boolean(this.group);
+    },
+    computedState() {
+      if (this.isGroup) return this.group.computedState;
+      return isBoolean(this.state) ? this.state : null;
+    },
+    stateClass() {
+      if (this.computedState === true) return 'is-valid';
+      if (this.computedState === false) return 'is-invalid';
+      return null;
+    },
+    computedAriaInvalid() {
+      return this.computedState === false ? 'true' : null;
+    },
+    isChecked() {
+      return looseEqual(this.computedLocalChecked, this.value);
+    },
+    isDisabled() {
+      // Child can be disabled while parent isn't, but is always disabled if group is
+      return this.isGroup ? this.group.disabled || this.disabled : this.disabled;
+    },
+    isRequired() {
+      // Required only works when a name is provided for the input(s)
+      // Child can only be required when parent is
+      // Groups will always have a name (either user supplied or auto generated)
+      return this.computedName && (this.isGroup ? this.group.required : this.required);
+    },
+    computedName() {
+      // Group name preferred over local name
+      return (this.isGroup ? this.group.groupName : this.name) || null;
+    },
+    computedAttrs() {
+      const {
+        isDisabled: disabled,
+        isRequired: required,
+        value,
+        isChecked: checked
+      } = this;
+      return {
+        ...this.$attrs,
+        id: this.internalId,
+        name: this.computedName,
+        disabled,
+        required,
+        value,
+        checked,
+        'aria-required': required || null,
+        'aria-invalid': this.computedAriaInvalid
+      };
+    }
+  },
+  watch: {
+    checked() {
+      this.checkedWatcher(...arguments);
+    },
+    computedLocalChecked() {
+      this.computedLocalCheckedWatcher(...arguments);
+    }
+  },
+  methods: {
+    checkedWatcher(newValue) {
+      if (!looseEqual(newValue, this.computedLocalChecked)) {
+        this.computedLocalChecked = newValue;
+      }
+    },
+    computedLocalCheckedWatcher(newValue, oldValue) {
+      if (!looseEqual(newValue, oldValue)) {
+        /**
+         * Emitted when the selected value is changed
+         *
+         * @event input
+         * @type {boolean} current selected value of radio group
+         */
+        this.$emit('input', newValue);
+      }
+    },
+    handleChange() {
+      const {
+        value
+      } = this;
+
+      // Update `computedLocalChecked`
+      this.computedLocalChecked = value;
+
+      // Fire events in a `$nextTick()` to ensure the `v-model` is updated
+      this.$nextTick(() => {
+        /**
+         * Emitted when the selected value is changed due to user interaction
+         *
+         * @event change
+         * @type {boolean} current selected value of radio group
+         */
+        this.$emit('change', value);
+
+        // If this is a child of a group, we emit a change event on it as well
+        if (this.isGroup) {
+          /**
+           * Emitted when the selected value is changed due to user interaction
+           *
+           * @event change
+           * @type {boolean} current selected value of radio group
+           */
+          this.group.$emit('change', value);
+        }
+      });
+    },
+    focus() {
+      if (!this.disabled) {
+        var _this$$refs$input;
+        (_this$$refs$input = this.$refs.input) === null || _this$$refs$input === void 0 ? void 0 : _this$$refs$input.focus();
+      }
+    },
+    blur() {
+      if (!this.disabled) {
+        var _this$$refs$input2;
+        (_this$$refs$input2 = this.$refs.input) === null || _this$$refs$input2 === void 0 ? void 0 : _this$$refs$input2.blur();
+      }
     }
   }
 };
@@ -30,7 +228,7 @@ 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('b-form-radio',_vm._b({staticClass:"gl-form-radio",attrs:{"checked":_vm.checked},on:{"input":function($event){return _vm.$emit('input', $event)},"change":function($event){return _vm.$emit('change', $event)}}},'b-form-radio',_vm.$attrs,false),[_vm._t("default"),_vm._v(" "),(_vm.$scopedSlots.help)?_c('p',{staticClass:"help-text"},[_vm._t("help")],2):_vm._e()],2)};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{staticClass:"gl-form-radio custom-radio custom-control"},[_c('input',_vm._b({key:"input",ref:"input",staticClass:"custom-control-input",class:_vm.stateClass,attrs:{"type":"radio"},on:{"change":_vm.handleChange}},'input',_vm.computedAttrs,false)),_vm._v(" "),_c('label',{staticClass:"custom-control-label",attrs:{"for":_vm.internalId}},[_vm._t("default"),_vm._v(" "),(Boolean(_vm.$scopedSlots.help))?_c('p',{staticClass:"help-text"},[_vm._t("help")],2):_vm._e()],2)])};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/package.json

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

package/src/components/base/form/form_checkbox/form_checkbox.vue

@@ -93,7 +93,8 @@ export default {
      * Value returned when this checkbox is checked.
      */
     value: {
-      type: [Array, Boolean, String],
+      // `value` prop can be any type
+      type: undefined,
       required: false,
       default: true,
     },
@@ -101,7 +102,8 @@ export default {
      * Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array.
      */
     uncheckedValue: {
-      type: [Array, Boolean, String],
+      // `uncheckedValue` prop can be any type
+      type: undefined,
       required: false,
       default: false,
     },

package/src/components/base/form/form_radio/form_radio.vue

@@ -1,51 +1,240 @@
 <script>
-import { BFormRadio } from '../../../../vendor/bootstrap-vue/src/components/form-radio/form-radio';
-
-const { model } = BFormRadio.options;
+import uniqueId from 'lodash/uniqueId';
+import isBoolean from 'lodash/isBoolean';
+import { looseEqual } from '../../../../vendor/bootstrap-vue/src/utils/loose-equal';
 
 export default {
   name: 'GlFormRadio',
-  components: { BFormRadio },
+  inject: {
+    getGroup: {
+      // When we remove BFormRadioGroup from GlFormRadioGroup, we can rename
+      // the `getBvRadioGroup` provide to `getRadioGroup`.
+      from: 'getBvRadioGroup',
+      default: () => () => null,
+    },
+  },
   inheritAttrs: false,
   model: {
-    prop: model.prop,
-    event: model.event,
+    prop: 'checked',
+    event: 'input',
   },
   props: {
     /**
-     * Whether the radio is checked
+     * Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed.
+     */
+    id: {
+      type: String,
+      required: false,
+      default: undefined,
+    },
+    /**
+     * The current value of the radio. When bound to multiple radios, this is the value of the currently selected radio.
      */
     checked: {
-      type: [String, Number, Boolean, Object],
+      // `checked` prop can be any type
+      type: undefined,
+      required: false,
+      default: null,
+    },
+    /**
+     * When set to `true`, disables the component's functionality and places it in a disabled state.
+     */
+    disabled: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Sets the value of the `name` attribute on the form control.
+     */
+    name: {
+      type: String,
+      required: false,
+      default: undefined,
+    },
+    /**
+     * Adds the `required` attribute to the form control.
+     */
+    required: {
+      type: Boolean,
       required: false,
       default: false,
     },
+    /**
+     * Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state.
+     */
+    state: {
+      type: Boolean,
+      required: false,
+      default: null,
+    },
+    /**
+     * Value returned when this radio is selected.
+     */
+    value: {
+      // `value` prop can be any type
+      type: undefined,
+      required: false,
+      default: true,
+    },
+  },
+  data() {
+    const group = this.getGroup();
+    return {
+      internalId: this.id ? this.id : uniqueId('gitlab_ui_radio_'),
+      localChecked: group ? group.checked : this.checked,
+    };
+  },
+  computed: {
+    computedLocalChecked: {
+      get() {
+        return this.isGroup ? this.group.localChecked : this.localChecked;
+      },
+      set(value) {
+        if (this.isGroup) {
+          this.group.localChecked = value;
+        } else {
+          this.localChecked = value;
+        }
+      },
+    },
+    group() {
+      return this.getGroup();
+    },
+    isGroup() {
+      // Is this radio a child of radio-group?
+      return Boolean(this.group);
+    },
+    computedState() {
+      if (this.isGroup) return this.group.computedState;
+      return isBoolean(this.state) ? this.state : null;
+    },
+    stateClass() {
+      if (this.computedState === true) return 'is-valid';
+      if (this.computedState === false) return 'is-invalid';
+      return null;
+    },
+    computedAriaInvalid() {
+      return this.computedState === false ? 'true' : null;
+    },
+    isChecked() {
+      return looseEqual(this.computedLocalChecked, this.value);
+    },
+    isDisabled() {
+      // Child can be disabled while parent isn't, but is always disabled if group is
+      return this.isGroup ? this.group.disabled || this.disabled : this.disabled;
+    },
+    isRequired() {
+      // Required only works when a name is provided for the input(s)
+      // Child can only be required when parent is
+      // Groups will always have a name (either user supplied or auto generated)
+      return this.computedName && (this.isGroup ? this.group.required : this.required);
+    },
+    computedName() {
+      // Group name preferred over local name
+      return (this.isGroup ? this.group.groupName : this.name) || null;
+    },
+    computedAttrs() {
+      const { isDisabled: disabled, isRequired: required, value, isChecked: checked } = this;
+
+      return {
+        ...this.$attrs,
+        id: this.internalId,
+        name: this.computedName,
+        disabled,
+        required,
+        value,
+        checked,
+        'aria-required': required || null,
+        'aria-invalid': this.computedAriaInvalid,
+      };
+    },
+  },
+  watch: {
+    checked(...args) {
+      this.checkedWatcher(...args);
+    },
+    computedLocalChecked(...args) {
+      this.computedLocalCheckedWatcher(...args);
+    },
+  },
+  methods: {
+    checkedWatcher(newValue) {
+      if (!looseEqual(newValue, this.computedLocalChecked)) {
+        this.computedLocalChecked = newValue;
+      }
+    },
+    computedLocalCheckedWatcher(newValue, oldValue) {
+      if (!looseEqual(newValue, oldValue)) {
+        /**
+         * Emitted when the selected value is changed
+         *
+         * @event input
+         * @type {boolean} current selected value of radio group
+         */
+        this.$emit('input', newValue);
+      }
+    },
+    handleChange() {
+      const { value } = this;
+
+      // Update `computedLocalChecked`
+      this.computedLocalChecked = value;
+
+      // Fire events in a `$nextTick()` to ensure the `v-model` is updated
+      this.$nextTick(() => {
+        /**
+         * Emitted when the selected value is changed due to user interaction
+         *
+         * @event change
+         * @type {boolean} current selected value of radio group
+         */
+        this.$emit('change', value);
+
+        // If this is a child of a group, we emit a change event on it as well
+        if (this.isGroup) {
+          /**
+           * Emitted when the selected value is changed due to user interaction
+           *
+           * @event change
+           * @type {boolean} current selected value of radio group
+           */
+          this.group.$emit('change', value);
+        }
+      });
+    },
+    focus() {
+      if (!this.disabled) {
+        this.$refs.input?.focus();
+      }
+    },
+    blur() {
+      if (!this.disabled) {
+        this.$refs.input?.blur();
+      }
+    },
   },
 };
 </script>
 
 <template>
-  <!--
-  Emitted when the selected value is changed
-  @event input
-  @type {boolean} current selected value of radio group
-
-  Emitted when the selected value is changed due to user interaction
-  @event change
-  @type {boolean} current selected value of radio group
-  -->
-  <b-form-radio
-    class="gl-form-radio"
-    :checked="checked"
-    v-bind="$attrs"
-    @input="$emit('input', $event)"
-    @change="$emit('change', $event)"
-  >
-    <!-- @slot Content to use for the label -->
-    <slot></slot>
-    <p v-if="$scopedSlots.help" class="help-text">
-      <!-- @slot Content provided here will be shown beneath the radio. Typically used for help or descriptive text. -->
-      <slot name="help"></slot>
-    </p>
-  </b-form-radio>
+  <div class="gl-form-radio custom-radio custom-control">
+    <input
+      ref="input"
+      key="input"
+      v-bind="computedAttrs"
+      type="radio"
+      class="custom-control-input"
+      :class="stateClass"
+      @change="handleChange"
+    />
+    <label :for="internalId" class="custom-control-label">
+      <!-- @slot Content to use for the label -->
+      <slot></slot>
+      <p v-if="Boolean($scopedSlots.help)" class="help-text">
+        <!-- @slot Content provided here will be shown beneath the radio. Typically used for help or descriptive text. -->
+        <slot name="help"></slot>
+      </p>
+    </label>
+  </div>
 </template>