@gitlab/ui 32.48.0 → 32.51.1

package/dist/utils/string_utils.js

@@ -1,3 +1,5 @@
+import emojiRegexFactory from 'emoji-regex';
+
 /**
  * Split the given string after each occurrence of each of the given symbols.
  *
@@ -16,6 +18,7 @@
  * @param {string} string The string to split.
  * @returns {string[]} The resulting strings.
  */
+
 const splitAfterSymbols = (symbols, string) => {
   const textParts = [];
   let textPartStartIndex = 0;
@@ -60,10 +63,11 @@ const splitAfterSymbols = (symbols, string) => {
 
   return textParts;
 };
+const startsWithEmojiRegex = `^(${emojiRegexFactory().source})`;
 const getAvatarChar = name => {
   if (name) {
-    // Check if first character is an emjoi
-    const match = name.match(/^\p{Emoji}/u);
+    // Check if string starts with an emoji (which could be multiple characters and zero-width joined)
+    const match = name.match(startsWithEmojiRegex);
 
     if (match) {
       // Return the first match

package/documentation/documented_stories.js

@@ -90,6 +90,7 @@ export const setupStorybookReadme = () =>
         'GlAccordion',
         'GlAccordionItem',
         'GlIntersperse',
+        'GlFormSelect',
         'GlDaterangePicker',
         'GlAvatarLabeled',
         'GlBarChart',
@@ -111,6 +112,10 @@ export const setupStorybookReadme = () =>
         'GlChartTooltip',
         'GlInputGroupText',
         'GlGaugeChart',
+        'GlFormRadio',
+        'GlModal',
+        'GlKeysetPagination',
+        'GlForm',
       ],
       components: {
         GlComponentDocumentation,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "32.48.0",
+  "version": "32.51.1",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -71,7 +71,8 @@
     "vue-runtime-helpers": "^1.1.2"
   },
   "peerDependencies": {
-    "@gitlab/svgs": "^1.116.0",
+    "@gitlab/svgs": "^1.116.0 || ^2.0.0",
+    "emoji-regex": ">=10.0.0",
     "bootstrap": "4.5.3",
     "pikaday": "^1.8.0",
     "vue": "^2.6.10"
@@ -85,7 +86,7 @@
     "@babel/preset-env": "^7.10.2",
     "@gitlab/eslint-plugin": "10.0.0",
     "@gitlab/stylelint-config": "2.6.0",
-    "@gitlab/svgs": "1.226.0",
+    "@gitlab/svgs": "2.0.0",
     "@rollup/plugin-commonjs": "^11.1.0",
     "@rollup/plugin-node-resolve": "^7.1.3",
     "@rollup/plugin-replace": "^2.3.2",
@@ -107,6 +108,7 @@
     "babel-preset-vue": "^2.0.2",
     "bootstrap": "4.5.3",
     "cypress": "^6.6.0",
+    "emoji-regex": "^10.0.0",
     "eslint": "7.32.0",
     "eslint-import-resolver-jest": "3.0.2",
     "eslint-plugin-cypress": "2.12.1",

package/scss_to_js/scss_variables.js

@@ -15,6 +15,8 @@ export const glSpacingScale12 = '5rem'
 export const glSpacingScale13 = '6rem'
 export const glSpacingScale15 = '7.5rem'
 export const glSpacingScale20 = '10rem'
+export const glSpacingScale26 = '13rem'
+export const glSpacingScale62 = '31rem'
 export const breakpointSm = '576px'
 export const breakpointMd = '768px'
 export const breakpointLg = '992px'

package/scss_to_js/scss_variables.json

@@ -85,6 +85,16 @@
       "value": "20 * $grid-size",
       "compiledValue": "10rem"
     },
+    {
+      "name": "$gl-spacing-scale-26",
+      "value": "26 * $grid-size",
+      "compiledValue": "13rem"
+    },
+    {
+      "name": "$gl-spacing-scale-62",
+      "value": "62 * $grid-size",
+      "compiledValue": "31rem"
+    },
     {
       "name": "$breakpoint-sm",
       "value": "576px",

package/src/components/base/form/form.documentation.js

@@ -1,8 +1,5 @@
-import examples from './examples';
 import description from './form.md';
 
 export default {
   description,
-  examples,
-  bootstrapComponent: 'b-form',
 };

package/src/components/base/form/form.stories.js

@@ -1,17 +1,102 @@
-import { withKnobs } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
-import { GlForm } from '../../../../index';
+import {
+  GlForm,
+  GlFormGroup,
+  GlFormInput,
+  GlFormSelect,
+  GlFormCheckbox,
+  GlButton,
+} from '../../../../index';
+import { setStoryTimeout } from '../../../utils/test_utils';
 import readme from './form.md';
 
-const components = {
-  GlForm,
-};
+export const Default = (args) => ({
+  components: {
+    GlForm,
+    GlFormGroup,
+    GlFormInput,
+    GlFormSelect,
+    GlFormCheckbox,
+    GlButton,
+  },
+  props: Object.keys(args),
+  data() {
+    return {
+      form: {
+        submitDisabled: false,
+        email: '',
+        name: '',
+        mergeState: null,
+        checked: [],
+      },
+      states: [{ text: 'Select One', value: null }, 'Open', 'Resolved', 'Closed', 'Blocked'],
+      show: true,
+    };
+  },
+  methods: {
+    onReset() {
+      this.form.name = '';
+      this.form.submitDisabled = false;
+    },
+    onSubmit(evt) {
+      evt.preventDefault();
+      this.form.submitDisabled = true;
+      setStoryTimeout(() => {
+        this.form.submitDisabled = false;
+        // eslint-disable-next-line no-alert
+        alert(JSON.stringify(this.form));
+      }, 1000);
+    },
+  },
+  template: `
+    <gl-form @submit="onSubmit" @reset="onReset">
+      <gl-form-group
+        id="input-group-1"
+        label="Email address:"
+        label-for="input-1"
+        description="We'll never share your email with anyone else."
+      >
+        <gl-form-input
+          id="input-1"
+          v-model="form.email"
+          type="email"
+          required
+          placeholder="Enter email"
+        />
+      </gl-form-group>
+
+      <gl-form-group id="input-group-2" label="Your Name:" label-for="input-2">
+        <gl-form-input id="input-2" v-model="form.name" required placeholder="Enter name" />
+      </gl-form-group>
 
-documentedStoriesOf('base/form/form', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    template: `
-      <gl-form />
-    `,
-  }));
+      <gl-form-group id="input-group-3" label="Merge State:" label-for="input-3">
+        <gl-form-select id="input-3" v-model="form.mergeState" :options="states" required />
+      </gl-form-group>
+
+      <gl-form-group id="input-group-4">
+        <gl-form-checkbox-group id="checkboxes-4" v-model="form.checked">
+          <gl-form-checkbox value="squash">Squash Commits</gl-form-checkbox>
+          <gl-form-checkbox value="new">Create New Issue</gl-form-checkbox>
+        </gl-form-checkbox-group>
+      </gl-form-group>
+
+      <div class="gl-display-flex gl-justify-content-end">
+        <gl-button type="reset" class="gl-mr-3">Cancel</gl-button>
+        <gl-button type="submit" variant="confirm">Submit</gl-button>
+      </div>
+    </gl-form>
+  `,
+});
+
+export default {
+  title: 'base/form/form',
+  component: GlForm,
+  parameters: {
+    bootstrapComponent: 'b-form',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+};

package/src/components/base/form/form_radio/form_radio.documentation.js

@@ -1,37 +1,6 @@
-import examples from './examples';
 import description from './form_radio.md';
 
 export default {
   description,
-  examples,
   followsDesignSystem: true,
-  bootstrapComponent: 'b-form-radio',
-  propsInfo: {
-    checked: {
-      additionalInfo: 'The current value of the radio(s)',
-    },
-  },
-  events: [
-    {
-      event: 'input',
-      args: [{ arg: 'checked', description: 'current selected value of radio group' }],
-      description: 'Emitted when the selected value is changed',
-    },
-    {
-      event: 'change',
-      args: [{ arg: 'checked', description: 'current selected value of radio group' }],
-      description: 'Emitted when the selected value is changed due to user interaction',
-    },
-  ],
-  slots: [
-    {
-      name: 'help',
-      description:
-        'Content provided here will be shown beneath the radio. Typically used for help or descriptive text.',
-    },
-    {
-      name: 'default',
-      description: 'Content to use for the label',
-    },
-  ],
 };

package/src/components/base/form/form_radio/form_radio.md

@@ -1,10 +1,3 @@
-# GlFormRadio
-
-A radio button typically represents a single option in a group of related
-choices. Each radio button is boolean and only one can be selected at a time.
-
-## Usage
-
 `GlFormRadio` components can be used directly, or via a `GlFormRadioGroup`.
 
 Below is an example which demonstrates the direct approach. For examples using
@@ -12,13 +5,13 @@ Below is an example which demonstrates the direct approach. For examples using
 
 ```html
 <script>
-export default {
-  data() {
-    return {
-      selected: 'yes',
-    };
-  },
-};
+  export default {
+    data() {
+      return {
+        selected: 'yes',
+      };
+    },
+  };
 </script>
 
 <template>

package/src/components/base/form/form_radio/form_radio.stories.js

@@ -1,48 +1,60 @@
-import { withKnobs, text } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
 import { GlFormRadio } from '../../../../../index';
 import readme from './form_radio.md';
 
-const components = {
-  GlFormRadio,
-};
-
 const defaultOptions = [
   { value: 'Pizza', text: 'Pizza' },
   { value: 'Tacos', text: 'Tacos' },
   { value: 'Burger', text: 'Burger', disabled: true },
 ];
 
-function generateProps({ name = 'radio-group-name' } = {}) {
-  return {
-    name: {
-      type: String,
-      default: text('name', name),
-    },
-  };
-}
+const generateProps = ({ name = 'radio-group-name', checked = defaultOptions[0].value } = {}) => ({
+  name,
+  checked,
+});
 
-documentedStoriesOf('base/form/form-radio', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    props: generateProps(),
-    data() {
-      return {
-        selected: defaultOptions[0].value,
-        options: defaultOptions,
-      };
-    },
-    template: `
+const Template = (args) => ({
+  components: { GlFormRadio },
+  props: Object.keys(args),
+  template: `
       <div>
         <gl-form-radio
           v-for="option in options"
           :key="option.value"
-          v-model="selected"
+          :checked="checked"
           :value="option.value"
           :disabled="option.disabled"
           :name="name"
         >{{ option.text }}</gl-form-radio>
       </div>
     `,
-  }));
+  data() {
+    return {
+      options: defaultOptions,
+    };
+  },
+});
+
+export const Default = Template.bind({});
+Default.args = generateProps();
+
+export default {
+  title: 'base/form/form-radio',
+  component: GlFormRadio,
+  parameters: {
+    bootstrapComponent: 'b-form-radio',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+  argTypes: {
+    checked: {
+      options: defaultOptions.map(({ value }) => value),
+      control: {
+        type: 'select',
+      },
+    },
+  },
+};

package/src/components/base/form/form_radio/form_radio.vue

@@ -7,20 +7,45 @@ export default {
   name: 'GlFormRadio',
   components: { BFormRadio },
   inheritAttrs: false,
-  model,
+  model: {
+    prop: model.prop,
+    event: model.event,
+  },
+  props: {
+    /**
+     * Whether the radio is checked
+     */
+    checked: {
+      type: [String, Number, Boolean, Object],
+      required: false,
+      default: false,
+    },
+  },
 };
 </script>
 
 <template>
+  <!--
+  Emitted when the selected value is changed
+  @event input
+  @type {boolean} current selected value of radio group
+
+  Emitted when the selected value is changed due to user interaction
+  @event change
+  @type {boolean} current selected value of radio group
+  -->
   <b-form-radio
     class="gl-form-radio"
+    :checked="checked"
     v-bind="$attrs"
     v-on="$listeners"
     @input="$emit('input', $event)"
     @change="$emit('change', $event)"
   >
+    <!-- @slot Content to use for the label -->
     <slot></slot>
     <p v-if="$scopedSlots.help" class="help-text">
+      <!-- @slot Content provided here will be shown beneath the radio. Typically used for help or descriptive text. -->
       <slot name="help"></slot>
     </p>
   </b-form-radio>

package/src/components/base/form/form_select/form_select.documentation.js

@@ -1,25 +1,6 @@
-import examples from './examples';
 import description from './form_select.md';
 
 export default {
   description,
-  examples,
   followDesignSystem: true,
-  bootstrapComponent: 'b-form-select',
-  events: [
-    {
-      event: 'change',
-      description: 'Emitted with the select value changes via user interaction.',
-    },
-    {
-      event: 'input',
-      description: 'Emitted with the select value changes.',
-    },
-  ],
-  slots: [
-    {
-      name: 'first',
-      description: 'Slot to place option tags above options provided via options prop',
-    },
-  ],
 };

package/src/components/base/form/form_select/form_select.md

@@ -1,3 +1 @@
-# Form Select
-
 Form select component used to select from group of options in a form.

package/src/components/base/form/form_select/form_select.stories.js

@@ -1,19 +1,11 @@
-import { withKnobs, boolean, select, number, object } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
 import { GlFormSelect } from '../../../../../index';
 import { sizeOptions, formStateOptions } from '../../../../utils/constants';
 import { formSelectOptions } from './constants';
 import readme from './form_select.md';
 
-const components = {
-  GlFormSelect,
-};
-
-const data = () => {
-  return {
-    selected: 'Pizza',
-  };
-};
+const data = () => ({
+  selected: 'Pizza',
+});
 
 const template = `
 <gl-form-select 
@@ -27,86 +19,112 @@ const template = `
 </gl-form-select>
 `;
 
-function generateProps({
+const generateProps = ({
   size = null,
   state = null,
   disabled = false,
   multiple = false,
   selectSize = 1,
   options = formSelectOptions,
-} = {}) {
-  return {
-    size: {
-      type: String,
-      default: select('size', sizeOptions, size),
+} = {}) => ({
+  size,
+  disabled,
+  state,
+  multiple,
+  selectSize,
+  options,
+});
+
+const Template = (args) => ({
+  components: { GlFormSelect },
+  props: Object.keys(args),
+  data,
+  template,
+});
+
+export const Default = Template.bind({});
+Default.args = generateProps();
+
+export const Disabled = Template.bind({});
+Disabled.args = generateProps({ disabled: true });
+
+export const ValidState = Template.bind({});
+ValidState.args = generateProps({ state: true });
+
+export const InvalidState = Template.bind({});
+InvalidState.args = generateProps({ state: false });
+
+export const WithTruncation = (args, { argTypes }) => ({
+  components: { GlFormSelect },
+  props: Object.keys(argTypes),
+  data() {
+    return {
+      selected: 1,
+    };
+  },
+  template: `
+    <div style="max-width: 300px;">
+      ${template}
+    </div>
+    `,
+});
+WithTruncation.args = generateProps({
+  options: [
+    {
+      value: 1,
+      text: 'A form select option with a very looooooooong label',
+    },
+  ],
+});
+
+export default {
+  title: 'base/form/form-select',
+  component: GlFormSelect,
+  parameters: {
+    bootstrapComponent: 'b-form-select',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
     },
-    disabled: {
-      type: Boolean,
-      default: boolean('disabled', disabled),
+  },
+  argTypes: {
+    size: {
+      control: {
+        type: 'select',
+        options: sizeOptions,
+      },
     },
     state: {
-      type: Boolean,
-      default: select('state', formStateOptions, state),
+      control: {
+        type: 'select',
+        options: formStateOptions,
+      },
     },
-    multiple: {
-      type: Boolean,
-      default: boolean('multiple', multiple),
+    input: {
+      description: 'Emitted with the select value changes.',
+      table: {
+        category: 'events',
+      },
     },
-    selectSize: {
-      type: Number,
-      default: number('select size', selectSize),
+    change: {
+      description: 'Emitted with the select value changes via user interaction.',
+      table: {
+        category: 'events',
+      },
     },
-    options: {
-      type: Array,
-      default: object('options', options),
+    first: {
+      description: 'Slot to place option tags above options provided via options prop.',
+      table: {
+        category: 'slots',
+      },
     },
-  };
-}
-
-documentedStoriesOf('base/form/form-select', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    props: generateProps(),
-    data,
-    template,
-  }))
-  .add('disabled', () => ({
-    components,
-    props: generateProps({ disabled: true }),
-    data,
-    template,
-  }))
-  .add('valid state', () => ({
-    components,
-    props: generateProps({ state: true }),
-    data,
-    template,
-  }))
-  .add('invalid state', () => ({
-    components,
-    props: generateProps({ state: false }),
-    data,
-    template,
-  }))
-  .add('with truncation', () => ({
-    components,
-    props: generateProps({
-      options: [
-        {
-          value: 1,
-          text: 'A form select option with a very looooooooong label',
-        },
-      ],
-    }),
-    data() {
-      return {
-        selected: 1,
-      };
+    default: {
+      description: 'Slot to place explicit option tags.',
+      table: {
+        category: 'slots',
+      },
     },
-    template: `
-    <div style="max-width: 300px;">
-      ${template}
-    </div>
-    `,
-  }));
+  },
+};