@gitlab/ui 84.1.0 → 85.0.0

package/src/vendor/bootstrap-vue/src/mixins/form-text.js

@@ -0,0 +1,250 @@
+import { extend } from '../vue'
+import {
+  EVENT_NAME_BLUR,
+  EVENT_NAME_CHANGE,
+  EVENT_NAME_INPUT,
+  EVENT_NAME_UPDATE
+} from '../constants/events'
+import {
+  PROP_TYPE_BOOLEAN,
+  PROP_TYPE_BOOLEAN_STRING,
+  PROP_TYPE_FUNCTION,
+  PROP_TYPE_NUMBER_STRING,
+  PROP_TYPE_STRING
+} from '../constants/props'
+import { attemptBlur, attemptFocus } from '../utils/dom'
+import { stopEvent } from '../utils/events'
+import { mathMax } from '../utils/math'
+import { makeModelMixin } from '../utils/model'
+import { toInteger, toFloat } from '../utils/number'
+import { sortKeys } from '../utils/object'
+import { hasPropFunction, makeProp, makePropsConfigurable } from '../utils/props'
+import { toString } from '../utils/string'
+
+// --- Constants ---
+
+const {
+  mixin: modelMixin,
+  props: modelProps,
+  prop: MODEL_PROP_NAME,
+  event: MODEL_EVENT_NAME
+} = makeModelMixin('value', {
+  type: PROP_TYPE_NUMBER_STRING,
+  defaultValue: '',
+  event: EVENT_NAME_UPDATE
+})
+
+export { MODEL_PROP_NAME, MODEL_EVENT_NAME }
+
+// --- Props ---
+
+export const props = makePropsConfigurable(
+  sortKeys({
+    ...modelProps,
+    ariaInvalid: makeProp(PROP_TYPE_BOOLEAN_STRING, false),
+    autocomplete: makeProp(PROP_TYPE_STRING),
+    // Debounce timeout (in ms). Not applicable with `lazy` prop
+    debounce: makeProp(PROP_TYPE_NUMBER_STRING, 0),
+    formatter: makeProp(PROP_TYPE_FUNCTION),
+    // Only update the `v-model` on blur/change events
+    lazy: makeProp(PROP_TYPE_BOOLEAN, false),
+    lazyFormatter: makeProp(PROP_TYPE_BOOLEAN, false),
+    number: makeProp(PROP_TYPE_BOOLEAN, false),
+    placeholder: makeProp(PROP_TYPE_STRING),
+    plaintext: makeProp(PROP_TYPE_BOOLEAN, false),
+    readonly: makeProp(PROP_TYPE_BOOLEAN, false),
+    trim: makeProp(PROP_TYPE_BOOLEAN, false)
+  }),
+  'formTextControls'
+)
+
+// --- Mixin ---
+
+// @vue/component
+export const formTextMixin = extend({
+  mixins: [modelMixin],
+  props,
+  data() {
+    const value = this[MODEL_PROP_NAME]
+    return {
+      localValue: toString(value),
+      vModelValue: this.modifyValue(value)
+    }
+  },
+  computed: {
+    computedClass() {
+      const { plaintext, type } = this
+      const isRange = type === 'range'
+      const isColor = type === 'color'
+
+      return [
+        {
+          // Range input needs class `custom-range`
+          'custom-range': isRange,
+          // `plaintext` not supported by `type="range"` or `type="color"`
+          'form-control-plaintext': plaintext && !isRange && !isColor,
+          // `form-control` not used by `type="range"` or `plaintext`
+          // Always used by `type="color"`
+          'form-control': isColor || (!plaintext && !isRange)
+        },
+        this.sizeFormClass,
+        this.stateClass
+      ]
+    },
+    computedDebounce() {
+      // Ensure we have a positive number equal to or greater than 0
+      return mathMax(toInteger(this.debounce, 0), 0)
+    },
+    hasFormatter() {
+      return hasPropFunction(this.formatter)
+    }
+  },
+  watch: {
+    [MODEL_PROP_NAME](newValue) {
+      const stringifyValue = toString(newValue)
+      const modifiedValue = this.modifyValue(newValue)
+      if (stringifyValue !== this.localValue || modifiedValue !== this.vModelValue) {
+        // Clear any pending debounce timeout, as we are overwriting the user input
+        this.clearDebounce()
+        // Update the local values
+        this.localValue = stringifyValue
+        this.vModelValue = modifiedValue
+      }
+    }
+  },
+  created() {
+    // Create private non-reactive props
+    this.$_inputDebounceTimer = null
+  },
+  beforeDestroy() {
+    this.clearDebounce()
+  },
+  methods: {
+    clearDebounce() {
+      clearTimeout(this.$_inputDebounceTimer)
+      this.$_inputDebounceTimer = null
+    },
+    formatValue(value, event, force = false) {
+      value = toString(value)
+      if (this.hasFormatter && (!this.lazyFormatter || force)) {
+        value = this.formatter(value, event)
+      }
+      return value
+    },
+    modifyValue(value) {
+      value = toString(value)
+      // Emulate `.trim` modifier behaviour
+      if (this.trim) {
+        value = value.trim()
+      }
+      // Emulate `.number` modifier behaviour
+      if (this.number) {
+        value = toFloat(value, value)
+      }
+      return value
+    },
+    updateValue(value, force = false) {
+      const { lazy } = this
+      if (lazy && !force) {
+        return
+      }
+      // Make sure to always clear the debounce when `updateValue()`
+      // is called, even when the v-model hasn't changed
+      this.clearDebounce()
+      // Define the shared update logic in a method to be able to use
+      // it for immediate and debounced value changes
+      const doUpdate = () => {
+        value = this.modifyValue(value)
+        if (value !== this.vModelValue) {
+          this.vModelValue = value
+          this.$emit(MODEL_EVENT_NAME, value)
+        } else if (this.hasFormatter) {
+          // When the `vModelValue` hasn't changed but the actual input value
+          // is out of sync, make sure to change it to the given one
+          // Usually caused by browser autocomplete and how it triggers the
+          // change or input event, or depending on the formatter function
+          // https://github.com/bootstrap-vue/bootstrap-vue/issues/2657
+          // https://github.com/bootstrap-vue/bootstrap-vue/issues/3498
+          /* istanbul ignore next: hard to test */
+          const $input = this.$refs.input
+          /* istanbul ignore if: hard to test out of sync value */
+          if ($input && value !== $input.value) {
+            $input.value = value
+          }
+        }
+      }
+      // Only debounce the value update when a value greater than `0`
+      // is set and we are not in lazy mode or this is a forced update
+      const debounce = this.computedDebounce
+      if (debounce > 0 && !lazy && !force) {
+        this.$_inputDebounceTimer = setTimeout(doUpdate, debounce)
+      } else {
+        // Immediately update the v-model
+        doUpdate()
+      }
+    },
+    onInput(event) {
+      // `event.target.composing` is set by Vue
+      // https://github.com/vuejs/vue/blob/dev/src/platforms/web/runtime/directives/model.js
+      // TODO: Is this needed now with the latest Vue?
+      /* istanbul ignore if: hard to test composition events */
+      if (event.target.composing) {
+        return
+      }
+      const { value } = event.target
+      const formattedValue = this.formatValue(value, event)
+      // Exit when the `formatter` function strictly returned `false`
+      // or prevented the input event
+      /* istanbul ignore next */
+      if (formattedValue === false || event.defaultPrevented) {
+        stopEvent(event, { propagation: false })
+        return
+      }
+      this.localValue = formattedValue
+      this.updateValue(formattedValue)
+      this.$emit(EVENT_NAME_INPUT, formattedValue)
+    },
+    onChange(event) {
+      const { value } = event.target
+      const formattedValue = this.formatValue(value, event)
+      // Exit when the `formatter` function strictly returned `false`
+      // or prevented the input event
+      /* istanbul ignore next */
+      if (formattedValue === false || event.defaultPrevented) {
+        stopEvent(event, { propagation: false })
+        return
+      }
+      this.localValue = formattedValue
+      this.updateValue(formattedValue, true)
+      this.$emit(EVENT_NAME_CHANGE, formattedValue)
+    },
+    onBlur(event) {
+      // Apply the `localValue` on blur to prevent cursor jumps
+      // on mobile browsers (e.g. caused by autocomplete)
+      const { value } = event.target
+      const formattedValue = this.formatValue(value, event, true)
+      if (formattedValue !== false) {
+        // We need to use the modified value here to apply the
+        // `.trim` and `.number` modifiers properly
+        this.localValue = toString(this.modifyValue(formattedValue))
+        // We pass the formatted value here since the `updateValue` method
+        // handles the modifiers itself
+        this.updateValue(formattedValue, true)
+      }
+      // Emit native blur event
+      this.$emit(EVENT_NAME_BLUR, event)
+    },
+    focus() {
+      // For external handler that may want a focus method
+      if (!this.disabled) {
+        attemptFocus(this.$el)
+      }
+    },
+    blur() {
+      // For external handler that may want a blur method
+      if (!this.disabled) {
+        attemptBlur(this.$el)
+      }
+    }
+  }
+})

package/src/vendor/bootstrap-vue/src/mixins/form-validity.js

@@ -0,0 +1,48 @@
+import { extend } from '../vue'
+
+// @vue/component
+export const formValidityMixin = extend({
+  computed: {
+    validity: {
+      // Expose validity property
+      cache: false,
+      /* istanbul ignore next */
+      get() {
+        return this.$refs.input.validity
+      }
+    },
+    validationMessage: {
+      // Expose validationMessage property
+      cache: false,
+      /* istanbul ignore next */
+      get() {
+        return this.$refs.input.validationMessage
+      }
+    },
+    willValidate: {
+      // Expose willValidate property
+      cache: false,
+      /* istanbul ignore next */
+      get() {
+        return this.$refs.input.willValidate
+      }
+    }
+  },
+  methods: {
+    /* istanbul ignore next */
+    setCustomValidity() {
+      // For external handler that may want a setCustomValidity(...) method
+      return this.$refs.input.setCustomValidity(...arguments)
+    },
+    /* istanbul ignore next */
+    checkValidity() {
+      // For external handler that may want a checkValidity(...) method
+      return this.$refs.input.checkValidity(...arguments)
+    },
+    /* istanbul ignore next */
+    reportValidity() {
+      // For external handler that may want a reportValidity(...) method
+      return this.$refs.input.reportValidity(...arguments)
+    }
+  }
+})

package/src/vendor/bootstrap-vue/src/mixins/has-listener.js

@@ -0,0 +1,26 @@
+// Mixin to determine if an event listener has been registered
+// either via `v-on:name` (in the parent) or programmatically
+// via `vm.$on('name', ...)`
+// See: https://github.com/vuejs/vue/issues/10825
+import { isVue3, extend } from '../vue'
+import { isArray, isUndefined } from '../utils/inspect'
+
+// @vue/component
+export const hasListenerMixin = extend({
+  methods: {
+    hasListener(name) {
+      if (isVue3) {
+        return true
+      }
+      // Only includes listeners registered via `v-on:name`
+      const $listeners = this.$listeners || {}
+      // Includes `v-on:name` and `this.$on('name')` registered listeners
+      // Note this property is not part of the public Vue API, but it is
+      // the only way to determine if a listener was added via `vm.$on`
+      const $events = this._events || {}
+      // Registered listeners in `this._events` are always an array,
+      // but might be zero length
+      return !isUndefined($listeners[name]) || (isArray($events[name]) && $events[name].length > 0)
+    }
+  }
+})

package/src/vendor/bootstrap-vue/src/mixins/id.js

@@ -0,0 +1,51 @@
+// SSR safe client-side ID attribute generation
+// ID's can only be generated client-side, after mount
+// `this._uid` is not synched between server and client
+import { COMPONENT_UID_KEY, extend } from '../vue'
+import { PROP_TYPE_STRING } from '../constants/props'
+import { makeProp } from '../utils/props'
+
+// --- Props ---
+
+export const props = {
+  id: makeProp(PROP_TYPE_STRING)
+}
+
+// --- Mixin ---
+
+// @vue/component
+export const idMixin = extend({
+  props,
+  data() {
+    return {
+      localId_: null
+    }
+  },
+  computed: {
+    safeId() {
+      // Computed property that returns a dynamic function for creating the ID
+      // Reacts to changes in both `.id` and `.localId_` and regenerates a new function
+      const id = this.id || this.localId_
+
+      // We return a function that accepts an optional suffix string
+      // So this computed prop looks and works like a method
+      // but benefits from Vue's computed prop caching
+      const fn = suffix => {
+        if (!id) {
+          return null
+        }
+        suffix = String(suffix || '').replace(/\s+/g, '_')
+        return suffix ? id + '_' + suffix : id
+      }
+      return fn
+    }
+  },
+  mounted() {
+    // `mounted()` only occurs client-side
+    this.$nextTick(() => {
+      // Update DOM with auto-generated ID after mount
+      // to prevent SSR hydration errors
+      this.localId_ = `__BVID__${this[COMPONENT_UID_KEY]}`
+    })
+  }
+})

package/src/vendor/bootstrap-vue/src/mixins/listen-on-document.js

@@ -0,0 +1,64 @@
+import { extend } from '../vue'
+import { IS_BROWSER } from '../constants/env'
+import { EVENT_OPTIONS_NO_CAPTURE } from '../constants/events'
+import { arrayIncludes } from '../utils/array'
+import { eventOn, eventOff } from '../utils/events'
+import { keys } from '../utils/object'
+
+// --- Constants ---
+
+const PROP = '$_documentListeners'
+
+// --- Mixin ---
+
+// @vue/component
+export const listenOnDocumentMixin = extend({
+  created() {
+    // Define non-reactive property
+    // Object of arrays, keyed by event name,
+    // where value is an array of callbacks
+    this[PROP] = {}
+  },
+  beforeDestroy() {
+    // Unregister all registered listeners
+    keys(this[PROP] || {}).forEach(event => {
+      this[PROP][event].forEach(callback => {
+        this.listenOffDocument(event, callback)
+      })
+    })
+
+    this[PROP] = null
+  },
+  methods: {
+    registerDocumentListener(event, callback) {
+      if (this[PROP]) {
+        this[PROP][event] = this[PROP][event] || []
+        if (!arrayIncludes(this[PROP][event], callback)) {
+          this[PROP][event].push(callback)
+        }
+      }
+    },
+    unregisterDocumentListener(event, callback) {
+      if (this[PROP] && this[PROP][event]) {
+        this[PROP][event] = this[PROP][event].filter(cb => cb !== callback)
+      }
+    },
+
+    listenDocument(on, event, callback) {
+      on ? this.listenOnDocument(event, callback) : this.listenOffDocument(event, callback)
+    },
+    listenOnDocument(event, callback) {
+      if (IS_BROWSER) {
+        eventOn(document, event, callback, EVENT_OPTIONS_NO_CAPTURE)
+        this.registerDocumentListener(event, callback)
+      }
+    },
+    listenOffDocument(event, callback) {
+      if (IS_BROWSER) {
+        eventOff(document, event, callback, EVENT_OPTIONS_NO_CAPTURE)
+      }
+
+      this.unregisterDocumentListener(event, callback)
+    }
+  }
+})

package/src/vendor/bootstrap-vue/src/mixins/listen-on-document.spec.js

@@ -0,0 +1,117 @@
+import { mount } from '@vue/test-utils'
+import { listenOnDocumentMixin } from './listen-on-document'
+
+describe('mixins/listen-on-document', () => {
+  it('works', async () => {
+    const spyClick1 = jest.fn()
+    const spyClick2 = jest.fn()
+    const spyFocusin = jest.fn()
+
+    const TestComponent = {
+      mixins: [listenOnDocumentMixin],
+      props: {
+        offClickOne: {
+          type: Boolean,
+          default: false
+        }
+      },
+      mounted() {
+        this.listenOnDocument('click', spyClick1)
+        this.listenOnDocument('focusin', spyFocusin)
+        this.listenOnDocument('click', spyClick2)
+      },
+      watch: {
+        offClickOne(newValue) {
+          if (newValue) {
+            this.listenOffDocument('click', spyClick1)
+          }
+        }
+      },
+      render(h) {
+        return h('div', this.$slots.default)
+      }
+    }
+
+    const App = {
+      components: { TestComponent },
+      props: {
+        offClickOne: {
+          type: Boolean,
+          default: false
+        },
+        destroy: {
+          type: Boolean,
+          default: false
+        }
+      },
+      render(h) {
+        const props = {
+          offClickOne: this.offClickOne
+        }
+        return h('div', [
+          h('span', ''),
+          h('input', { type: 'text' }),
+          this.destroy ? h() : h(TestComponent, { props }, 'test-component')
+        ])
+      }
+    }
+
+    const wrapper = mount(App, {
+      attachTo: document.body,
+      propsData: {
+        destroy: false
+      }
+    })
+
+    expect(wrapper.vm).toBeDefined()
+    expect(wrapper.text()).toEqual('test-component')
+
+    expect(spyClick1).not.toHaveBeenCalled()
+    expect(spyClick2).not.toHaveBeenCalled()
+    expect(spyFocusin).not.toHaveBeenCalled()
+
+    const $span = wrapper.find('span')
+    expect($span.exists()).toBe(true)
+
+    const $input = wrapper.find('input')
+    expect($input.exists()).toBe(true)
+
+    await $input.trigger('focusin')
+    expect(spyClick1).not.toHaveBeenCalled()
+    expect(spyClick2).not.toHaveBeenCalled()
+    expect(spyFocusin).toHaveBeenCalledTimes(1)
+
+    await $span.trigger('click')
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(1)
+    expect(spyFocusin).toHaveBeenCalledTimes(1)
+
+    await wrapper.setProps({ offClickOne: true })
+    await $span.trigger('click')
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(2)
+    expect(spyFocusin).toHaveBeenCalledTimes(1)
+
+    await $input.trigger('focusin')
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(2)
+    expect(spyFocusin).toHaveBeenCalledTimes(2)
+
+    await wrapper.setProps({ destroy: true })
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(2)
+    expect(spyFocusin).toHaveBeenCalledTimes(2)
+
+    await $input.trigger('focusin')
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(2)
+    expect(spyFocusin).toHaveBeenCalledTimes(2)
+
+    await $span.trigger('click')
+    expect(spyClick1).toHaveBeenCalledTimes(1)
+    expect(spyClick2).toHaveBeenCalledTimes(2)
+    expect(spyFocusin).toHaveBeenCalledTimes(2)
+
+    wrapper.destroy()
+  })
+})

package/src/vendor/bootstrap-vue/src/mixins/listen-on-root.js

@@ -0,0 +1,121 @@
+import { extend } from '../vue'
+import { arrayIncludes } from '../utils/array'
+import { keys } from '../utils/object'
+import { getEventRoot } from '../utils/get-event-root'
+// --- Constants ---
+
+const PROP = '$_rootListeners'
+
+// --- Mixin ---
+
+// @vue/component
+export const listenOnRootMixin = extend({
+  computed: {
+    bvEventRoot() {
+      return getEventRoot(this)
+    }
+  },
+  created() {
+    // Define non-reactive property
+    // Object of arrays, keyed by event name,
+    // where value is an array of callbacks
+    this[PROP] = {}
+  },
+  beforeDestroy() {
+    // Unregister all registered listeners
+    keys(this[PROP] || {}).forEach(event => {
+      this[PROP][event].forEach(callback => {
+        this.listenOffRoot(event, callback)
+      })
+    })
+
+    this[PROP] = null
+  },
+  methods: {
+    registerRootListener(event, callback) {
+      if (this[PROP]) {
+        this[PROP][event] = this[PROP][event] || []
+        if (!arrayIncludes(this[PROP][event], callback)) {
+          this[PROP][event].push(callback)
+        }
+      }
+    },
+    unregisterRootListener(event, callback) {
+      if (this[PROP] && this[PROP][event]) {
+        this[PROP][event] = this[PROP][event].filter(cb => cb !== callback)
+      }
+    },
+
+    /**
+     * Safely register event listeners on the root Vue node
+     * While Vue automatically removes listeners for individual components,
+     * when a component registers a listener on `$root` and is destroyed,
+     * this orphans a callback because the node is gone, but the `$root`
+     * does not clear the callback
+     *
+     * When registering a `$root` listener, it also registers the listener
+     * to be removed in the component's `beforeDestroy()` hook
+     *
+     * @param {string} event
+     * @param {function} callback
+     */
+    listenOnRoot(event, callback) {
+      if (this.bvEventRoot) {
+        this.bvEventRoot.$on(event, callback)
+        this.registerRootListener(event, callback)
+      }
+    },
+
+    /**
+     * Safely register a `$once()` event listener on the root Vue node
+     * While Vue automatically removes listeners for individual components,
+     * when a component registers a listener on `$root` and is destroyed,
+     * this orphans a callback because the node is gone, but the `$root`
+     * does not clear the callback
+     *
+     * When registering a `$root` listener, it also registers the listener
+     * to be removed in the component's `beforeDestroy()` hook
+     *
+     * @param {string} event
+     * @param {function} callback
+     */
+    listenOnRootOnce(event, callback) {
+      if (this.bvEventRoot) {
+        const _callback = (...args) => {
+          this.unregisterRootListener(_callback)
+          // eslint-disable-next-line node/no-callback-literal
+          callback(...args)
+        }
+
+        this.bvEventRoot.$once(event, _callback)
+        this.registerRootListener(event, _callback)
+      }
+    },
+
+    /**
+     * Safely unregister event listeners from the root Vue node
+     *
+     * @param {string} event
+     * @param {function} callback
+     */
+    listenOffRoot(event, callback) {
+      this.unregisterRootListener(event, callback)
+
+      if (this.bvEventRoot) {
+        this.bvEventRoot.$off(event, callback)
+      }
+    },
+
+    /**
+     * Convenience method for calling `vm.$emit()` on `$root`
+     *
+     * @param {string} event
+     * @param {*} args
+     */
+    emitOnRoot(event, ...args) {
+      if (this.bvEventRoot) {
+        this.bvEventRoot.$emit(event, ...args)
+      }
+    }
+  }
+})