@gitlab/ui 32.47.0 → 32.51.0

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>
-    `,
-  }));
+  },
+};

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

@@ -1,105 +1,6 @@
-import examples from './examples';
 import * as description from './keyset_pagination.md';
 
 export default {
   description,
   followsDesignSystem: true,
-  bootstrapComponent: false,
-  examples,
-  propsInfo: {
-    hasPreviousPage: {
-      type: Boolean,
-      required: false,
-      default: false,
-      additionalInfo: 'Whether or not the "Prev" button should be enabled',
-    },
-    hasNextPage: {
-      type: Boolean,
-      required: false,
-      default: false,
-      additionalInfo: 'Whether or not the "Next" button should be enabled',
-    },
-    startCursor: {
-      type: String,
-      required: false,
-      default: null,
-      additionalInfo:
-        'A cursor that points to the first item in the current page. Will be passed as an event parameter when the "prev" event is fired.',
-    },
-    endCursor: {
-      type: String,
-      required: false,
-      default: null,
-      additionalInfo:
-        'A cursor that points to the last item in the current page. Will be passed as an event parameter when the "next" event is fired.',
-    },
-
-    prevText: {
-      type: String,
-      required: false,
-      default: 'Prev',
-      additionalInfo:
-        'The text that will be rendered inside the "Prev" button. It\'s important to provide this parameter since the default text is not translatable.',
-    },
-    prevButtonLink: {
-      type: String,
-      required: false,
-      default: null,
-      additionalInfo:
-        'A link that will be used as the "Prev" button\'s "href" attribute. If provided, the "Prev" button renders as a link button; otherwise, it is rendered as a regular button.',
-    },
-    nextText: {
-      type: String,
-      required: false,
-      default: 'Next',
-      additionalInfo:
-        'The text that will be rendered inside the "Next" button. It\'s important to provide this parameter since the default text is not translatable.',
-    },
-    nextButtonLink: {
-      type: String,
-      required: false,
-      default: null,
-      additionalInfo:
-        'A link that will be used as the "Next" button\'s "href" attribute. If provided, the "Next" button renders as a link button; otherwise, it is rendered as a regular button.',
-    },
-    disabled: {
-      type: Boolean,
-      required: false,
-      default: false,
-      additionalInfo:
-        'Whether or not both buttons should be disabled (regardless of the "hasPreviousPage" and "hasNextPage" values).',
-    },
-  },
-  events: [
-    {
-      event: 'prev',
-      description: 'Emitted when the "Prev" button is clicked',
-      args: [
-        {
-          arg: 'startCursor',
-          description: 'A cursor that points to the first item in the current page.',
-        },
-      ],
-    },
-    {
-      event: 'next',
-      description: 'Emitted when the "Next" button is clicked',
-      args: [
-        {
-          arg: 'endCursor',
-          description: 'A cursor that points to the last item in the current page',
-        },
-      ],
-    },
-  ],
-  slots: [
-    {
-      name: 'previous-button-content',
-      description: 'Used to customize the appearance of the "Prev" button',
-    },
-    {
-      name: 'next-button-content',
-      description: 'Used to customize the appearance of the "Next" button',
-    },
-  ],
 };

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

@@ -1,5 +1,3 @@
-# Keyset Pagination
-
 Pagination is used to help users parse a large number of items on a page,
 whenever there are too many results to show at once. Pagination breaks up
 results into several pages with controls for navigating forward and backward, or

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

@@ -1,65 +1,67 @@
-import { withKnobs, boolean, text } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
 import readme from './keyset_pagination.md';
 import GlKeysetPagination from './keyset_pagination.vue';
 
-const components = {
-  GlKeysetPagination,
-};
+const generateProps = ({
+  hasPreviousPage = false,
+  hasNextPage = true,
+  startCursor = 'eyJpZCI6IjE3NTg1ODciLCJyZWxlYXNlZF9hdCI6IjIwMjAtMDgtMjAgMTQ6NDc6MDguNTQ1MjE1MDAwIFVUQyJ9',
+  endCursor = 'eyJpZCI6IjEyNjcxNzkiLCJyZWxlYXNlZF9hdCI6IjIwMjAtMDItMTkgMjE6MDA6MDUuODU5NTQ2MDAwIFVUQyJ9',
+  prevText = 'Prev',
+  nextText = 'Next',
+  prevButtonLink = '',
+  nextButtonLink = '',
+  disabled = false,
+} = {}) => ({
+  hasPreviousPage,
+  hasNextPage,
+  startCursor,
+  endCursor,
+  prevText,
+  nextText,
+  prevButtonLink,
+  nextButtonLink,
+  disabled,
+});
 
-function generateProps() {
-  return {
-    hasPreviousPage: {
-      type: Boolean,
-      default: boolean('hasPreviousPage', false),
-    },
-    hasNextPage: {
-      type: Boolean,
-      default: boolean('hasNextPage', true),
-    },
-    startCursor: {
-      type: String,
-      default: text(
-        'startCursor',
-        'eyJpZCI6IjE3NTg1ODciLCJyZWxlYXNlZF9hdCI6IjIwMjAtMDgtMjAgMTQ6NDc6MDguNTQ1MjE1MDAwIFVUQyJ9'
-      ),
-    },
-    endCursor: {
-      type: String,
-      default: text(
-        'endCursor',
-        'eyJpZCI6IjEyNjcxNzkiLCJyZWxlYXNlZF9hdCI6IjIwMjAtMDItMTkgMjE6MDA6MDUuODU5NTQ2MDAwIFVUQyJ9'
-      ),
-    },
-    prevText: {
-      type: String,
-      default: text('prevText'),
-    },
-    nextText: {
-      type: String,
-      default: text('nextText'),
-    },
-    prevButtonLink: {
-      type: String,
-      default: text('prevButtonLink'),
-    },
-    nextButtonLink: {
-      type: String,
-      default: text('nextButtonLink'),
+const Template = (args, { argTypes }) => ({
+  components: { GlKeysetPagination },
+  props: Object.keys(argTypes),
+  template: `
+      <gl-keyset-pagination v-bind="$props"/>
+    `,
+});
+
+/* eslint-disable no-alert */
+export const Events = (args, { argTypes }) => ({
+  components: { GlKeysetPagination },
+  props: Object.keys(argTypes),
+  methods: {
+    onPrev(startCursor) {
+      alert(`"prev" event fired with start cursor: "${startCursor}"`);
     },
-    disabled: {
-      type: Boolean,
-      default: boolean('disabled', false),
+    onNext(endCursor) {
+      alert(`"next" event fired with end cursor: "${endCursor}"`);
     },
-  };
-}
-
-documentedStoriesOf('base/keyset-pagination', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    props: generateProps(),
-    template: `
-      <gl-keyset-pagination v-bind="$props"/>
+  },
+  template: `
+      <gl-keyset-pagination v-bind="$props" @prev="onPrev($event)" @next="onNext($event)" />
     `,
-  }));
+});
+Events.args = generateProps({ hasPreviousPage: true });
+
+export const Default = Template.bind({});
+Default.args = generateProps();
+
+export default {
+  title: 'base/keyset-pagination',
+  component: GlKeysetPagination,
+  parameters: {
+    bootstrapComponent: false,
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+};