@gitlab/ui 118.0.0 → 118.1.0

package/dist/components/base/illustration/illustration.js

@@ -0,0 +1,80 @@
+import illustrationsPath from '@gitlab/svgs/dist/illustrations.svg';
+import illustrationsInfo from '@gitlab/svgs/dist/illustrations.json';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+//
+
+const knownIllustrations = illustrationsInfo.icons;
+
+/** This is a re-usable vue component for rendering a svg sprite icon
+ *  @example
+ *  <illustration
+ *    name="status-success-sm"
+ *  />
+ */
+var script = {
+  name: 'GlIllustration',
+  props: {
+    /**
+     * One of the illustrations from https://gitlab-org.gitlab.io/gitlab-svgs/ project
+     */
+    name: {
+      type: String,
+      required: true,
+      validator: value => {
+        if (knownIllustrations.some(obj => obj.name === value)) {
+          return true;
+        }
+        // eslint-disable-next-line no-console
+        console.warn(`Illustration '${value}' is not a known illustration of @gitlab/svgs`);
+        return false;
+      }
+    }
+  },
+  computed: {
+    spriteHref() {
+      return `${illustrationsPath}#${this.name}`;
+    },
+    illustrationSize() {
+      return knownIllustrations.find(obj => obj.name === this.name).svg_size;
+    }
+  }
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('svg',_vm._g({key:_vm.spriteHref,attrs:{"data-testid":(_vm.name + "-illustration"),"aria-label":"","role":"presentation","width":_vm.illustrationSize,"height":_vm.illustrationSize}},_vm.$listeners),[_c('use',{attrs:{"href":_vm.spriteHref}})])};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = /*#__PURE__*/__vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export { __vue_component__ as default };

package/dist/components/index.js

@@ -7,6 +7,7 @@ export { default as GlTokenSelector } from './base/token_selector/token_selector
 export { default as GlMarkdown } from './base/markdown/markdown';
 export { default as GlDeprecatedLink, default as GlLink } from './base/link/link';
 export { default as GlIcon } from './base/icon/icon';
+export { default as GlIllustration } from './base/illustration/illustration';
 export { default as GlAnimatedChevronRightDownIcon } from './base/animated_icon/animated_chevron_right_down_icon';
 export { default as GlAnimatedChevronLgRightDownIcon } from './base/animated_icon/animated_chevron_lg_right_down_icon';
 export { default as GlAnimatedChevronDownUpIcon } from './base/animated_icon/animated_chevron_down_up_icon';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "118.0.0",
+  "version": "118.1.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/base/illustration/illustration.vue

@@ -0,0 +1,56 @@
+<!-- eslint-disable vue/multi-word-component-names -->
+<script>
+import illustrationsPath from '@gitlab/svgs/dist/illustrations.svg';
+import illustrationsInfo from '@gitlab/svgs/dist/illustrations.json';
+
+const knownIllustrations = illustrationsInfo.icons;
+
+/** This is a re-usable vue component for rendering a svg sprite icon
+ *  @example
+ *  <illustration
+ *    name="status-success-sm"
+ *  />
+ */
+export default {
+  name: 'GlIllustration',
+  props: {
+    /**
+     * One of the illustrations from https://gitlab-org.gitlab.io/gitlab-svgs/ project
+     */
+    name: {
+      type: String,
+      required: true,
+      validator: (value) => {
+        if (knownIllustrations.some((obj) => obj.name === value)) {
+          return true;
+        }
+        // eslint-disable-next-line no-console
+        console.warn(`Illustration '${value}' is not a known illustration of @gitlab/svgs`);
+        return false;
+      },
+    },
+  },
+  computed: {
+    spriteHref() {
+      return `${illustrationsPath}#${this.name}`;
+    },
+    illustrationSize() {
+      return knownIllustrations.find((obj) => obj.name === this.name).svg_size;
+    },
+  },
+};
+</script>
+
+<template>
+  <svg
+    :key="spriteHref"
+    :data-testid="`${name}-illustration`"
+    aria-label=""
+    role="presentation"
+    :width="illustrationSize"
+    :height="illustrationSize"
+    v-on="$listeners"
+  >
+    <use :href="spriteHref" />
+  </svg>
+</template>

package/src/components/base/token_selector/token_selector.vue

@@ -414,12 +414,11 @@ export default {
         @cancel-focus="cancelTokenFocus"
         @clear-all="clearAll"
       >
-        <template #token-content="{ token }">
-          <!-- @slot Content to pass to the token component slot. Can be used
-            to add an avatar to the token. Default content is "{{ token.name }}".
-               @binding {object} token
-          -->
-          <slot name="token-content" :token="token"></slot>
+        <template #token-content="{ token }"
+          ><!--
+            @slot Content to pass to the token component slot. Can be used to add an avatar to the token. Default content is "{{ token.name }}".
+            @binding {object} token
+          --><slot name="token-content" :token="token"></slot>
         </template>
         <template #text-input>
           <!-- Can't use `v-model` due to this bug: -->
@@ -465,34 +464,32 @@ export default {
       @dropdown-item-click="addToken"
       @show="openDropdown"
     >
-      <template #loading-content>
-        <!-- @slot Content to display when `loading` prop is `true`. Default
-          content is "Searching..." -->
-        <slot name="loading-content"></slot>
+      <template #loading-content
+        ><!--
+          @slot Content to display when `loading` prop is `true`. Default content is "Searching..."
+        --><slot name="loading-content"></slot>
       </template>
-      <template #user-defined-token-content>
-        <!-- @slot Content to display when adding a user defined token. Default content is 'Add "{{ inputText }}"'.
-             @binding {string} inputText
-        -->
-        <slot name="user-defined-token-content" :input-text="inputText"></slot>
+      <template #user-defined-token-content
+        ><!--
+          @slot Content to display when adding a user defined token. Default content is 'Add "{{ inputText }}"'.
+          @binding {string} inputText
+        --><slot name="user-defined-token-content" :input-text="inputText"></slot>
       </template>
-      <template #no-results-content>
-        <!-- @slot Content to display when `dropdown-items` is empty and
-          both `allow-user-defined-tokens` and `show-add-new-always` is `false`. Default content is "No matches found". -->
-        <slot name="no-results-content"></slot>
+      <template #no-results-content
+        ><!--
+          @slot Content to display when `dropdown-items` is empty and both `allow-user-defined-tokens` and `show-add-new-always` is `false`. Default content is "No matches found".
+        --><slot name="no-results-content"></slot>
       </template>
-      <template #dropdown-item-content="{ dropdownItem }">
-        <!-- @slot Dropdown item content. Default content is "{{ dropdownItem.name }}".
-             @binding {object} dropdownItem
-        -->
-        <slot name="dropdown-item-content" :dropdown-item="dropdownItem"></slot>
+      <template #dropdown-item-content="{ dropdownItem }"
+        ><!--
+          @slot Dropdown item content. Default content is "{{ dropdownItem.name }}".
+          @binding {object} dropdownItem
+        --><slot name="dropdown-item-content" :dropdown-item="dropdownItem"></slot>
       </template>
-      <template #dropdown-footer>
-        <!-- @slot Content to add to the bottom of the dropdown.
-          Can be used in conjunction with `gl-intersection-observer` to load
-          more items as the user scrolls.
-        -->
-        <slot name="dropdown-footer"></slot>
+      <template #dropdown-footer
+        ><!--
+          @slot Content to add to the bottom of the dropdown. Can be used in conjunction with `gl-intersection-observer` to load more items as the user scrolls.
+        --><slot name="dropdown-footer"></slot>
       </template>
     </gl-token-selector-dropdown>
   </div>

package/src/components/index.js

@@ -8,6 +8,7 @@ export { default as GlTokenSelector } from './base/token_selector/token_selector
 export { default as GlMarkdown } from './base/markdown/markdown.vue';
 export { default as GlLink, default as GlDeprecatedLink } from './base/link/link.vue';
 export { default as GlIcon } from './base/icon/icon.vue';
+export { default as GlIllustration } from './base/illustration/illustration.vue';
 export { default as GlAnimatedChevronRightDownIcon } from './base/animated_icon/animated_chevron_right_down_icon.vue';
 export { default as GlAnimatedChevronLgRightDownIcon } from './base/animated_icon/animated_chevron_lg_right_down_icon.vue';
 export { default as GlAnimatedChevronDownUpIcon } from './base/animated_icon/animated_chevron_down_up_icon.vue';