All files / app/assets/javascripts/vue_shared/components dropdown_keyboard_navigation.vue

0% Statements 0/28
0% Branches 0/14
0% Functions 0/7
0% Lines 0/28

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107                                                                                                                                                                                                                     
<script>
import { UP_KEY_CODE, DOWN_KEY_CODE, TAB_KEY_CODE } from '~/lib/utils/keycodes';
 
export default {
  model: {
    prop: 'index',
    event: 'change',
  },
  props: {
    /* v-model property to manage location in list */
    index: {
      type: Number,
      required: true,
    },
    /* Highest index that can be navigated to */
    max: {
      type: Number,
      required: true,
    },
    /* Lowest index that can be navigated to */
    min: {
      type: Number,
      required: true,
    },
    /* Which index to set v-model to on init */
    defaultIndex: {
      type: Number,
      required: true,
    },
    /* enable possibility to cycle around */
    enableCycle: {
      type: Boolean,
      required: false,
      default: false,
    },
  },
  watch: {
    max() {
      // If the max index (list length) changes, reset the index
      this.$emit('change', this.defaultIndex);
    },
  },
  created() {
    this.$emit('change', this.defaultIndex);
    document.addEventListener('keydown', this.handleKeydown);
  },
  beforeDestroy() {
    document.removeEventListener('keydown', this.handleKeydown);
  },
  methods: {
    handleKeydown(event) {
      if (event.keyCode === DOWN_KEY_CODE) {
        // Prevents moving scrollbar
        event.preventDefault();
        event.stopPropagation();
        // Moves to next index
        this.increment(1);
      } else if (event.keyCode === UP_KEY_CODE) {
        // Prevents moving scrollbar
        event.preventDefault();
        event.stopPropagation();
        // Moves to previous index
        this.increment(-1);
      } else Iif (event.keyCode === TAB_KEY_CODE) {
        this.$emit('tab');
      }
    },
    increment(val) {
      Iif (this.max === 0) {
        return;
      }
 
      let nextIndex = Math.max(this.min, Math.min(this.index + val, this.max));
 
      Iif (nextIndex === this.index) {
        // Return if the index didn't change and cycle is not enabled
        Iif (!this.enableCycle) {
          return;
        }
        // Update nextIndex if the cycle is enabled
        nextIndex = this.cycle(nextIndex, val);
      }
 
      this.$emit('change', nextIndex);
    },
    cycle(nextIndex, val) {
      Iif (val === 1 && nextIndex === this.max) {
        // if we are moving down +1 and we reached bottom (max)
        // return top most index (min)
        return this.min;
      }
 
      Iif (val === -1 && nextIndex === this.min) {
        // if we are moving up -1 and we reached top (min)
        // return bottom most index (max)
        return this.max;
      }
 
      return nextIndex;
    },
  },
  render() {
    return this.$scopedSlots.default?.();
  },
};
</script>