summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/vue_shared/components/ci_icon.vue
blob: 0d7547d88a12d82fee26ab6673928e0bc34d3f0d (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
87
88
89
90
91
<script>
import { GlIcon } from '@gitlab/ui';

/**
 * Renders CI icon based on API response shared between all places where it is used.
 *
 * Receives status object containing:
 * status: {
 *   group:"running" // used for CSS class
 *   icon: "icon_status_running" // used to render the icon
 * }
 *
 * Used in:
 * - Extended MR Popover
 * - Jobs show view header
 * - Jobs show view sidebar
 * - Jobs table
 * - Linked pipelines
 * - Pipeline graph
 * - Pipeline mini graph
 * - Pipeline show view badge
 * - Pipelines table Badge
 */

/*
 * These sizes are defined in gitlab-ui/src/scss/variables.scss
 * under '$gl-icon-sizes'
 */
const validSizes = [8, 12, 14, 16, 24, 32, 48, 72];

export default {
  components: {
    GlIcon,
  },
  props: {
    status: {
      type: Object,
      required: true,
    },
    size: {
      type: Number,
      required: false,
      default: 16,
      validator(value) {
        return validSizes.includes(value);
      },
    },
    isActive: {
      type: Boolean,
      required: false,
      default: false,
    },
    isBorderless: {
      type: Boolean,
      required: false,
      default: false,
    },
    isInteractive: {
      type: Boolean,
      required: false,
      default: false,
    },
    cssClasses: {
      type: String,
      required: false,
      default: '',
    },
  },
  computed: {
    wrapperStyleClasses() {
      const status = this.status.group;
      return `ci-status-icon ci-status-icon-${status} js-ci-status-icon-${status} gl-rounded-full gl-justify-content-center gl-line-height-0`;
    },
    icon() {
      return this.isBorderless ? `${this.status.icon}_borderless` : this.status.icon;
    },
  },
};
</script>
<template>
  <span
    :class="[
      wrapperStyleClasses,
      { interactive: isInteractive, active: isActive, borderless: isBorderless },
    ]"
    :style="{ height: `${size}px`, width: `${size}px` }"
    data-testid="ci-icon-wrapper"
  >
    <gl-icon :name="icon" :size="size" :class="cssClasses" :aria-label="status.icon" />
  </span>
</template>