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

package/src/components/CvProgress/CvProgress.stories.mdx

@@ -0,0 +1,202 @@
+import { Canvas, Meta, Story } from '@storybook/addon-docs';
+import { CvProgress, CvProgressStep } from '.';
+import { Time20 as TimeIcon } from '@carbon/icons-vue';
+// noinspection ES6PreferShortImport
+import { sbCompPrefix } from '../../global/storybook-utils';
+import { action } from '@storybook/addon-actions';
+
+<Meta title={`${sbCompPrefix}/CvProgress`} component={CvProgress} />
+
+export const Template = args => ({
+  // Components used in your story `template` are defined in the `components` object
+  components: {
+    CvProgress,
+    CvProgressStep,
+    TimeIcon,
+  },
+  // The story's `args` need to be mapped into the template through the `setup()` method
+  setup() {
+    return {
+      initialStep: args.initialStep,
+      steps: args.steps,
+      vertical: args.vertical,
+      spaceEqually: args.spaceEqually,
+      step1: args.step1,
+      step2: args.step2,
+      step3: args.step3,
+      step4: args.step4,
+      step5: args.step5,
+      completeIds: args.completeIds,
+      invalidIds: args.invalidIds,
+      disabledIds: args.disabledIds,
+      onStepClicked: action('step-clicked'),
+    };
+  },
+  // And then the `args` are bound to your component with `v-bind="args"`
+  template: args.template,
+});
+const defaultTemplate = `
+  <cv-progress
+    :initial-step="initialStep"
+    :steps="steps"
+    :vertical="vertical"
+    :space-equally="spaceEqually"
+    @step-clicked="onStepClicked">
+  </cv-progress>
+`;
+const slotTemplate = `
+  <cv-progress
+    :initial-step="initialStep"
+    :vertical="vertical"
+    :spaceEqually="spaceEqually"
+    >
+    <cv-progress-step
+      id="step-1"
+      :label="step1"
+      :complete="completeIds.includes('step-1')"
+      :invalid="invalidIds.includes('step-1')"
+      :disabled="disabledIds.includes('step-1')"
+      additionalInfo="with Meg Murry"
+      description="time icon description"
+      @step-clicked="onStepClicked"
+      >
+      <template v-slot:step-icon>
+        <time-icon :class="[{['bx--progress__warning']:invalidIds.includes('step-1')}]"/>
+      </template>
+    </cv-progress-step>
+    <cv-progress-step
+      id="step-2"
+      :label="step2"
+      :complete="completeIds.includes('step-2')"
+      :invalid="invalidIds.includes('step-2')"
+      :disabled="disabledIds.includes('step-2')"
+      additionalInfo="save Charles Wallace"
+      @step-clicked="onStepClicked"
+      >
+    </cv-progress-step>
+    <cv-progress-step
+      id="step-3"
+      :label="step3"
+      :complete="completeIds.includes('step-3')"
+      :invalid="invalidIds.includes('step-3')"
+      :disabled="disabledIds.includes('step-3')"
+      additionalInfo="save the world"
+      @step-clicked="onStepClicked"
+      >
+    </cv-progress-step>
+    <cv-progress-step
+      id="step-4"
+      :label="step4"
+      :complete="completeIds.includes('step-4')"
+      :invalid="invalidIds.includes('step-4')"
+      :disabled="disabledIds.includes('step-4')"
+      additionalInfo="Twins Dennys and Sandy"
+      @step-clicked="onStepClicked"
+      >
+    </cv-progress-step>
+    <cv-progress-step
+      id="step-5"
+      :label="step5"
+      :complete="completeIds.includes('step-5')"
+      :invalid="invalidIds.includes('step-5')"
+      :disabled="disabledIds.includes('step-5')"
+      additionalInfo="with Polyhymnia O'Keefe"
+      @step-clicked="onStepClicked"
+      >
+    </cv-progress-step>
+  </cv-progress>
+`;
+
+# CvProgress
+
+**Migration notes:**
+
+- The "current" icon is updated to match Carbon React
+- Added the property `spaceEqually` to match Carbon React
+- The property name `initialStep` is misleading. It is treated as the Current progress (currentIndex).
+- To override the default icons, provide an icon in the `step-icon` slot in the `cv-progress-step`
+
+<Canvas>
+  <Story
+    name="Default"
+    parameters={{
+      controls: {
+        exclude: ['default', 'template', 'step-clicked'],
+      },
+      docs: { source: { code: defaultTemplate } },
+    }}
+    args={{
+      template: defaultTemplate,
+      steps: [
+        'Planet Uriel',
+        'The Happy Medium',
+        'The Black Thing',
+        'Rescue Dr. Murry',
+        'Rescue Charles Wallace',
+        'Back to Earth',
+      ],
+    }}
+    argTypes={{
+      initialStep: {
+        control: {
+          type: 'number',
+          min: -1,
+          max: 6,
+        },
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# Slotted
+
+Use `cv-progress-step` for more control over the display.
+
+<Canvas>
+  <Story
+    name="slotted"
+    parameters={{
+      controls: {
+        exclude: ['default', 'template', 'step-clicked', 'steps'],
+      },
+      docs: { source: { code: slotTemplate } },
+    }}
+    args={{
+      template: slotTemplate,
+      step1: 'A Wrinkle in Time',
+      step2: 'A Wind in the Door',
+      step3: 'A Swiftly Tilting Planet',
+      step4: 'Many Waters',
+      step5: 'An Acceptable Time',
+      vertical: true,
+      completeIds: [],
+      invalidIds: [],
+      disabledIds: [],
+    }}
+    argTypes={{
+      initialStep: {
+        control: {
+          type: 'number',
+          min: -1,
+          max: 6,
+        },
+      },
+      disabledIds: {
+        control: 'multi-select',
+        options: ['step-1', 'step-2', 'step-3', 'step-4', 'step-5'],
+      },
+      completeIds: {
+        control: 'multi-select',
+        options: ['step-1', 'step-2', 'step-3', 'step-4', 'step-5'],
+      },
+      invalidIds: {
+        control: 'multi-select',
+        options: ['step-1', 'step-2', 'step-3', 'step-4', 'step-5'],
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>

package/src/components/CvProgress/CvProgress.vue

@@ -0,0 +1,78 @@
+<template>
+  <ul
+    data-progress
+    data-progress-current
+    :class="[
+      `cv-progress ${carbonPrefix}--progress`,
+      { [`${carbonPrefix}--progress--space-equal`]: isEqual },
+      { [`${carbonPrefix}--progress--vertical`]: vertical },
+    ]"
+  >
+    <slot>
+      <cv-progress-step
+        v-for="(step, index) in steps"
+        :key="`step:${index}:${initialStep > index}`"
+        :label="step"
+        :complete="initialStep > index"
+        @step-clicked="emit('step-clicked', { ...$event, index })"
+      />
+    </slot>
+  </ul>
+</template>
+
+<script setup>
+// noinspection ES6PreferShortImport
+import { carbonPrefix } from '../../global/settings';
+import CvProgressStep from './CvProgressStep.vue';
+import { computed, onMounted, provide, ref, watch } from 'vue';
+
+const props = defineProps({
+  /**
+   * Optionally specify the current step array index
+   */
+  initialStep: { type: Number, default: 0 },
+  /**
+   * An array of labels for the steps. Use `cv-progress-step` components for more control over the step logic.
+   */
+  steps: Array,
+  /**
+   * Determines whether the ProgressIndicator should be rendered vertically.
+   */
+  vertical: { type: Boolean, default: false },
+  /**
+   * Specify whether the progress steps should be split equally in size in the div
+   */
+  spaceEqually: { type: Boolean, default: false },
+});
+const emit = defineEmits(['step-clicked']);
+
+const isEqual = computed(() => props.spaceEqually && !props.vertical);
+provide('progress-space-equally', isEqual);
+const completedSteps = ref(new Set());
+provide('progress-completed-steps', completedSteps);
+
+/**
+ * @typedef ProgressStepData
+ * @type {string} uid
+ * @type {string} label
+ */
+/**
+ * @type {Ref<UnwrapRef<Array<ProgressStepData>>>}
+ */
+const progressSteps = ref([]);
+provide('progress-steps', progressSteps);
+
+const currentStep = ref('');
+provide('progress-current-step', currentStep);
+function updateSteps() {
+  if (
+    props.initialStep > -1 &&
+    props.initialStep < progressSteps.value.length
+  ) {
+    const step = progressSteps.value[props.initialStep];
+    currentStep.value = step.uid;
+  } else currentStep.value = '';
+}
+onMounted(updateSteps);
+watch(() => props.initialStep, updateSteps);
+</script>

package/src/components/CvProgress/CvProgressStep.vue

@@ -0,0 +1,124 @@
+<!--suppress HtmlUnknownTag -->
+<template>
+  <li
+    :class="[
+      `cv-progress-step ${carbonPrefix}--progress-step`,
+      `${carbonPrefix}--progress-step--${internalState}`,
+    ]"
+    :id="uid"
+    :aria-disabled="disabled"
+  >
+    <button
+      type="button"
+      :class="[
+        `${carbonPrefix}--progress-step-button`,
+        { [`${carbonPrefix}--progress-step-button--unclickable`]: isCurrent },
+      ]"
+      tabindex="-1"
+      :title="label"
+      @click.prevent="emit('step-clicked', { uid })"
+    >
+      <span v-if="isCurrent" :class="`${carbonPrefix}--assistive-text`"
+        >Current</span
+      >
+      <slot name="step-icon">
+        <component :is="stepIcon" :class="stepClass">
+          <title>{{ description }}</title>
+        </component>
+      </slot>
+      <div
+        :class="`${carbonPrefix}--progress-text`"
+        :style="{ maxWidth: isEqual ? 'calc(100% - 1rem)' : undefined }"
+      >
+        <!-- todo: add tooltip when tooltip is implemented -->
+        <!-- <cv-tooltip v-if="tipText" ... v-else -->
+        <div :class="[`${carbonPrefix}--progress-label`]">
+          {{ label }}
+        </div>
+        <p v-if="additionalInfo" class="bx--progress-optional">
+          {{ additionalInfo }}
+        </p>
+      </div>
+      <span :class="`${carbonPrefix}--progress-line`"></span>
+    </button>
+  </li>
+</template>
+
+<script setup>
+import {
+  Incomplete16,
+  CheckmarkOutline16,
+  Warning16,
+  CircleDash16,
+} from '@carbon/icons-vue';
+// noinspection ES6PreferShortImport
+import { carbonPrefix } from '../../global/settings';
+import { useCvId, props as propsCvId } from '../../use/cvId';
+import { computed, inject, onBeforeUnmount, onMounted, ref, watch } from 'vue';
+
+const STEP_CURRENT = 'current';
+const STEP_COMPLETE = 'complete';
+const STEP_INCOMPLETE = 'incomplete';
+const STEP_DISABLED = 'disabled';
+
+const props = defineProps({
+  additionalInfo: String,
+  description: String,
+  disabled: Boolean,
+  invalid: Boolean,
+  label: String,
+  tipText: String,
+  complete: Boolean,
+  ...propsCvId,
+});
+const uid = useCvId(props, true);
+const isEqual = inject('progress-space-equally');
+
+const emit = defineEmits(['step-clicked']);
+
+const internalState = ref(STEP_INCOMPLETE);
+/**
+ * @type {Ref<UnwrapRef<string>>}
+ */
+const currentStep = inject('progress-current-step');
+const isCurrent = computed(() => {
+  return uid.value === currentStep.value;
+});
+/**
+ * @type {Ref<UnwrapRef<Array<ProgressStepData>>>}
+ */
+const progressSteps = inject('progress-steps');
+/**
+ * @type {Ref<UnwrapRef<Set<string>>>}
+ */
+const completedSteps = inject('progress-completed-steps');
+function checkCurrentStep() {
+  if (props.disabled) internalState.value = STEP_DISABLED;
+  else if (isCurrent.value) internalState.value = STEP_CURRENT;
+  else if (props.complete) internalState.value = STEP_COMPLETE;
+  else internalState.value = STEP_INCOMPLETE;
+
+  const stepData = { uid: uid.value, state: internalState.value };
+  const index = progressSteps.value.findIndex(step => step.uid === uid.value);
+  if (index > -1) progressSteps.value.splice(index, 1, stepData);
+  else progressSteps.value.push(stepData);
+}
+onMounted(checkCurrentStep);
+watch(currentStep, checkCurrentStep);
+watch(completedSteps, checkCurrentStep);
+
+onBeforeUnmount(() => {
+  const index = progressSteps.value.findIndex(step => step.uid === uid.value);
+  if (index > -1) progressSteps.value.splice(index, 1);
+});
+const stepClass = computed(() => {
+  return props.invalid ? `${carbonPrefix}--progress__warning` : '';
+});
+
+const stepIcon = computed(() => {
+  if (props.invalid) return Warning16;
+  else if (internalState.value === STEP_CURRENT) return Incomplete16;
+  else if (internalState.value === STEP_COMPLETE) return CheckmarkOutline16;
+  else return CircleDash16;
+});
+</script>

package/src/components/CvProgress/index.js

@@ -0,0 +1,4 @@
+import CvProgress from './CvProgress.vue';
+import CvProgressStep from './CvProgressStep.vue';
+
+export { CvProgress, CvProgressStep };

package/src/components/CvRadioButton/CvRadioButton.stories.js

@@ -0,0 +1,166 @@
+import { action } from '@storybook/addon-actions';
+import { CvRadioButton, CvRadioGroup } from '.';
+import {
+  sbCompPrefix,
+  storyParametersObject,
+} from '../../global/storybook-utils';
+import { ref } from 'vue';
+
+export default {
+  title: `${sbCompPrefix}/CvRadioButton`,
+  component: CvRadioButton,
+  argTypes: {
+    checked: {
+      type: 'boolean',
+      control: false,
+      table: {
+        type: { summary: 'boolean' },
+        category: 'props',
+      },
+    },
+    label: {
+      description: 'radio-button label',
+      control: false,
+    },
+    hideLabel: {
+      description:
+        'makes the label visually hidden but still labels the radio input',
+    },
+    labelLeft: {
+      type: 'boolean',
+      table: {
+        type: { summary: 'boolean' },
+        category: 'props',
+      },
+      description: 'position label on left',
+    },
+    vertical: {
+      type: 'boolean',
+      table: {
+        type: { summary: 'boolean' },
+        category: 'props',
+      },
+      description:
+        'Property of CvRadioGroup component - stacks inside radio components vertically',
+    },
+  },
+};
+
+const DefaultRadioItems = [
+  {
+    label: 'radio-1',
+    id: 'value-1',
+    checked: true,
+  },
+  {
+    label: 'radio-2',
+    id: 'value-2',
+    disabled: true,
+  },
+  {
+    label: 'radio-3',
+    id: 'value-3',
+  },
+];
+
+const DefaultStoryParameters = {
+  controls: {
+    exclude: ['change', 'update:modelValue', 'modelValue'],
+  },
+};
+
+const defaultTemplate = `
+  <cv-radio-group v-bind="args" @change="onChange">
+    <cv-radio-button
+      v-for="({id, label, checked, disabled}, index) in DefaultRadioItems"
+      :key="index"
+      name="group-1"
+      :label="label"
+      :value="id"
+      :checked="checked"
+      :disabled="disabled"
+      :hide-label="hideLabel"
+      :label-left='labelLeft'
+    />
+  </cv-radio-group>
+`;
+
+const Template = (args, { argTypes }) => {
+  return {
+    props: Object.keys(argTypes),
+    components: { CvRadioButton, CvRadioGroup },
+    template: defaultTemplate,
+    setup() {
+      return {
+        args,
+        hideLabel: args.hideLabel,
+        labelLeft: args.labelLeft,
+        onChange: action('change'),
+        DefaultRadioItems,
+      };
+    },
+  };
+};
+
+export const Default = Template.bind({});
+Default.args = {
+  vertical: false,
+};
+Default.parameters = storyParametersObject(
+  DefaultStoryParameters,
+  defaultTemplate,
+  Default.args
+);
+
+const vModelTemplate = `
+  <cv-radio-group v-bind="args" @change="onChange">
+    <cv-radio-button
+      v-for="({id, label, checked, disabled}, index) in DefaultRadioItems"
+      v-model="modelValue"
+      :key="index"
+      name="group-1"
+      :label="label"
+      :value="id"
+      :disabled="disabled"
+      :hide-label="hideLabel"
+      :label-left='labelLeft'
+    />
+  </cv-radio-group>
+
+  <div style="margin-top:1rem; background-color: #888888;  padding:1rem">
+    V-model:
+    <template
+      v-for="({id, label}, index) in DefaultRadioItems"
+      :key="index"
+    >
+      <input name="modelValue" :id="id" type="radio" @change="(ev) => {modelValue = ev.target.id}" :checked="id === modelValue" />
+      <label :for="id" style="margin-right: 16px;">{{label}}:</label>
+    </template>
+
+    <div style="margin-top: 16px;">Checked: <span style="font-weight: bold;">{{modelValue}}</span></div>
+  </div>
+`;
+
+const VModelTemplate = args => {
+  return {
+    components: { CvRadioButton, CvRadioGroup },
+    template: vModelTemplate,
+    setup() {
+      return {
+        args,
+        hideLabel: args.hideLabel,
+        labelLeft: args.labelLeft,
+        modelValue: ref(DefaultRadioItems[0].id),
+        onChange: action('change'),
+        DefaultRadioItems,
+      };
+    },
+  };
+};
+
+export const VModel = VModelTemplate.bind({});
+VModel.parameters = storyParametersObject(
+  DefaultStoryParameters,
+  vModelTemplate,
+  VModel.args
+);

package/src/components/CvRadioButton/CvRadioButton.vue

@@ -0,0 +1,57 @@
+<template>
+  <div
+    :class="[
+      `cv-radio-button ${carbonPrefix}--radio-button-wrapper`,
+      { [`${carbonPrefix}--radio-button-wrapper--label-left`]: labelLeft },
+    ]"
+  >
+    <input
+      v-bind="$attrs"
+      :id="cvId"
+      :checked="isChecked"
+      :class="`${carbonPrefix}--radio-button`"
+      ref="input"
+      type="radio"
+      :value="value"
+      @change="onChange"
+    />
+    <!-- symbol causes problem in codepen? -->
+    <label :for="cvId" :class="`${carbonPrefix}--radio-button__label`">
+      <span :class="`${carbonPrefix}--radio-button__appearance`"></span>
+      <span
+        v-if="label"
+        :class="{ [`${carbonPrefix}--visually-hidden`]: hideLabel }"
+      >
+        {{ label }}
+      </span>
+    </label>
+  </div>
+</template>
+
+<script setup>
+import { carbonPrefix } from '../../global/settings';
+import { useCvId, propsCvId, useMethods, useRadio } from '../../use';
+
+const props = defineProps({
+  modelValue: String,
+  checked: Boolean,
+  label: String,
+  value: { type: String, required: true },
+  hideLabel: Boolean,
+  labelLeft: Boolean,
+  ...propsCvId,
+});
+
+const cvId = useCvId(props);
+
+const emit = defineEmits(['update:modelValue', 'change']);
+
+useMethods({ input: ['blur', 'focus'] });
+const { isChecked, onChange } = useRadio(props, emit);
+</script>
+
+<script>
+export default {
+  inheritAttrs: false,
+};
+</script>

package/src/components/CvRadioButton/CvRadioGroup.vue

@@ -0,0 +1,27 @@
+<template>
+  <div :class="`cv-radio-group ${carbonPrefix}--form-item`">
+    <div
+      :class="[
+        `${carbonPrefix}--radio-button-group`,
+        { [`${carbonPrefix}--radio-button-group--vertical`]: vertical },
+      ]"
+    >
+      <slot></slot>
+    </div>
+  </div>
+</template>
+
+<script setup>
+import { provide } from 'vue';
+import { carbonPrefix } from '../../global/settings';
+
+defineProps({
+  vertical: Boolean,
+});
+
+const emit = defineEmits(['change']);
+
+provide('onRadioItemChange', clickedItemCvId => {
+  emit('change', clickedItemCvId);
+});
+</script>

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

@@ -0,0 +1,27 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CvRadioButton matches render when checked 1`] = `<div class="cv-radio-button bx--radio-button-wrapper"><input id="1" class="bx--radio-button" type="radio" value=""><!-- symbol causes problem in codepen? --><label for="1" class="bx--radio-button__label"><span class="bx--radio-button__appearance"></span><span class="">test label</span></label></div>`;
+
+exports[`CvRadioButton matches render when modelValue is equal to value 1`] = `<div class="cv-radio-button bx--radio-button-wrapper"><input id="1" class="bx--radio-button" type="radio" value="test value"><!-- symbol causes problem in codepen? --><label for="1" class="bx--radio-button__label"><span class="bx--radio-button__appearance"></span><span class="">test label</span></label></div>`;
+
+exports[`CvRadioButton matches render when modelValue is not equal to value 1`] = `<div class="cv-radio-button bx--radio-button-wrapper"><input id="1" class="bx--radio-button" type="radio" value="test value"><!-- symbol causes problem in codepen? --><label for="1" class="bx--radio-button__label"><span class="bx--radio-button__appearance"></span><span class="">test label</span></label></div>`;
+
+exports[`CvRadioButton matches render with left label 1`] = `<div class="cv-radio-button bx--radio-button-wrapper bx--radio-button-wrapper--label-left"><input id="1" class="bx--radio-button" type="radio" value=""><!-- symbol causes problem in codepen? --><label for="1" class="bx--radio-button__label"><span class="bx--radio-button__appearance"></span><span class="">left label</span></label></div>`;
+
+exports[`CvRadioButton matches render with right label 1`] = `<div class="cv-radio-button bx--radio-button-wrapper"><input id="1" class="bx--radio-button" type="radio" value=""><!-- symbol causes problem in codepen? --><label for="1" class="bx--radio-button__label"><span class="bx--radio-button__appearance"></span><span class="">right label</span></label></div>`;
+
+exports[`CvRadioGroup matches render when horizontal 1`] = `
+<div class="cv-radio-group bx--form-item">
+  <div class="bx--radio-button-group">
+    <div class="cv-radio-button-stub">RadioButtonStub</div>
+  </div>
+</div>
+`;
+
+exports[`CvRadioGroup matches render when vertical 1`] = `
+<div class="cv-radio-group bx--form-item">
+  <div class="bx--radio-button-group bx--radio-button-group--vertical">
+    <div class="cv-radio-button-stub">RadioButtonStub</div>
+  </div>
+</div>
+`;

package/src/components/CvRadioButton/index.js

@@ -0,0 +1,6 @@
+import CvRadioButton from './CvRadioButton.vue';
+import CvRadioGroup from './CvRadioGroup.vue';
+
+export { CvRadioButton, CvRadioGroup };
+
+export default CvRadioButton;