summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/vue_shared/components/icon.vue
blob: 365229ea27412222d0ece8b14e998bd9230736e7 (plain)
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
<script>

/* This is a re-usable vue component for rendering a svg sprite
   icon

  Sample configuration:

  <icon
    name="retry"
    :size="32"
    css-classes="top"
  />

*/
  // only allow classes in images.scss e.g. s12
  const validSizes = [8, 12, 16, 18, 24, 32, 48, 72];

  export default {
    props: {
      name: {
        type: String,
        required: true,
      },

      size: {
        type: Number,
        required: false,
        default: 16,
        validator(value) {
          return validSizes.includes(value);
        },
      },

      cssClasses: {
        type: String,
        required: false,
        default: '',
      },

      width: {
        type: Number,
        required: false,
        default: null,
      },

      height: {
        type: Number,
        required: false,
        default: null,
      },

      y: {
        type: Number,
        required: false,
        default: null,
      },

      x: {
        type: Number,
        required: false,
        default: null,
      },
    },

    computed: {
      spriteHref() {
        return `${gon.sprite_icons}#${this.name}`;
      },
      iconSizeClass() {
        return this.size ? `s${this.size}` : '';
      },
    },
  };
</script>

<template>
  <svg
    :class="[iconSizeClass, cssClasses]"
    :width="width"
    :height="height"
    :x="x"
    :y="y">
    <use
      v-bind="{'xlink:href':spriteHref}"/>
  </svg>
</template>