@gitlab/ui 138.0.0 → 138.1.0

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

@@ -1,17 +1,185 @@
 <script>
-import { isObject } from 'lodash-es';
-import { BFormSelect } from '../../../../vendor/bootstrap-vue/src/components/form-select/form-select';
+import { isObject, uniqueId, isPlainObject, isBoolean, isUndefined, isNull, get } from 'lodash-es';
 import { formInputWidths } from '../../../../utils/constants';
+import { isVisible } from '../../../../utils/utils';
+import { SafeHtmlDirective as SafeHtml } from '../../../../directives/safe_html/safe_html';
 
 export default {
   name: 'GlFormSelect',
-  components: {
-    BFormSelect,
+  directives: {
+    SafeHtml,
   },
   inheritAttrs: false,
   props: {
     /**
-     * Width of the select element.
+     * Current value of the select. Should be set to an array when the 'multiple' prop is set
+     */
+    value: {
+      // Value can be any type!
+      type: undefined,
+      required: false,
+      default: undefined,
+    },
+    /**
+     * Array of items to render in the component
+     */
+    options: {
+      type: [Array, Object],
+      required: false,
+      default: undefined,
+    },
+    /**
+     * When set to a number larger than 0, will set the number of display option rows. Note not all browser will respect this setting
+     * @deprecated Only useful with `multiple`, which is also deprecated.
+     */
+    selectSize: {
+      type: Number,
+      required: false,
+      default: 0,
+    },
+    /**
+     * 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,
+    },
+    /**
+     * Render the form control in plain mode, rather than custom styled mode
+     * @deprecated Use a native <select> element instead.
+     */
+    plain: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'
+     * @deprecated Has no effect. Use the `width` prop instead.
+     */
+    size: {
+      type: String,
+      required: false,
+      default: undefined,
+    },
+    /**
+     * Optional value to set for the 'aria-invalid' attribute. Supported values are 'true' and 'false'. If not set, the 'state' prop will dictate the value
+     */
+    ariaInvalid: {
+      type: [Boolean, String],
+      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: {
+      // Tri-state prop: true, false, null (or undefined)
+      type: Boolean,
+      required: false,
+      default: null,
+    },
+    /**
+     * Field name in the `options` array that should be used for the value
+     */
+    valueField: {
+      type: String,
+      required: false,
+      default: 'value',
+    },
+    /**
+     * The key to use from the option object to get the label
+     */
+    labelField: {
+      type: String,
+      required: false,
+      default: 'label',
+    },
+    /**
+     * The key to use from the option object to get the options
+     */
+    optionsField: {
+      type: String,
+      required: false,
+      default: 'options',
+    },
+    /**
+     * Field name in the `options` array that should be used for the text label
+     */
+    textField: {
+      type: String,
+      required: false,
+      default: 'text',
+    },
+    /**
+     * Field name in the `options` array that should be used for the disabled state
+     */
+    disabledField: {
+      type: String,
+      required: false,
+      default: 'disabled',
+    },
+    /**
+     * Field name in the `options` array that should be used for the html label instead of text field
+     * @deprecated Using the `.html` field (whatever its name) is potentially unsafe.
+     */
+    htmlField: {
+      type: String,
+      required: false,
+      default: 'html',
+    },
+    /**
+     * When set, allows multiple options to be selected (multi-select)
+     * @deprecated Use GlCollapsibleListbox instead.
+     */
+    multiple: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control
+     */
+    autofocus: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * When set to `true`, disables the component's functionality and places it in a disabled state
+     */
+    disabled: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * ID of the form that the form control belongs to. Sets the `form` attribute on the control
+     */
+    form: {
+      type: String,
+      required: false,
+      default: undefined,
+    },
+    /**
+     * 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,
+    },
+    /**
+     * Maximum width of the Select
      */
     width: {
       type: [String, Object],
@@ -32,7 +200,32 @@ export default {
       default: '',
     },
   },
+  data() {
+    return {
+      localValue: this.value,
+      localId: null,
+    };
+  },
   computed: {
+    computedId() {
+      return this.id || this.localId;
+    },
+    computedSelectSize() {
+      // Custom selects with a size of zero causes the arrows to be hidden,
+      // so dont render the size attribute in this case
+      return !this.plain && this.selectSize === 0 ? null : this.selectSize;
+    },
+    computedAriaInvalid() {
+      const { ariaInvalid } = this;
+      if (ariaInvalid === true || ariaInvalid === 'true' || ariaInvalid === '') {
+        return 'true';
+      }
+      return this.computedState === false ? 'true' : ariaInvalid;
+    },
+    computedState() {
+      // If not a boolean, ensure that value is null
+      return isBoolean(this.state) ? this.state : null;
+    },
     cssClasses() {
       if (this.width === null) {
         return [];
@@ -54,15 +247,202 @@ export default {
       // eslint-disable-next-line @gitlab/tailwind-no-interpolation -- Not a CSS utility
       return [`gl-form-select-${this.width}`];
     },
+    stateClass() {
+      if (this.computedState === true) return 'is-valid';
+      if (this.computedState === false) return 'is-invalid';
+      return null;
+    },
+    inputClass() {
+      return [
+        'gl-form-select',
+        this.plain ? 'form-control' : 'custom-select',
+        this.size && this.plain ? `form-control-${this.size}` : null,
+        this.size && !this.plain ? `custom-select-${this.size}` : null,
+        this.stateClass,
+        this.selectClass,
+      ];
+    },
+    normalizedOptions() {
+      return this.normalizeOptions(this.options);
+    },
+  },
+  watch: {
+    value(newValue) {
+      this.localValue = newValue;
+    },
+    localValue(newValue) {
+      /**
+       * Emitted when the select value changes
+       *
+       * @event input
+       * @type {any}
+       */
+      this.$emit('input', newValue);
+    },
+  },
+  activated() {
+    this.handleAutofocus();
+  },
+  async mounted() {
+    this.handleAutofocus();
+    await this.$nextTick();
+    // Update DOM with auto-generated ID after mount
+    // to prevent SSR hydration errors
+    this.localId = uniqueId('gl-form-select-');
+  },
+  methods: {
+    focus() {
+      this.$refs.select?.focus();
+    },
+    blur() {
+      this.$refs.select?.blur();
+    },
+    normalizeOptions(options) {
+      // Normalize the given options array
+      if (Array.isArray(options)) return options.map((option) => this.normalizeOption(option));
+
+      if (isPlainObject(options)) {
+        if (process.env.NODE_ENV !== 'production') {
+          // Deprecate the object options format
+          // eslint-disable-next-line no-console
+          console.warn(
+            '[@gitlab/ui] GlFormSelect - Setting prop "options" to an object is deprecated. Use the array format instead.',
+          );
+        }
+
+        // Normalize a `options` object to an array of options
+        return Object.keys(options).map((key) => this.normalizeOption(options[key] || {}, key));
+      }
+
+      // If not an array or object, return an empty array
+      return [];
+    },
+    normalizeOption(option, key = null) {
+      // When the option is an object, normalize it
+      if (isPlainObject(option)) {
+        const value = get(option, this.valueField);
+        const text = get(option, this.textField);
+        const options = get(option, this.optionsField, null);
+        // When it has options, create an <optgroup> object
+        if (!isNull(options)) {
+          return {
+            label: String(get(option, this.labelField) || text),
+            options: this.normalizeOptions(options),
+          };
+        }
+        // Otherwise create an <option> object
+        return {
+          value: isUndefined(value) ? key || text : value,
+          text: String(isUndefined(text) ? key : text),
+          html: get(option, this.htmlField),
+          disabled: Boolean(get(option, this.disabledField)),
+        };
+      }
+      // Otherwise create an <option> object from the given value
+      return {
+        value: key || option,
+        text: String(option),
+        disabled: false,
+      };
+    },
+    isOptionGroup(option) {
+      return Array.isArray(option.options);
+    },
+    async onChange(event) {
+      const { target } = event;
+      const selectedValue = Array.from(target.options)
+        .filter((option) => option.selected)
+        // NOTE: the _value property is set up by both Vue 2 and 3 explicitly for the
+        // purpose of handling non-string values on form elements.
+        //
+        // See:
+        // - https://github.com/vuejs/vue/blob/v2.7.16/src/platforms/web/runtime/modules/dom-props.ts#L42-L44
+        // - https://github.com/vuejs/vue/blob/v2.7.16/test/unit/modules/vdom/modules/dom-props.spec.ts#L38
+        // - https://github.com/vuejs/core/blob/v3.4.27/packages/runtime-dom/src/modules/props.ts#L48-L50
+        // - https://github.com/vuejs/core/blob/v3.4.27/packages/runtime-dom/__tests__/patchProps.spec.ts#L25
+        // eslint-disable-next-line no-underscore-dangle
+        .map((option) => ('_value' in option ? option._value : option.value));
+
+      this.localValue = target.multiple ? selectedValue : selectedValue[0];
+
+      await this.$nextTick();
+      /**
+       * Emitted when the select value changes via user interaction
+       *
+       * @event change
+       * @type {any}
+       */
+      this.$emit('change', this.localValue);
+    },
+    async handleAutofocus() {
+      await this.$nextTick();
+      window.requestAnimationFrame(() => {
+        if (this.autofocus && isVisible(this.$refs.select)) this.focus();
+      });
+    },
   },
 };
 </script>
 <template>
   <span class="gl-form-select-wrapper" :class="cssClasses">
-    <b-form-select class="gl-form-select" v-bind="$attrs" :class="selectClass" v-on="$listeners">
-      <template v-for="slot in Object.keys($slots)" #[slot]>
-        <slot :name="slot"></slot>
+    <select
+      :id="computedId"
+      ref="select"
+      v-model="localValue"
+      :aria-invalid="computedAriaInvalid"
+      :aria-required="required ? 'true' : null"
+      :class="inputClass"
+      :disabled="disabled"
+      :form="form"
+      :multiple="multiple"
+      :name="name"
+      :required="required"
+      :size="computedSelectSize"
+      v-bind="$attrs"
+      @change="onChange"
+    >
+      <!-- @slot Slot to place options or option groups above options provided via the 'options' prop -->
+      <slot name="first"></slot>
+
+      <template v-for="(option, index) of normalizedOptions">
+        <template v-if="isOptionGroup(option)">
+          <optgroup :key="index" :label="option.label">
+            <template v-for="(childOption, childIndex) of option.options">
+              <option
+                v-if="childOption.html"
+                :key="`${childIndex}-html`"
+                v-safe-html="childOption.html"
+                :value="childOption.value"
+                :disabled="childOption.disabled"
+              ></option>
+              <option
+                v-else
+                :key="childIndex"
+                :value="childOption.value"
+                :disabled="childOption.disabled"
+              >
+                {{ childOption.text }}
+              </option>
+            </template>
+          </optgroup>
+        </template>
+
+        <template v-else>
+          <option
+            v-if="option.html"
+            :key="`${index}-html`"
+            v-safe-html="option.html"
+            :value="option.value"
+            :disabled="option.disabled"
+          ></option>
+          <option v-else :key="index" :value="option.value" :disabled="option.disabled">
+            {{ option.text }}
+          </option>
+        </template>
       </template>
-    </b-form-select>
+
+      <!-- @slot Content to place in the form select after 'options' prop options -->
+      <slot></slot>
+    </select>
   </span>
 </template>

package/src/vendor/bootstrap-vue/src/constants/components.js

@@ -14,9 +14,6 @@ export const NAME_FORM = 'BForm'
 export const NAME_FORM_GROUP = 'BFormGroup'
 export const NAME_FORM_INVALID_FEEDBACK = 'BFormInvalidFeedback'
 export const NAME_FORM_ROW = 'BFormRow'
-export const NAME_FORM_SELECT = 'BFormSelect'
-export const NAME_FORM_SELECT_OPTION = 'BFormSelectOption'
-export const NAME_FORM_SELECT_OPTION_GROUP = 'BFormSelectOptionGroup'
 export const NAME_FORM_TEXT = 'BFormText'
 export const NAME_FORM_VALID_FEEDBACK = 'BFormValidFeedback'
 export const NAME_LINK = 'BLink'

package/dist/vendor/bootstrap-vue/src/components/form-select/form-select-option-group.js

@@ -1,51 +0,0 @@
-import { extend } from '../../vue';
-import { NAME_FORM_SELECT_OPTION_GROUP } from '../../constants/components';
-import { SLOT_NAME_FIRST } from '../../constants/slots';
-import { htmlOrText } from '../../utils/html';
-import { sortKeys } from '../../utils/object';
-import { props as props$1, formOptionsMixin } from '../../mixins/form-options';
-import { normalizeSlotMixin } from '../../mixins/normalize-slot';
-import { BFormSelectOption } from './form-select-option';
-
-// --- Props ---
-
-const props = sortKeys({
-  ...props$1,
-  label: {
-    type: String,
-    required: true
-  }
-});
-
-// --- Main component ---
-
-// @vue/component
-const BFormSelectOptionGroup = /*#__PURE__*/extend({
-  name: NAME_FORM_SELECT_OPTION_GROUP,
-  mixins: [normalizeSlotMixin, formOptionsMixin],
-  props,
-  render(h) {
-    const label = this.label;
-    const $options = this.formOptions.map((option, index) => {
-      const value = option.value,
-        text = option.text,
-        html = option.html,
-        disabled = option.disabled;
-      return h(BFormSelectOption, {
-        attrs: {
-          value,
-          disabled
-        },
-        domProps: htmlOrText(html, text),
-        key: `option_${index}`
-      });
-    });
-    return h('optgroup', {
-      attrs: {
-        label
-      }
-    }, [this.normalizeSlot(SLOT_NAME_FIRST), $options, this.normalizeSlot()]);
-  }
-});
-
-export { BFormSelectOptionGroup, props };

package/dist/vendor/bootstrap-vue/src/components/form-select/form-select-option.js

@@ -1,41 +0,0 @@
-import { extend, mergeData } from '../../vue';
-import { NAME_FORM_SELECT_OPTION } from '../../constants/components';
-
-// --- Props ---
-
-const props = {
-  disabled: {
-    type: Boolean,
-    required: false,
-    default: false
-  },
-  value: {
-    required: true
-  }
-};
-
-// --- Main component ---
-
-// @vue/component
-const BFormSelectOption = /*#__PURE__*/extend({
-  name: NAME_FORM_SELECT_OPTION,
-  functional: true,
-  props,
-  render(h, _ref) {
-    let props = _ref.props,
-      data = _ref.data,
-      children = _ref.children;
-    const value = props.value,
-      disabled = props.disabled;
-    return h('option', mergeData(data, {
-      attrs: {
-        disabled
-      },
-      domProps: {
-        value
-      }
-    }), children);
-  }
-});
-
-export { BFormSelectOption, props };

package/dist/vendor/bootstrap-vue/src/components/form-select/form-select.js

@@ -1,153 +0,0 @@
-import { extend } from '../../vue';
-import { NAME_FORM_SELECT } from '../../constants/components';
-import { EVENT_NAME_CHANGE, EVENT_NAME_INPUT } from '../../constants/events';
-import { SLOT_NAME_FIRST } from '../../constants/slots';
-import { from } from '../../utils/array';
-import { attemptFocus, attemptBlur } from '../../utils/dom';
-import { htmlOrText } from '../../utils/html';
-import { isArray } from '../../utils/inspect';
-import { sortKeys } from '../../utils/object';
-import { props as props$2, formControlMixin } from '../../mixins/form-control';
-import { props as props$3, formCustomMixin } from '../../mixins/form-custom';
-import { props as props$4, formSizeMixin } from '../../mixins/form-size';
-import { props as props$5, formStateMixin } from '../../mixins/form-state';
-import { normalizeSlotMixin } from '../../mixins/normalize-slot';
-import { props as props$1, idMixin } from '../../mixins/id';
-import { optionsMixin } from './helpers/mixin-options';
-import { BFormSelectOption } from './form-select-option';
-import { BFormSelectOptionGroup } from './form-select-option-group';
-
-const MODEL_PROP_NAME = 'value';
-const MODEL_EVENT_NAME = EVENT_NAME_INPUT;
-
-// --- Props ---
-
-const props = sortKeys({
-  ...props$1,
-  [MODEL_PROP_NAME]: {},
-  ...props$2,
-  ...props$3,
-  ...props$4,
-  ...props$5,
-  ariaInvalid: {
-    type: [Boolean, String],
-    required: false,
-    default: false
-  },
-  multiple: {
-    type: Boolean,
-    required: false,
-    default: false
-  },
-  // Browsers default size to `0`, which shows 4 rows in most browsers in multiple mode
-  // Size of `1` can bork out Firefox
-  selectSize: {
-    type: Number,
-    required: false,
-    default: 0
-  }
-});
-
-// --- Main component ---
-
-// @vue/component
-const BFormSelect = /*#__PURE__*/extend({
-  name: NAME_FORM_SELECT,
-  mixins: [idMixin, formControlMixin, formSizeMixin, formStateMixin, formCustomMixin, optionsMixin, normalizeSlotMixin],
-  model: {
-    prop: MODEL_PROP_NAME,
-    event: MODEL_EVENT_NAME
-  },
-  props,
-  data() {
-    return {
-      localValue: this[MODEL_PROP_NAME]
-    };
-  },
-  computed: {
-    computedSelectSize() {
-      // Custom selects with a size of zero causes the arrows to be hidden,
-      // so dont render the size attribute in this case
-      return !this.plain && this.selectSize === 0 ? null : this.selectSize;
-    },
-    inputClass() {
-      return [this.plain ? 'form-control' : 'custom-select', this.size && this.plain ? `form-control-${this.size}` : null, this.size && !this.plain ? `custom-select-${this.size}` : null, this.stateClass];
-    }
-  },
-  watch: {
-    value(newValue) {
-      this.localValue = newValue;
-    },
-    localValue() {
-      this.$emit(MODEL_EVENT_NAME, this.localValue);
-    }
-  },
-  methods: {
-    focus() {
-      attemptFocus(this.$refs.input);
-    },
-    blur() {
-      attemptBlur(this.$refs.input);
-    },
-    onChange(event) {
-      const target = event.target;
-      const selectedValue = from(target.options).filter(o => o.selected).map(o => '_value' in o ? o._value : o.value);
-      this.localValue = target.multiple ? selectedValue : selectedValue[0];
-      this.$nextTick(() => {
-        this.$emit(EVENT_NAME_CHANGE, this.localValue);
-      });
-    }
-  },
-  render(h) {
-    const name = this.name,
-      disabled = this.disabled,
-      required = this.required,
-      size = this.computedSelectSize,
-      value = this.localValue;
-    const $options = this.formOptions.map((option, index) => {
-      const value = option.value,
-        label = option.label,
-        options = option.options,
-        disabled = option.disabled;
-      const key = `option_${index}`;
-      return isArray(options) ? h(BFormSelectOptionGroup, {
-        props: {
-          label,
-          options
-        },
-        key
-      }) : h(BFormSelectOption, {
-        props: {
-          value,
-          disabled
-        },
-        domProps: htmlOrText(option.html, option.text),
-        key
-      });
-    });
-    return h('select', {
-      class: this.inputClass,
-      attrs: {
-        id: this.safeId(),
-        name,
-        form: this.form || null,
-        multiple: this.multiple || null,
-        size,
-        disabled,
-        required,
-        'aria-required': required ? 'true' : null,
-        'aria-invalid': this.computedAriaInvalid
-      },
-      on: {
-        change: this.onChange
-      },
-      directives: [{
-        name: 'model',
-        value
-      }],
-      ref: 'input'
-    }, [this.normalizeSlot(SLOT_NAME_FIRST), $options, this.normalizeSlot()]);
-  }
-});
-
-export { BFormSelect, props };