@gitlab/ui/dist/vendor/bootstrap-vue/src/components/table/helpers/mixin-items.js

GitLab UI Components

import { extend } from '../../../vue';
import { EVENT_NAME_CONTEXT_CHANGED, EVENT_NAME_INPUT } from '../../../constants/events';
import { useParentMixin } from '../../../mixins/use-parent';
import { isArray, isString, isFunction } from '../../../utils/inspect';
import { looseEqual } from '../../../utils/loose-equal';
import { mathMax } from '../../../utils/math';
import { toInteger } from '../../../utils/number';
import { sortKeys, clone } from '../../../utils/object';
import { safeVueInstance } from '../../../utils/safe-vue-instance';
import { normalizeFields } from './normalize-fields';

// --- Constants ---

const MODEL_PROP_NAME = 'value';
const MODEL_EVENT_NAME = EVENT_NAME_INPUT;

// --- Props ---

const props = sortKeys({
  fields: {
    type: Array,
    required: false,
    default: null
  },
  // Provider mixin adds in `Function` type
  items: {
    type: Array,
    required: false,
    default: () => []
  },
  // Primary key for record
  // If provided the value in each row must be unique!
  primaryKey: {
    type: String,
    required: false,
    default: undefined
  },
  // `v-model` for retrieving the current displayed rows
  [MODEL_PROP_NAME]: {
    type: Array,
    required: false,
    default: () => []
  }
});

// --- Mixin ---

// @vue/component
const itemsMixin = extend({
  mixins: [useParentMixin],
  model: {
    prop: MODEL_PROP_NAME,
    event: MODEL_EVENT_NAME
  },
  props,
  data() {
    const items = this.items;
    return {
      // Our local copy of the items
      // Must be an array
      localItems: isArray(items) ? items.slice() : []
    };
  },
  computed: {
    computedFields() {
      // We normalize fields into an array of objects
      // `[ { key:..., label:..., ...}, {...}, ..., {..}]`
      return normalizeFields(this.fields, this.localItems);
    },
    computedFieldsObj() {
      // Fields as a simple lookup hash object
      // Mainly for formatter lookup and use in `scopedSlots` for convenience
      // If the field has a formatter, it normalizes formatter to a
      // function ref or `undefined` if no formatter
      const bvParent = this.bvParent;
      return this.computedFields.reduce((obj, f) => {
        // We use object spread here so we don't mutate the original field object
        obj[f.key] = clone(f);
        if (f.formatter) {
          // Normalize formatter to a function ref or `undefined`
          let formatter = f.formatter;
          if (isString(formatter) && isFunction(bvParent[formatter])) {
            formatter = bvParent[formatter];
          } else if (!isFunction(formatter)) {
            /* istanbul ignore next */
            formatter = undefined;
          }
          // Return formatter function or `undefined` if none
          obj[f.key].formatter = formatter;
        }
        return obj;
      }, {});
    },
    computedItems() {
      const _safeVueInstance = safeVueInstance(this),
        paginatedItems = _safeVueInstance.paginatedItems,
        sortedItems = _safeVueInstance.sortedItems,
        filteredItems = _safeVueInstance.filteredItems,
        localItems = _safeVueInstance.localItems;
      // Fallback if various mixins not provided
      return (paginatedItems || sortedItems || filteredItems || localItems || /* istanbul ignore next */
      []).slice();
    },
    context() {
      const _safeVueInstance2 = safeVueInstance(this),
        perPage = _safeVueInstance2.perPage,
        currentPage = _safeVueInstance2.currentPage;
      // Current state of sorting, filtering and pagination props/values
      return {
        filter: this.localFilter,
        sortBy: this.localSortBy,
        sortDesc: this.localSortDesc,
        perPage: mathMax(toInteger(perPage, 0), 0),
        currentPage: mathMax(toInteger(currentPage, 0), 1),
        apiUrl: this.apiUrl
      };
    }
  },
  watch: {
    items(newValue) {
      // Set `localItems`/`filteredItems` to a copy of the provided array
      this.localItems = isArray(newValue) ? newValue.slice() : [];
    },
    // Watch for changes on `computedItems` and update the `v-model`
    computedItems(newValue, oldValue) {
      if (!looseEqual(newValue, oldValue)) {
        this.$emit(MODEL_EVENT_NAME, newValue);
      }
    },
    // Watch for context changes
    context(newValue, oldValue) {
      // Emit context information for external paging/filtering/sorting handling
      if (!looseEqual(newValue, oldValue)) {
        this.$emit(EVENT_NAME_CONTEXT_CHANGED, newValue);
        // Clear selection on context change if selectable (defined in mixin-selectable.js)
        if (this.hasSelectableRowClick) {
          this.clearSelected();
        }
      }
    }
  },
  mounted() {
    // Initially update the `v-model` of displayed items
    this.$emit(MODEL_EVENT_NAME, this.computedItems);
  },
  methods: {
    // Method to get the formatter method for a given field key
    getFieldFormatter(key) {
      const field = this.computedFieldsObj[key];
      // `this.computedFieldsObj` has pre-normalized the formatter to a
      // function ref if present, otherwise `undefined`
      return field ? field.formatter : undefined;
    }
  }
});

export { itemsMixin, props };