@gitlab/ui 80.9.0 → 80.10.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [80.10.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v80.9.0...v80.10.0) (2024-05-15)
+
+
+### Features
+
+* **DesignTokens:** Create design token table Storybook story ([a7d97d1](https://gitlab.com/gitlab-org/gitlab-ui/commit/a7d97d11b6fee5e6e942f32785a1e4843ca3924b))
+
 # [80.9.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v80.8.1...v80.9.0) (2024-05-15)
 
 

package/dist/tailwind.css

@@ -1,2 +1,2 @@
-.gl-fixed{position:fixed}.\!gl-absolute{position:absolute!important}.gl-absolute{position:absolute}.gl-relative{position:relative}.gl-bottom-0{bottom:0}.gl-bottom-2{bottom:.25rem}.gl-left-0{left:0}.gl-right-2{right:.25rem}.gl-float-right{float:right}.gl-text-blue-100{color:var(--blue-100,#cbe2f9)}.gl-text-blue-500{color:var(--blue-500,#1f75cb)}.gl-text-blue-900{color:var(--blue-900,#033464)}.gl-text-danger{color:var(--gl-text-color-danger,#c91c00)}.gl-text-gray-400{color:var(--gray-400,#89888d)}.gl-text-gray-500{color:var(--gray-500,#737278)}.gl-text-gray-600{color:var(--gray-600,#626168)}.gl-text-gray-700{color:var(--gray-700,#535158)}.gl-text-gray-900{color:var(--gray-900,#333238)}.gl-text-gray-950{color:var(--gray-950,#1f1e24)}.gl-text-green-500{color:var(--green-500,#108548)}.gl-text-green-600{color:var(--green-600,#217645)}.gl-text-orange-500{color:var(--orange-500,#ab6100)}.gl-text-red-300{color:var(--red-300,#f57f6c)}.gl-text-red-500{color:var(--red-500,#dd2b0e)}.gl-text-red-600{color:var(--red-600,#c91c00)}.gl-text-secondary{color:var(--gl-text-secondary,#737278)}.gl-text-subtle{color:var(--gl-text-color-subtle,#626168)}.gl-text-white{color:var(--white,#fff)}
+.gl-fixed{position:fixed}.\!gl-absolute{position:absolute!important}.gl-absolute{position:absolute}.gl-relative{position:relative}.gl-bottom-0{bottom:0}.gl-bottom-2{bottom:.25rem}.gl-left-0{left:0}.gl-right-2{right:.25rem}.gl-float-right{float:right}.gl-text-blue-100{color:var(--blue-100,#cbe2f9)}.gl-text-blue-500{color:var(--blue-500,#1f75cb)}.gl-text-blue-900{color:var(--blue-900,#033464)}.gl-text-danger{color:var(--gl-text-color-danger,#c91c00)}.gl-text-gray-400{color:var(--gray-400,#89888d)}.gl-text-gray-500{color:var(--gray-500,#737278)}.gl-text-gray-600{color:var(--gray-600,#626168)}.gl-text-gray-700{color:var(--gray-700,#535158)}.gl-text-gray-900{color:var(--gray-900,#333238)}.gl-text-gray-950{color:var(--gray-950,#1f1e24)}.gl-text-green-500{color:var(--green-500,#108548)}.gl-text-green-600{color:var(--green-600,#217645)}.gl-text-orange-500{color:var(--orange-500,#ab6100)}.gl-text-red-300{color:var(--red-300,#f57f6c)}.gl-text-red-500{color:var(--red-500,#dd2b0e)}.gl-text-red-600{color:var(--red-600,#c91c00)}.gl-text-secondary{color:var(--gl-text-secondary,#737278)}.gl-text-strong{color:var(--gl-text-color-strong,#1f1e24)}.gl-text-subtle{color:var(--gl-text-color-subtle,#626168)}.gl-text-white{color:var(--white,#fff)}
 /*# sourceMappingURL=tailwind.css.map */

package/dist/tailwind.css.map

@@ -1 +1 @@
-{"version":3,"sources":["tailwind.css"],"names":[],"mappings":"AAAA,UAAA,cAAmB,CAAnB,eAAA,2BAAmB,CAAnB,aAAA,iBAAmB,CAAnB,aAAA,iBAAmB,CAAnB,aAAA,QAAmB,CAAnB,aAAA,aAAmB,CAAnB,WAAA,MAAmB,CAAnB,YAAA,YAAmB,CAAnB,gBAAA,WAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,gBAAA,yCAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,mBAAA,8BAAmB,CAAnB,mBAAA,8BAAmB,CAAnB,oBAAA,+BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,mBAAA,sCAAmB,CAAnB,gBAAA,yCAAmB,CAAnB,eAAA,uBAAmB","file":"tailwind.css","sourcesContent":["@tailwind utilities;\n"]}
+{"version":3,"sources":["tailwind.css"],"names":[],"mappings":"AAAA,UAAA,cAAmB,CAAnB,eAAA,2BAAmB,CAAnB,aAAA,iBAAmB,CAAnB,aAAA,iBAAmB,CAAnB,aAAA,QAAmB,CAAnB,aAAA,aAAmB,CAAnB,WAAA,MAAmB,CAAnB,YAAA,YAAmB,CAAnB,gBAAA,WAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,gBAAA,yCAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,kBAAA,6BAAmB,CAAnB,mBAAA,8BAAmB,CAAnB,mBAAA,8BAAmB,CAAnB,oBAAA,+BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,iBAAA,4BAAmB,CAAnB,mBAAA,sCAAmB,CAAnB,gBAAA,yCAAmB,CAAnB,gBAAA,yCAAmB,CAAnB,eAAA,uBAAmB","file":"tailwind.css","sourcesContent":["@tailwind utilities;\n"]}

package/dist/tokens/tokens_table.js

@@ -0,0 +1,147 @@
+import GlBadge from '../components/base/badge/badge';
+import GlCollapsibleListbox from '../components/base/new_dropdowns/listbox/listbox';
+import GlFormInput from '../components/base/form/form_input/form_input';
+import GlTable from '../components/base/table/table';
+import TOKENS_DEFAULT from './build/json/tokens.json';
+import TOKENS_DARK from './build/json/tokens.dark.json';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  name: 'TokensTable',
+  TOKENS_DEFAULT,
+  TOKENS_DARK,
+  components: {
+    GlBadge,
+    GlCollapsibleListbox,
+    GlFormInput,
+    GlTable
+  },
+  fields: [{
+    key: 'description',
+    label: 'Description'
+  }, {
+    key: 'value',
+    label: 'Value'
+  }],
+  data() {
+    return {
+      filter: null,
+      modes: [{
+        value: 'default',
+        text: 'Default'
+      }, {
+        value: 'dark',
+        text: 'Dark'
+      }],
+      selectedMode: 'default',
+      tokens: {
+        default: this.$options.TOKENS_DEFAULT,
+        dark: this.$options.TOKENS_DARK
+      }
+    };
+  },
+  computed: {
+    items() {
+      return this.transformTokensToTableRows(this.tokens[this.selectedMode]);
+    }
+  },
+  methods: {
+    isColor(type) {
+      return type === 'color';
+    },
+    isAliasValue(value) {
+      return typeof value === 'string' && value.includes('{');
+    },
+    isAliasObject(value) {
+      return typeof value === 'object' && Object.values(value).some(val => this.isAliasValue(val));
+    },
+    getAliasValueName(value) {
+      if (this.isAliasValue(value)) {
+        return value.slice(1, -1);
+      }
+      return value;
+    },
+    getValueLabel(token) {
+      const {
+        value
+      } = token.original;
+      if (this.isAliasObject(value)) {
+        return this.getAliasValueName(value[this.selectedMode]);
+      }
+      if (this.isAliasValue(value)) {
+        return this.getAliasValueName(value);
+      }
+      return token.value;
+    },
+    transformTokenToTableColumns(token) {
+      return {
+        name: token.path.filter(Boolean).join('.'),
+        type: token.$type,
+        value: token.value,
+        valueLabel: this.getValueLabel(token),
+        deprecated: token.deprecated,
+        description: token.comment
+      };
+    },
+    transformTokensToTableRows(tokens) {
+      const tokensArray = [];
+      Object.keys(tokens).forEach(key => {
+        const token = tokens[key];
+        if (token.value) {
+          tokensArray.push(this.transformTokenToTableColumns(token));
+        } else {
+          tokensArray.push(...this.transformTokensToTableRows(token));
+        }
+      });
+      return tokensArray;
+    }
+  }
+};
+
+/* 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('div',[_c('div',{staticClass:"gl-display-flex gl-align-items-center gl-gap-3 gl-mb-5"},[_c('gl-form-input',{attrs:{"placeholder":"Type to search"},model:{value:(_vm.filter),callback:function ($$v) {_vm.filter=$$v;},expression:"filter"}}),_vm._v(" "),_c('gl-collapsible-listbox',{attrs:{"id":"component-listbox","selected":_vm.selectedMode,"items":_vm.modes},on:{"search":function($event){_vm.query = $event;}},model:{value:(_vm.selectedMode),callback:function ($$v) {_vm.selectedMode=$$v;},expression:"selectedMode"}})],1),_vm._v(" "),_c('gl-table',{attrs:{"filter":_vm.filter,"items":_vm.items,"fields":_vm.$options.fields,"tbody-tr-attr":function (item) { return ({ id: item.name }); },"hover":"","stacked":"sm"},scopedSlots:_vm._u([{key:"cell(description)",fn:function(ref){
+var ref_item = ref.item;
+var name = ref_item.name;
+var deprecated = ref_item.deprecated;
+var description = ref_item.description;
+return [_c('code',{staticClass:"gl-font-base gl-text-strong"},[_vm._v("\n        "+_vm._s(name)+"\n        "),(deprecated)?_c('gl-badge',{attrs:{"size":"sm","variant":"neutral"}},[_vm._v("Deprecated")]):_vm._e()],1),_vm._v(" "),(description)?_c('div',{staticClass:"gl-mt-3 gl-text-subtle"},[_vm._v("\n        "+_vm._s(description)+"\n      ")]):_vm._e()]}},{key:"cell(value)",fn:function(ref){
+var ref_item = ref.item;
+var type = ref_item.type;
+var value = ref_item.value;
+var valueLabel = ref_item.valueLabel;
+return [_c('div',{staticClass:"gl-display-flex gl-align-items-center gl-gap-3"},[(_vm.isColor(type))?_c('div',{staticClass:"gl-w-5 gl-h-5 gl-rounded-base",style:({ 'background-color': value })}):_vm._e(),_vm._v(" "),_c('code',{staticClass:"gl-font-base gl-text-strong"},[_vm._v(_vm._s(valueLabel))])])]}}])})],1)};
+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__ = __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 default __vue_component__;

package/package.json

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

package/src/components/base/keyset_pagination/keyset_pagination.md

@@ -29,10 +29,10 @@ Example:
 <gl-keyset-pagination v-bind="pageInfo" :prev-text="__('Prev')" :next-text="__('Next')" />
 ```
 
-**✅ Do** use this component for paginating GraphQL requests<sup>1</sup> (or any
+**✅ Do** use this component for paginating GraphQL requests[^1] (or any
 endpoint that uses keyset pagination).
 
-**❌ Don't** use this component for paginating REST requests<sup>1</sup> (or any
+**❌ Don't** use this component for paginating REST requests[^1] (or any
 endpoint that uses offset pagination).
 
 For offset pagination, use the [`GlPagination`
@@ -42,12 +42,7 @@ For more information on the difference between offset and keyset pagination see
 [our documentation on GraphQL
 pagination](https://docs.gitlab.com/ee/development/graphql_guide/pagination.html).
 
-<small><sup>1</sup>There's no intrinsic reason why GraphQL endpoints can't
-support offset pagination (in fact, [the official
-documentation](https://graphql.org/learn/pagination/#pagination-and-edges) shows
-an example offset pagination implementation) or why REST endpoints can't support
-keyset pagination. This is simply how we've chosen to implement our REST and
-GraphQL endpoints at GitLab.</small>
+[^1]: There's no intrinsic reason why GraphQL endpoints can't support offset pagination (in fact, [the official documentation](https://graphql.org/learn/pagination/#pagination-and-edges) shows an example offset pagination implementation) or why REST endpoints can't support keyset pagination. This is simply how we've chosen to implement our REST and GraphQL endpoints at GitLab.
 
 ## Pajamas reference
 

package/src/tokens/tokens.stories.js

@@ -0,0 +1,16 @@
+import TokensTable from './tokens_table.vue';
+
+const Template = () => ({
+  components: {
+    TokensTable,
+  },
+  template: `<tokens-table />`,
+});
+
+export const Default = Template.bind({});
+
+export default {
+  title: 'tokens/all',
+  component: TokensTable,
+  tags: ['skip-visual-test'],
+};

package/src/tokens/tokens_table.vue

@@ -0,0 +1,151 @@
+<script>
+import GlBadge from '../components/base/badge/badge.vue';
+import GlCollapsibleListbox from '../components/base/new_dropdowns/listbox/listbox.vue';
+import GlFormInput from '../components/base/form/form_input/form_input.vue';
+import GlTable from '../components/base/table/table.vue';
+import TOKENS_DEFAULT from './build/json/tokens.json';
+import TOKENS_DARK from './build/json/tokens.dark.json';
+
+export default {
+  name: 'TokensTable',
+  TOKENS_DEFAULT,
+  TOKENS_DARK,
+  components: {
+    GlBadge,
+    GlCollapsibleListbox,
+    GlFormInput,
+    GlTable,
+  },
+  fields: [
+    {
+      key: 'description',
+      label: 'Description',
+    },
+    {
+      key: 'value',
+      label: 'Value',
+    },
+  ],
+  data() {
+    return {
+      filter: null,
+      modes: [
+        {
+          value: 'default',
+          text: 'Default',
+        },
+        {
+          value: 'dark',
+          text: 'Dark',
+        },
+      ],
+      selectedMode: 'default',
+      tokens: {
+        default: this.$options.TOKENS_DEFAULT,
+        dark: this.$options.TOKENS_DARK,
+      },
+    };
+  },
+  computed: {
+    items() {
+      return this.transformTokensToTableRows(this.tokens[this.selectedMode]);
+    },
+  },
+  methods: {
+    isColor(type) {
+      return type === 'color';
+    },
+    isAliasValue(value) {
+      return typeof value === 'string' && value.includes('{');
+    },
+    isAliasObject(value) {
+      return (
+        typeof value === 'object' && Object.values(value).some((val) => this.isAliasValue(val))
+      );
+    },
+    getAliasValueName(value) {
+      if (this.isAliasValue(value)) {
+        return value.slice(1, -1);
+      }
+      return value;
+    },
+    getValueLabel(token) {
+      const { value } = token.original;
+      if (this.isAliasObject(value)) {
+        return this.getAliasValueName(value[this.selectedMode]);
+      }
+      if (this.isAliasValue(value)) {
+        return this.getAliasValueName(value);
+      }
+      return token.value;
+    },
+    transformTokenToTableColumns(token) {
+      return {
+        name: token.path.filter(Boolean).join('.'),
+        type: token.$type,
+        value: token.value,
+        valueLabel: this.getValueLabel(token),
+        deprecated: token.deprecated,
+        description: token.comment,
+      };
+    },
+    transformTokensToTableRows(tokens) {
+      const tokensArray = [];
+
+      Object.keys(tokens).forEach((key) => {
+        const token = tokens[key];
+        if (token.value) {
+          tokensArray.push(this.transformTokenToTableColumns(token));
+        } else {
+          tokensArray.push(...this.transformTokensToTableRows(token));
+        }
+      });
+
+      return tokensArray;
+    },
+  },
+};
+</script>
+
+<template>
+  <div>
+    <div class="gl-display-flex gl-align-items-center gl-gap-3 gl-mb-5">
+      <gl-form-input v-model="filter" placeholder="Type to search" />
+      <gl-collapsible-listbox
+        id="component-listbox"
+        v-model="selectedMode"
+        :selected="selectedMode"
+        :items="modes"
+        @search="query = $event"
+      />
+    </div>
+    <gl-table
+      :filter="filter"
+      :items="items"
+      :fields="$options.fields"
+      :tbody-tr-attr="(item) => ({ id: item.name })"
+      hover
+      stacked="sm"
+    >
+      <template #cell(description)="{ item: { name, deprecated, description } }">
+        <code class="gl-font-base gl-text-strong">
+          {{ name }}
+          <gl-badge v-if="deprecated" size="sm" variant="neutral">Deprecated</gl-badge>
+        </code>
+        <div v-if="description" class="gl-mt-3 gl-text-subtle">
+          {{ description }}
+        </div>
+      </template>
+      <template #cell(value)="{ item: { type, value, valueLabel } }">
+        <div class="gl-display-flex gl-align-items-center gl-gap-3">
+          <div
+            v-if="isColor(type)"
+            class="gl-w-5 gl-h-5 gl-rounded-base"
+            :style="{ 'background-color': value }"
+          ></div>
+          <code class="gl-font-base gl-text-strong">{{ valueLabel }}</code>
+        </div>
+      </template>
+    </gl-table>
+  </div>
+</template>