@gitlab/ui/dist/vendor/bootstrap-vue/src/mixins/id.js

GitLab UI Components

import { extend, COMPONENT_UID_KEY } from '../vue';
import { PROP_TYPE_STRING } from '../constants/props';
import { makeProp } from '../utils/props';

// SSR safe client-side ID attribute generation

// --- Props ---

const props = {
  id: makeProp(PROP_TYPE_STRING)
};

// --- Mixin ---

// @vue/component
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]}`;
    });
  }
});

export { idMixin, props };