@carbon/vue 3.0.6-alpha.0 → 3.0.8-alpha.0

package/src/components/CvSlider/CvSlider.vue

@@ -0,0 +1,324 @@
+<template>
+  <div :class="`cv-slider ${carbonPrefix}--form-item`">
+    <label
+      v-show="label"
+      :for="cvId"
+      :class="[
+        `${carbonPrefix}--label`,
+        { [`${carbonPrefix}--label--disabled`]: disabled },
+      ]"
+      :id="labelId"
+    >
+      {{ label }}
+    </label>
+
+    <div :class="`${carbonPrefix}--slider-container`">
+      <span :class="`${carbonPrefix}--slider__range-label`">
+        {{ internalMinLabel }}
+      </span>
+
+      <div
+        :class="[
+          `${carbonPrefix}--slider`,
+          { [`${carbonPrefix}--slider--disabled`]: disabled },
+        ]"
+        data-slider
+        data-slider-input-box="#slider-input-box"
+      >
+        <div
+          :class="`${carbonPrefix}--slider__track`"
+          @click="onTrackClick"
+          ref="track"
+        ></div>
+
+        <div
+          :class="`${carbonPrefix}--slider__filled-track`"
+          :style="`width: ${percentage};`"
+        ></div>
+
+        <div
+          :class="[
+            `${carbonPrefix}--slider__thumb`,
+            {
+              [`${carbonPrefix}--slider__thumb--clicked`]: animateClick,
+            },
+          ]"
+          tabindex="0"
+          :aria-labelledby="labelId"
+          :style="`left: ${percentage};`"
+          ref="thumb"
+          @keydown.up.right.prevent="onUp"
+          @keydown.down.left.prevent="onDown"
+          @mousedown="onStartDrag"
+        ></div>
+
+        <input
+          :id="cvId"
+          :class="`${carbonPrefix}--slider__input`"
+          type="range"
+          :step="step"
+          :min="min"
+          :max="max"
+          ref="range"
+        />
+      </div>
+
+      <span :class="`${carbonPrefix}--slider__range-label`">
+        {{ internalMaxLabel }}
+      </span>
+
+      <input
+        type="string"
+        :class="[
+          `${carbonPrefix}--text-input ${carbonPrefix}--slider-text-input`,
+          { [`${carbonPrefix}--text-input--light`]: isLight },
+        ]"
+        :placeholder="min"
+        v-model="internalValue"
+        @change="onChange"
+        ref="inputBox"
+        @keydown.up.prevent="onUp"
+        @keydown.down.prevent="onDown"
+        :disabled="disabled"
+      />
+    </div>
+  </div>
+</template>
+
+<script setup>
+import { computed, ref, onMounted, nextTick, watch } from 'vue';
+import { carbonPrefix } from '../../global/settings';
+import { props as propsCvId, useCvId } from '../../use/cvId';
+import { useIsLight, props as propsTheme } from '../../use/cvTheme';
+
+const props = defineProps({
+  modelValue: {
+    type: String,
+    default: undefined,
+  },
+  value: {
+    type: String,
+    default: undefined,
+  },
+  disabled: Boolean,
+  label: {
+    type: String,
+    default: undefined,
+  },
+  // NOTE: It is not safe to rely on Numbers for non-integer steps
+  min: {
+    type: String,
+    default: '0',
+  },
+  max: {
+    type: String,
+    default: '100',
+  },
+  minLabel: {
+    type: String,
+    default: undefined,
+  },
+  maxLabel: {
+    type: String,
+    default: undefined,
+  },
+  step: {
+    type: String,
+    default: '1',
+  },
+  stepMultiplier: {
+    type: String,
+    default: '4',
+    validator(val) {
+      if (val.length) {
+        let intMultiplier = parseInt(val);
+        if (isNaN(intMultiplier) || intMultiplier < 1) {
+          console.warn('cv-slider: multiplier must be >= 1');
+          return false;
+        }
+      }
+      return true;
+    },
+  },
+  ...propsTheme,
+  ...propsCvId,
+});
+
+const range = ref(null);
+const thumb = ref(null);
+const track = ref(null);
+const DefaultRangeMin = 0;
+const DefaultRangeMax = 100;
+const DefaultValue = 0;
+const StepNaNReplacement = 0;
+const StepDefaultValue = 1;
+const DefaultMultiplier = 4;
+
+const emit = defineEmits(['update:modelValue', 'change', 'update:value']);
+
+const cvId = useCvId(props, true);
+const isLight = useIsLight(props);
+const internalValue = ref('');
+const animateClick = ref(false);
+const isDragging = ref(false);
+const dragStartX = ref(0);
+const dragStartValue = ref(0);
+const percentage = ref('0%');
+
+const labelId = computed(() => `${cvId.value}-label`);
+
+const internalMinLabel = computed(() => props.minLabel ?? getMin());
+
+const internalMaxLabel = computed(() => props.maxLabel ?? getMax());
+
+const rangePropsObserver = computed(() => ({
+  min: props.min,
+  max: props.max,
+  step: props.step,
+}));
+
+const internalMultiplier = computed(() => {
+  let intMultiplier = parseInt(props.stepMultiplier);
+  // default to 4 fro multiplier
+  return isNaN(intMultiplier) ? DefaultMultiplier : Math.max(intMultiplier, 1);
+});
+
+const getRangeAttributeValue = (
+  attributeName,
+  defaultForNaN,
+  defaultReturnValue
+) => {
+  if (range?.value) {
+    const val = parseFloat(range.value[attributeName]);
+    return isNaN(val) ? defaultForNaN : val;
+  }
+  return defaultReturnValue ?? defaultForNaN;
+};
+
+const getMin = () => {
+  return getRangeAttributeValue('min', DefaultRangeMin);
+};
+
+const getMax = () => {
+  return getRangeAttributeValue('max', DefaultRangeMax);
+};
+
+const getValue = () => {
+  const middleValue = (getMax() + getMin()) / 2;
+  return getRangeAttributeValue('value', DefaultValue, middleValue);
+};
+
+const getStep = () => {
+  return getRangeAttributeValue('step', StepNaNReplacement, StepDefaultValue);
+};
+
+const setValue = newValue => {
+  if (props.disabled) return;
+
+  range.value.value = newValue;
+  internalValue.value = range.value.value;
+
+  percentage.value = `${
+    ((internalValue.value - getMin()) * 100) / (getMax() - getMin())
+  }%`;
+
+  const { value: rangeValue } = range.value;
+  emit('update:modelValue', rangeValue);
+  emit('update:value', rangeValue);
+  emit('change', rangeValue);
+};
+
+const onChange = () => {
+  let newValue = internalValue.value.length
+    ? parseFloat(internalValue.value)
+    : getMin();
+  setValue(newValue);
+};
+
+const onStartDrag = ev => {
+  document.body.addEventListener('mousemove', onDrag);
+  document.body.addEventListener('mouseup', onStopDrag);
+
+  dragStartX.value = ev.clientX;
+  dragStartValue.value = getValue();
+  isDragging.value = true;
+};
+
+const onDrag = ev => {
+  if (isDragging.value) {
+    // percentage change
+    let newValue = (ev.clientX - dragStartX.value) / track.value.offsetWidth;
+    // uncapped new value
+    newValue = dragStartValue.value + (getMax() - getMin()) * newValue;
+    setValue(newValue);
+  }
+};
+
+const onStopDrag = () => {
+  isDragging.value = false;
+  document.body.removeEventListener('mousemove', onDrag);
+  document.body.removeEventListener('mouseup', onStopDrag);
+};
+
+const onTrackClick = ev => {
+  const afterAnimate = ev => {
+    if (ev.propertyName === 'left') {
+      animateClick.value = false;
+      thumb.value.removeEventListener('transitionend', afterAnimate);
+    }
+  };
+
+  let newValue = ev.offsetX / track.value.offsetWidth;
+  const min = getMin();
+  newValue = (getMax() - min) * newValue + min;
+  thumb.value.addEventListener('transitionend', afterAnimate);
+  animateClick.value = true;
+  setValue(newValue);
+};
+
+const onUpDown = (ev, isUp = true) => {
+  let curValue =
+    ev.target.type === 'number' ? parseFloat(ev.target.value) : getValue();
+  const step = getStep();
+  const progressValue = ev.shiftKey ? internalMultiplier.value * step : step;
+  const direction = isUp ? 1 : -1;
+  let newValue = curValue + progressValue * direction;
+  setValue(newValue);
+};
+
+const onUp = ev => {
+  onUpDown(ev);
+};
+
+const onDown = ev => {
+  onUpDown(ev, false);
+};
+
+onMounted(() => {
+  range.value.value = props.value ?? props.modelValue;
+  internalValue.value = range.value.value;
+  percentage.value = `${
+    ((internalValue.value - getMin()) * 100) / (getMax() - getMin())
+  }%`;
+});
+
+watch(
+  () => props.modelValue,
+  modelValue => {
+    setValue(modelValue);
+  }
+);
+
+watch(
+  () => props.value,
+  value => {
+    setValue(value);
+  }
+);
+
+watch(rangePropsObserver, () => {
+  nextTick(() => {
+    setValue(internalValue.value);
+  });
+});
+</script>

package/src/components/CvSlider/CvSliderSkeleton.stories.js

@@ -0,0 +1,26 @@
+import {
+  sbCompPrefix,
+  storyParametersObject,
+} from '../../global/storybook-utils';
+import { sbSliderPrefix } from './sbSliderPrefix';
+import { CvSliderSkeleton } from '.';
+
+export default {
+  title: `${sbCompPrefix}/${sbSliderPrefix}/CvSliderSkeleton`,
+  component: CvSliderSkeleton,
+};
+
+const template = `<cv-slider-skeleton />`;
+const Template = () => {
+  return {
+    components: { CvSliderSkeleton },
+    template,
+  };
+};
+
+export const Default = Template.bind({});
+Default.parameters = storyParametersObject(
+  Default.parameters,
+  template,
+  Default.args
+);

package/src/components/CvSlider/CvSliderSkeleton.vue

@@ -0,0 +1,18 @@
+<template>
+  <div :class="`cv-slider ${carbonPrefix}--form-item`">
+    <label :class="`${carbonPrefix}--label ${carbonPrefix}--skeleton`"></label>
+    <div :class="`${carbonPrefix}--slider-container ${carbonPrefix}--skeleton`">
+      <span :class="`${carbonPrefix}--slider__range-label`"></span>
+      <div :class="`${carbonPrefix}--slider`">
+        <div :class="`${carbonPrefix}--slider__track`"></div>
+        <div :class="`${carbonPrefix}--slider__filled-track`"></div>
+        <div :class="`${carbonPrefix}--slider__thumb`"></div>
+      </div>
+      <span :class="`${carbonPrefix}--slider__range-label`"></span>
+    </div>
+  </div>
+</template>
+
+<script setup>
+import { carbonPrefix } from '../../global/settings';
+</script>

package/src/components/CvSlider/__tests__/__snapshots__/CvSlider.spec.js.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CvSlider should match snapshot 1`] = `
+<div class="cv-slider bx--form-item"><label for="abc" class="bx--label" id="abc-label" style="display: none;"></label>
+  <div class="bx--slider-container"><span class="bx--slider__range-label">0</span>
+    <div class="bx--slider" data-slider="" data-slider-input-box="#slider-input-box">
+      <div class="bx--slider__track"></div>
+      <div class="bx--slider__filled-track" style="width: 0%;"></div>
+      <div class="bx--slider__thumb" tabindex="0" aria-labelledby="abc-label" style="left: 0%;"></div><input id="abc" class="bx--slider__input" type="range" step="1" min="0" max="100">
+    </div><span class="bx--slider__range-label">100</span><input type="string" class="bx--text-input bx--slider-text-input" placeholder="0">
+  </div>
+</div>
+`;

package/src/components/CvSlider/__tests__/__snapshots__/CvSliderSkeleton.spec.js.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CvSliderSkeleton should match snapshot 1`] = `
+<div class="cv-slider bx--form-item"><label class="bx--label bx--skeleton"></label>
+  <div class="bx--slider-container bx--skeleton"><span class="bx--slider__range-label"></span>
+    <div class="bx--slider">
+      <div class="bx--slider__track"></div>
+      <div class="bx--slider__filled-track"></div>
+      <div class="bx--slider__thumb"></div>
+    </div><span class="bx--slider__range-label"></span>
+  </div>
+</div>
+`;

package/src/components/CvSlider/index.js

@@ -0,0 +1,5 @@
+import { default as CvSlider } from './CvSlider.vue';
+import { default as CvSliderSkeleton } from './CvSliderSkeleton.vue';
+
+export { CvSlider, CvSliderSkeleton };
+export default CvSlider;

package/src/components/CvSlider/sbSliderPrefix.js

@@ -0,0 +1,2 @@
+/* istanbul ignore next */
+export const sbSliderPrefix = 'CvSlider';

package/src/components/CvTabs/CvTab.vue

@@ -0,0 +1,77 @@
+<template>
+  <div
+    :class="`cv-tab ${carbonPrefix}--tab-content`"
+    :id="uid"
+    role="tabpanel"
+    :aria-labelledby="`${uid}-link`"
+    :aria-hidden="!dataSelected ? 'true' : 'false'"
+    :hidden="!dataSelected"
+  >
+    <slot>
+      <!-- Content for tab goes here. -->
+    </slot>
+  </div>
+</template>
+
+<script setup>
+import { carbonPrefix } from '../../global/settings';
+import { useCvId, props as propsCvId } from '../../use/cvId';
+import { inject, onBeforeUnmount, onMounted, ref, watch } from 'vue';
+
+const props = defineProps({
+  selected: { type: Boolean, default: false },
+  disabled: { type: Boolean, default: false },
+  label: { type: String, required: true },
+  ...propsCvId,
+});
+const uid = useCvId(props, true);
+
+/**
+ * Is this tab selected?
+ * @type {Ref<UnwrapRef<string>>}
+ */
+const tabSelected = inject('tab-selected');
+const dataSelected = ref(props.selected);
+onMounted(() => {
+  if (props.selected) tabSelected.value = uid.value;
+});
+watch(
+  () => props.selected,
+  () => {
+    if (props.selected) tabSelected.value = uid.value;
+  }
+);
+watch(tabSelected, () => {
+  dataSelected.value = tabSelected.value === uid.value;
+});
+
+/**
+ * Is this tab disabled?
+ * @type {Ref<UnwrapRef<Set>>}
+ */
+const tabDisabledIds = inject('tab-disabled-ids');
+function updateTabDisabled() {
+  if (props.disabled) tabDisabledIds.value?.add(uid.value);
+  else tabDisabledIds.value?.delete(uid.value);
+}
+onMounted(updateTabDisabled);
+watch(() => props.disabled, updateTabDisabled);
+
+/**
+ * Keep this tab's data up to date
+ * @type {Ref<UnwrapRef<Array<TabData>>>}
+ */
+const tabData = inject('tab-data');
+function updateTabData() {
+  const index = tabData.value?.findIndex(tab => tab.uid === uid.value);
+  if (index > -1)
+    tabData.value.splice(index, 1, { uid: uid.value, label: props.label });
+  else tabData.value.push({ uid: uid.value, label: props.label });
+}
+onMounted(updateTabData);
+watch(() => props.label, updateTabData);
+onBeforeUnmount(() => {
+  const index = tabData.value?.findIndex(tab => tab.uid === uid.value);
+  if (index > -1) tabData.value.splice(index, 1);
+});
+</script>

package/src/components/CvTabs/CvTabs.stories.mdx

@@ -0,0 +1,175 @@
+import { Canvas, Meta, Story } from '@storybook/addon-docs';
+import { sbCompPrefix } from '../../global/storybook-utils';
+import CvTabs from './CvTabs.vue';
+import CvTab from './CvTab.vue';
+import CvTabsSkeleton from './CvTabsSkeleton.vue';
+import SbContainer from './_SbContainer.vue';
+import { action } from '@storybook/addon-actions';
+
+<Meta
+  title={`${sbCompPrefix}/CvTabs`}
+  component={CvTabs}
+  decorators={[
+    () => ({
+      components: { SbContainer, Story },
+      template: `<SbContainer><story/></SbContainer>`,
+    }),
+  ]}
+/>
+
+export const Template = args => ({
+  // Components used in your story `template` are defined in the `components` object
+  components: {
+    CvTabs,
+    CvTab,
+    CvTabsSkeleton,
+  },
+  // The story's `args` need to be mapped into the template through the `setup()` method
+  setup() {
+    return {
+      container: args.container,
+      noDefaultToFirst: args.noDefaultToFirst,
+      selectedId: args.selectedId,
+      disabledIds: args.disabledIds,
+      onTabSelected: action('tab-selected'),
+      onTabSelectedId: action('tab-selected-id'),
+    };
+  },
+  // And then the `args` are bound to your component with `v-bind="args"`
+  template: args.template,
+});
+const defaultTemplate = `
+<cv-tabs
+  :container="container"
+  :no-default-to-first="noDefaultToFirst"
+  @tab-selected="onTabSelected"
+  @tab-selected-id="onTabSelectedId"
+  aria-label="navigation tab label">
+    <cv-tab id="tab-1" label="House" :selected="selectedId === 'tab-1'" :disabled="disabledIds.includes('tab-1')">
+      <p>
+        29 Arlington Avenue is a house in Islington, London. Douglas Adams shared the house for a time
+        with Jonny Brock and Clare Gorst. It is mentioned in the dedication of The Hitchhiker's Guide to
+        the Galaxy, which is dedicated to the "Arlingtonians for tea, sympathy, and a sofa."
+      </p>
+    </cv-tab>
+    <cv-tab id="tab-2" label="Bar" :selected="selectedId === 'tab-2'" :disabled="disabledIds.includes('tab-2')">
+      <p>
+        The Old Pink Dog Bar was the bar in Han Dold City that Ford Prefect was in when he discovered
+        that his Guide had his full entry on Earth on it.
+      </p>
+    </cv-tab>
+    <cv-tab id="tab-3" label="Reach" :selected="selectedId === 'tab-3'" :disabled="disabledIds.includes('tab-3')">
+      <p>
+        The Third Reach of the Unknown is what might be loosely described as a "place" which exists only
+        under high improbability conditions and was created on the starship Heart of Gold due to the
+        Infinite Improbability Drive. During Arthur Dent and Ford Prefect's first trip on board the Heart
+        of Gold they witnessed many strange things happening.
+      </p>
+    </cv-tab>
+    <cv-tab id="tab-4" label="Zone" :selected="selectedId === 'tab-4'" :disabled="disabledIds.includes('tab-4')">
+      <p>Plural Zones are instabilities in space-time.
+        The effects of the Plural Zones on the beings and objects that inhabit and originate from them,
+        for the most part, remain largely unnoticed.
+      </p>
+    </cv-tab>
+    <cv-tab id="tab-5" label="Planet" :selected="selectedId === 'tab-5'" :disabled="disabledIds.includes('tab-5')">
+      <p>
+        Ursa Minor Beta is a rich and sunny planet and one of the most popular holiday destinations in
+        the Universe. It is always Saturday afternoon on this planet, just before the beach bars close -
+        except for the few places where it is eternally Saturday evening. This is why the locals always
+        invite visitors to "Have a nice diurnal anomaly!"
+        <a target='_blank' href='https://hitchhikers.fandom.com/wiki/Main_Page'>credits</a>
+      </p>
+    </cv-tab>
+</cv-tabs>
+`;
+const skeletonTemplate = `<cv-tabs-skeleton></cv-tabs-skeleton>`;
+
+# CvTabs
+
+Migration notes:
+
+- The property `leftOverflowIconButtonProps` is deprecated. It does not seem to be used at all in Vue 2 and thus does
+  nothing when specified.
+- The property `rightOverflowIconButtonProps` is deprecated. It does not seem to be used at all in Vue 2 and thus does
+  nothing when specified.
+- The property `scrollIntoView` is deprecated. It does not seem to be used at all in Vue 2 and thus does nothing when
+  specified.
+- The `container` property in Vue 2 acts differently as compared to the React story book. Here the class/styles are
+  applied as is shown in the React storybook. Also note that the background color applied when this property is
+  specified is not from Carbon. The selector `.bx--tabs--container ~ div` can be used to set the background color and
+  other properties but that is up to the user.
+- A new event emits `tab-selected-id` with the selected tab's id attribute.
+
+## Mobile
+
+In my opinion, this component is not suitable for mobile formats. The navigation of the tabs becomes awkward on smaller
+screens, and so I suggest using a different component for mobile cases.
+
+<Canvas>
+  <Story
+    name="Default"
+    parameters={{
+      controls: {
+        exclude: [
+          'default',
+          'template',
+          'leftOverflowIconButtonProps',
+          'rightOverflowIconButtonProps',
+          'scrollIntoView',
+          'tab-selected',
+          'tab-selected-id',
+        ],
+      },
+      docs: { source: { code: defaultTemplate } },
+    }}
+    args={{
+      template: defaultTemplate,
+      selectedId: '',
+      disabledIds: [],
+    }}
+    argTypes={{
+      selectedId: {
+        control: 'select',
+        default: '',
+        options: ['', 'tab-1', 'tab-2', 'tab-3', 'tab-4', 'tab-5'],
+      },
+      disabledIds: {
+        control: 'multi-select',
+        options: ['tab-1', 'tab-2', 'tab-3', 'tab-4', 'tab-5'],
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Skeleton
+
+<Canvas>
+  <Story
+    name="skeleton"
+    parameters={{
+      controls: {
+        exclude: [
+          'default',
+          'template',
+          'leftOverflowIconButtonProps',
+          'rightOverflowIconButtonProps',
+          'scrollIntoView',
+          'tab-selected',
+          'tab-selected-id',
+          'container',
+          'noDefaultToFirst',
+        ],
+      },
+      docs: { source: { code: skeletonTemplate } },
+    }}
+    args={{
+      template: skeletonTemplate,
+    }}
+    argTypes={{}}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>