@carbon/vue 3.0.5-alpha.0 → 3.0.7-alpha.0

package/src/components/CvDatePicker/plugins/monthSelectPlugin.js

@@ -0,0 +1,86 @@
+/*
+ * COPIED FROM carbon-components-react
+ */
+
+/**
+ * @param {number} monthNumber The month number.
+ * @param {boolean} shorthand `true` to use shorthand month.
+ * @param {Locale} locale The Flatpickr locale data.
+ * @returns {string} The month string.
+ */
+const monthToStr = (monthNumber, shorthand, locale) =>
+  locale.months[shorthand ? 'shorthand' : 'longhand'][monthNumber];
+
+/**
+ * @param {object} config Plugin configuration.
+ * @param {boolean} [config.shorthand] `true` to use shorthand month.
+ * @param {string} config.selectorFlatpickrMonthYearContainer The CSS selector for the container of month/year selection UI.
+ * @param {string} config.selectorFlatpickrYearContainer The CSS selector for the container of year selection UI.
+ * @param {string} config.selectorFlatpickrCurrentMonth The CSS selector for the text-based month selection UI.
+ * @param {string} config.classFlatpickrCurrentMonth The CSS class for the text-based month selection UI.
+ * @returns {Plugin} A Flatpickr plugin to use text instead of `<select>` for month picker.
+ */
+export default config => fp => {
+  const setupElements = () => {
+    if (!fp.monthElements || fp.monthElements.length < 1) {
+      return;
+    }
+    fp.monthElements.forEach(elem => {
+      if (!elem.parentNode) return;
+      elem.parentNode.removeChild(elem);
+    });
+    fp.monthElements.splice(
+      0,
+      fp.monthElements.length,
+      ...fp.monthElements.map(() => {
+        // eslint-disable-next-line no-underscore-dangle
+        const monthElement = fp._createElement(
+          'span',
+          config.classFlatpickrCurrentMonth
+        );
+        monthElement.textContent = monthToStr(
+          fp.currentMonth,
+          config.shorthand === true,
+          fp.l10n
+        );
+        fp.yearElements[0]
+          .closest(config.selectorFlatpickrMonthYearContainer)
+          .insertBefore(
+            monthElement,
+            fp.yearElements[0].closest(config.selectorFlatpickrYearContainer)
+          );
+        return monthElement;
+      })
+    );
+  };
+
+  const updateCurrentMonth = () => {
+    const monthStr = monthToStr(
+      fp.currentMonth,
+      config.shorthand === true,
+      fp.l10n
+    );
+    fp.yearElements.forEach(elem => {
+      const currentMonthContainer = elem.closest(
+        config.selectorFlatpickrMonthYearContainer
+      );
+      Array.prototype.forEach.call(
+        currentMonthContainer.querySelectorAll('.cur-month'),
+        monthElement => {
+          monthElement.textContent = monthStr;
+        }
+      );
+    });
+  };
+
+  const register = () => {
+    fp.loadedPlugins.push('carbonFlatpickrMonthSelectPlugin');
+  };
+
+  return {
+    onMonthChange: updateCurrentMonth,
+    onValueUpdate: updateCurrentMonth,
+    onOpen: updateCurrentMonth,
+    onReady: [setupElements, updateCurrentMonth, register],
+  };
+};

package/src/components/CvDatePicker/plugins/rangePlugin.js

@@ -0,0 +1,47 @@
+import rangePlugin from 'flatpickr/dist/plugins/rangePlugin';
+
+/*
+ * COPIED FROM carbon-components-react
+ */
+
+/**
+ * @param {object} config Plugin configuration.
+ * @returns {Plugin} An extension of Flatpickr `rangePlugin` that does the following:
+ *   * Better ensures the calendar dropdown is always aligned to the `<input>` for the starting date.
+ *     Workaround for: https://github.com/flatpickr/flatpickr/issues/1944
+ *   * A logic to ensure `fp.setDate()` call won't end up with "startDate to endDate" set to the first `<input>`
+ */
+export default config => {
+  const factory = rangePlugin(Object.assign({ position: 'left' }, config));
+
+  return fp => {
+    const origSetDate = fp.setDate;
+
+    const init = () => {
+      fp.setDate = function setDate(dates, triggerChange, format) {
+        origSetDate.call(this, dates, triggerChange, format);
+        // If `triggerChange` is `true`, `onValueUpdate` Flatpickr event is fired
+        // where Flatpickr's range plugin takes care of fixing the first `<input>`
+        if (!triggerChange) {
+          const { _input: inputFrom } = fp;
+          const { input: inputTo } = config;
+          [inputFrom, inputTo].forEach((input, i) => {
+            if (input) {
+              input.value = !dates[i]
+                ? ''
+                : fp.formatDate(new Date(dates[i]), fp.config.dateFormat);
+            }
+          });
+        }
+      };
+    };
+
+    const origRangePlugin = factory(fp);
+    const { onReady: origOnReady } = origRangePlugin;
+
+    return Object.assign(origRangePlugin, {
+      onReady: [init, origOnReady],
+      onPreCalendarPosition() {},
+    });
+  };
+};

package/src/components/CvDropdown/CvDropdown.stories.mdx

@@ -0,0 +1,407 @@
+import { Canvas, Meta, Story } from '@storybook/addon-docs';
+import { sbCompPrefix } from '../../global/storybook-utils';
+import CvDropdown from './CvDropdown.vue';
+import CvDropdownItem from './CvDropdownItem.vue';
+import CvDropdownSkeleton from './CvDropdownSkeleton.vue';
+import { action } from '@storybook/addon-actions';
+import { ref } from 'vue';
+const myValue = ref('baby-yoda');
+
+<Meta title={`${sbCompPrefix}/CvDropdown`} component={CvDropdown} />
+
+export const Template = args => ({
+  // Components used in your story `template` are defined in the `components` object
+  components: {
+    CvDropdown,
+    CvDropdownItem,
+    CvDropdownSkeleton,
+  },
+  // The story's `args` need to be mapped into the template through the `setup()` method
+  setup() {
+    return {
+      ...args,
+      props: args.props,
+      light: args.light,
+      placeholder: args.placeholder,
+      value: args.value,
+      label: args.label,
+      up: args.up,
+      inline: args.inline,
+      helperText: args.helperText,
+      hideSelected: args.hideSelected,
+      warningMessage: args.warningMessage,
+      invalidMessage: args.invalidMessage,
+      disabled: args.disabled,
+      size: args.size,
+      items: args.items,
+      onChange: action('change'),
+      myValue: myValue,
+      slotInvalidText: args.slotInvalidText,
+      slotWarningText: args.slotWarningText,
+      slotHelperText: args.slotHelperText,
+      slotInternalCaption: args.slotInternalCaption,
+    };
+  },
+  template: args.template,
+});
+const defaultTemplate = `
+<div :style="{width: '300px', paddingTop: up ? '90px' : undefined}">
+<cv-dropdown
+  :light="light"
+  :placeholder="placeholder"
+  :value="value"
+  :up="up"
+  :inline="inline"
+  :helper-text="helperText"
+  :warning-message="warningMessage"
+  :hide-selected="hideSelected"
+  :invalid-message="invalidMessage"
+  :label="label"
+  :disabled="disabled"
+  :size="size"
+  @change="onChange">
+          <cv-dropdown-item value="mando"><span style="color: darkred">Din Djarin</span></cv-dropdown-item>
+          <cv-dropdown-item value="nite-owl">Bo-Katan Kryze</cv-dropdown-item>
+          <cv-dropdown-item value="baby-yoda">Din Grogu</cv-dropdown-item>
+          <cv-dropdown-item value="mysterious">The Armorer</cv-dropdown-item>
+          <cv-dropdown-item value="bounty-hunter">Greef Karga</cv-dropdown-item>
+ </cv-dropdown>
+</div>
+`;
+const slotsTemplate = `
+<div :style="{width: '300px'}">
+<cv-dropdown
+  v-model:value="myValue"
+  :light="light"
+  :placeholder="placeholder"
+  :up="up"
+  :inline="inline"
+  :helper-text="helperText"
+  :warning-message="warningMessage"
+  :hide-selected="hideSelected"
+  :invalid-message="invalidMessage"
+  :label="label"
+  :disabled="disabled"
+  :size="size"
+  @change="onChange">
+    <template v-if="slotInternalCaption" v-slot:internal-caption><h5>Edge case: {{ myValue }}</h5></template>
+    <template v-if="slotInvalidText" v-slot:invalid-message>Do not go to the dark side</template>
+    <template v-if="slotWarningText" v-slot:warning-message>Can this ally be trusted?</template>
+    <template v-if="slotHelperText" v-slot:helper-text>Choose ally strong with the force</template>
+    <cv-dropdown-item value="mando"><span>Din Djarin</span></cv-dropdown-item>
+    <cv-dropdown-item value="nite-owl">Bo-Katan Kryze</cv-dropdown-item>
+    <cv-dropdown-item value="baby-yoda">Din Grogu</cv-dropdown-item>
+    <cv-dropdown-item value="mysterious">The Armorer</cv-dropdown-item>
+    <cv-dropdown-item value="bounty-hunter">Greef Karga</cv-dropdown-item>
+ </cv-dropdown>
+</div>
+`;
+const itemsTemplate = `
+<div :style="{width: '300px'}">
+<cv-dropdown
+  :light="light"
+  :placeholder="placeholder"
+  :value="value"
+  :up="up"
+  :inline="inline"
+  :helper-text="helperText"
+  :warning-message="warningMessage"
+  :hide-selected="hideSelected"
+  :invalid-message="invalidMessage"
+  :label="label"
+  :disabled="disabled"
+  :size="size"
+  :items="items"
+  @change="onChange">
+ </cv-dropdown>
+</div>
+`;
+const vmodelTemplate = `
+<div :style="{width: '300px'}">
+<cv-dropdown
+  v-model:value="myValue"
+  :label="label"
+  :placeholder="placeholder"
+  @change="onChange">
+    <cv-dropdown-item value="mando"><span>Din Djarin</span></cv-dropdown-item>
+    <cv-dropdown-item value="nite-owl">Bo-Katan Kryze</cv-dropdown-item>
+    <cv-dropdown-item value="baby-yoda">Din Grogu</cv-dropdown-item>
+    <cv-dropdown-item value="mysterious">The Armorer</cv-dropdown-item>
+    <cv-dropdown-item value="bounty-hunter">Greef Karga</cv-dropdown-item>
+ </cv-dropdown>
+ <div>V-Model value: {{ myValue }}</div>
+  <select v-model="myValue">
+    <option value="mando">Mandalorian</option>
+    <option value="nite-owl">Bo-Katan</option>
+    <option value="baby-yoda">Grogu</option>
+    <option value="mysterious">Armorer</option>
+    <option value="bounty-hunter">Karga</option>
+  </select>
+</div>
+`;
+const skeletonTemplate = `
+<div :style="{width: '300px'}">
+<cv-dropdown-skeleton :inline="inline"></cv-dropdown-skeleton>
+</div>
+`;
+
+# CvDropdown
+
+Notes:
+
+- You can place a Dropdown inline with other content by using the inline variant
+  Migration notes:
+
+- The `v-model` is different in Vue 3 than Vue 2. You can still specify the `v-model=something` to control the visibility but
+  if you specify it like this you will see a deprecation message in the log. Please use `v-model:value=something` instead.
+- Add the `size` option to match Carbon React
+- Added the `warningMessage` option to match Carbon React
+
+<Canvas>
+  <Story
+    name="Default"
+    parameters={{
+      controls: {
+        exclude: [
+          'props',
+          'default',
+          'template',
+          'change',
+          'update:modelValue',
+          'update:value',
+          'helper-text',
+          'invalid-message',
+          'warning-message',
+          'internal-caption',
+          'modelValue',
+        ],
+      },
+      docs: { source: { code: defaultTemplate } },
+    }}
+    args={{
+      template: defaultTemplate,
+      props: {
+        modelValue: undefined,
+      },
+      label: 'Characters',
+      placeholder: 'Choose an ally',
+      helperText: 'May the force be with you',
+      light: false,
+    }}
+    argTypes={{
+      light: {
+        type: String,
+        description: '`true` to use the light version',
+        table: { category: 'props' },
+      },
+      size: {
+        control: 'select',
+        default: 'md',
+        options: ['sm', 'md', 'lg'],
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Use slots with helper, invalid, warning text, and the internal caption
+
+<Canvas>
+  <Story
+    name="Slots"
+    parameters={{
+      controls: {
+        exclude: [
+          'props',
+          'default',
+          'template',
+          'change',
+          'update:modelValue',
+          'update:value',
+          'helper-text',
+          'invalid-message',
+          'warning-message',
+          'internal-caption',
+          'modelValue',
+          'ariaLabel',
+          'disabled',
+          'formItem',
+          'helperText',
+          'hideSelected',
+          'inline',
+          'invalidMessage',
+          'items',
+          'label',
+          'placeholder',
+          'size',
+          'up',
+          'value',
+          'warningMessage',
+        ],
+      },
+      docs: { source: { code: slotsTemplate } },
+    }}
+    args={{
+      template: slotsTemplate,
+      label: 'Characters',
+      placeholder: 'Choose an ally',
+      slotInvalidText: false,
+      slotWarningText: false,
+      slotHelperText: true,
+      slotInternalCaption: false,
+    }}
+    argTypes={{}}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Use an array of strings as the dropdown options
+
+- Notes: this version does not seem very useful. Please comment in the Slack channel if you are using this.
+  Curious to know how it might be currently used.
+
+<Canvas>
+  <Story
+    name="Items"
+    parameters={{
+      controls: {
+        exclude: [
+          'props',
+          'default',
+          'template',
+          'change',
+          'update:modelValue',
+          'update:value',
+          'helper-text',
+          'invalid-message',
+          'warning-message',
+          'internal-caption',
+          'modelValue',
+          'ariaLabel',
+          'disabled',
+          'formItem',
+          'helperText',
+          'hideSelected',
+          'inline',
+          'invalidMessage',
+          'items',
+          'label',
+          'placeholder',
+          'size',
+          'up',
+          'value',
+          'warningMessage',
+        ],
+      },
+      docs: { source: { code: itemsTemplate } },
+    }}
+    args={{
+      template: itemsTemplate,
+      label: 'Planets',
+      placeholder: 'Where will you visit',
+      items: ['Coruscant', 'Tatooine', 'Naboo', 'Hoth', 'Kamino', 'Mandalore'],
+    }}
+    argTypes={{}}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Use with v-model
+
+<Canvas>
+  <Story
+    name="v-model"
+    parameters={{
+      controls: {
+        exclude: [
+          'props',
+          'default',
+          'template',
+          'change',
+          'update:modelValue',
+          'update:value',
+          'helper-text',
+          'invalid-message',
+          'warning-message',
+          'internal-caption',
+          'modelValue',
+          'ariaLabel',
+          'disabled',
+          'formItem',
+          'helperText',
+          'hideSelected',
+          'inline',
+          'invalidMessage',
+          'items',
+          'label',
+          'placeholder',
+          'size',
+          'up',
+          'value',
+          'warningMessage',
+        ],
+      },
+      docs: { source: { code: vmodelTemplate } },
+    }}
+    args={{
+      template: vmodelTemplate,
+      label: 'Characters',
+      placeholder: 'Choose an ally',
+    }}
+    argTypes={{}}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Skeleton - loading mode
+
+- Notes: The Vue 2 story shows the `inline` attribute for the skeleton mode but this seems to have no effect on the display.
+  It is still supported but do not expect a change in display.
+
+<Canvas>
+  <Story
+    name="skeleton"
+    parameters={{
+      controls: {
+        exclude: [
+          'props',
+          'default',
+          'template',
+          'change',
+          'update:modelValue',
+          'update:value',
+          'helper-text',
+          'invalid-message',
+          'warning-message',
+          'internal-caption',
+          'modelValue',
+          'ariaLabel',
+          'disabled',
+          'formItem',
+          'helperText',
+          'hideSelected',
+          'invalidMessage',
+          'items',
+          'label',
+          'placeholder',
+          'size',
+          'up',
+          'value',
+          'warningMessage',
+          'inline',
+        ],
+      },
+      docs: { source: { code: skeletonTemplate } },
+    }}
+    args={{
+      template: skeletonTemplate,
+    }}
+    argTypes={{}}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>