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

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;

package/src/components/CvSearch/CvSearch.stories.mdx

@@ -0,0 +1,168 @@
+import { Canvas, Meta, Story } from '@storybook/addon-docs';
+import CvSearch from './CvSearch.vue';
+import { sbCompPrefix } from '../../global/storybook-utils';
+import { SEARCH_SIZES } from './index';
+import { action } from '@storybook/addon-actions';
+import { ref } from 'vue';
+const myValue = ref('searching galaxies');
+
+<Meta title={`${sbCompPrefix}/CvSearch`} component={CvSearch} />
+
+export const Template = args => ({
+  // Components used in your story `template` are defined in the `components` object
+  components: {
+    CvSearch,
+  },
+  // The story's `args` need to be mapped into the template through the `setup()` method
+  setup() {
+    return {
+      light: args.light,
+      label: args.label,
+      placeholder: args.placeholder,
+      disabled: args.disabled,
+      size: args.size,
+      ariaLabel: args.ariaLabel,
+      clearAriaLabel: args.clearAriaLabel,
+      formItem: args.formItem,
+      expandable: args.expandable,
+      value: args.value,
+      myValue: myValue,
+      onInput: action('input'),
+    };
+  },
+  template: args.template,
+});
+const defaultTemplate = `
+<cv-search
+  :light="light"
+  :label="label"
+  :placeholder="placeholder"
+  :disabled="disabled"
+  :size="size"
+  :expandable="expandable"
+  :value="value"
+  :form-item="formItem"
+  :aria-label="ariaLabel"
+  :clear-aria-label="clearAriaLabel"
+  @input="onInput"
+  >
+</cv-search>
+`;
+const vModelTemplate = `
+<div>
+  <cv-search
+    v-model:value="myValue"
+    :light="light"
+    :label="label"
+    :placeholder="placeholder"
+    :disabled="disabled"
+    :size="size"
+    :expandable="expandable"
+    :form-item="formItem"
+    :aria-label="ariaLabel"
+    :clear-aria-label="clearAriaLabel"
+    >
+  </cv-search>
+  <div style="margin-top:1rem; background-color: #888888;  padding:1rem">
+    <div style="padding:1rem">v-model value: {{ myValue }}</div>
+    <input type="search" v-model="myValue"/>
+  </div>
+</div>
+`;
+
+# CvSearch
+
+Migration notes:
+
+- The `v-model` is different in Vue 3 than Vue 2. If you specify it you will see an error deprecation message in the log.
+  Please use `v-model:value=something` instead.
+- The "toolbar" mode is removed in this version. Please use the `expandable` mode instead.
+
+<Canvas>
+  <Story
+    name="Default"
+    parameters={{
+      controls: {
+        exclude: [
+          'input',
+          'modelValue',
+          'template',
+          'update:modelValue',
+          'update:value',
+          'large',
+          'small',
+          'toolbarAriaLabel',
+          'kind',
+        ],
+      },
+      docs: { source: { code: defaultTemplate } },
+    }}
+    args={{
+      template: defaultTemplate,
+      light: false,
+      disabled: false,
+      placeholder: 'JWST: search for light from the first stars',
+    }}
+    argTypes={{
+      light: {
+        description: '`true` to use the light version.',
+        table: { category: 'props', defaultValue: { summary: false } },
+      },
+      size: {
+        control: 'select',
+        default: 'xl',
+        options: SEARCH_SIZES,
+        table: { defaultValue: { summary: 'xl' } },
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>
+
+# v-model
+
+- The `v-model` is different in Vue 3 than Vue 2.If you specify it you will see an error deprecation message in the log.
+  Please use `v-model:value=something` instead.
+
+<Canvas>
+  <Story
+    name="v-model"
+    parameters={{
+      controls: {
+        exclude: [
+          'input',
+          'modelValue',
+          'template',
+          'update:modelValue',
+          'update:value',
+          'large',
+          'small',
+          'toolbarAriaLabel',
+          'kind',
+        ],
+      },
+      docs: { source: { code: vModelTemplate } },
+    }}
+    args={{
+      template: vModelTemplate,
+      light: false,
+      disabled: false,
+      placeholder: 'JWST: search for light from the first stars',
+    }}
+    argTypes={{
+      light: {
+        description: '`true` to use the light version.',
+        table: { category: 'props', defaultValue: { summary: false } },
+      },
+      size: {
+        control: 'select',
+        default: 'xl',
+        options: SEARCH_SIZES,
+        table: { defaultValue: { summary: 'xl' } },
+      },
+    }}
+  >
+    {Template.bind({})}
+  </Story>
+</Canvas>

package/src/components/CvSearch/CvSearch.vue

@@ -0,0 +1,250 @@
+<template>
+  <component
+    :is="formItem ? 'div' : CvEmpty"
+    :class="`cv-search ${carbonPrefix}--form-item`"
+  >
+    <div
+      :aria-label="internalAriaLabel"
+      :aria-labelledby="internalAriaLabelBy"
+      :class="[
+        `${carbonPrefix}--search`,
+        `${carbonPrefix}--search--${size}`,
+        {
+          [`${carbonPrefix}--search--expandable`]: expandable,
+          [`${carbonPrefix}--search--expanded`]: isExpanded,
+          [`${carbonPrefix}--search--disabled`]: disabled,
+          [`${carbonPrefix}--search--light`]: isLight,
+          'cv-search': !formItem,
+        },
+      ]"
+      role="search"
+      ref="elSearch"
+    >
+      <div
+        :class="`${carbonPrefix}--search-magnifier`"
+        @click="toggleActive(true)"
+        @blur="checkFocus"
+      >
+        <search-icon :class="`${carbonPrefix}--search-magnifier-icon`" />
+      </div>
+
+      <label v-show="label" :for="uid" :class="`${carbonPrefix}--label`">{{
+        label
+      }}</label>
+
+      <input
+        role="searchbox"
+        :id="uid"
+        :class="`${carbonPrefix}--search-input`"
+        v-bind="$attrs"
+        v-model="internalSearchText"
+        @input="onInput"
+        type="text"
+        ref="elInput"
+        :placeholder="placeholder"
+        :aria-labelledby="uid"
+        @blur="checkFocus"
+        @click="toggleActive"
+        @keydown.esc="onClearClick"
+        :disabled="disabled ? 'true' : undefined"
+      />
+
+      <button
+        type="button"
+        :class="[
+          `${carbonPrefix}--search-close`,
+          { [`${carbonPrefix}--search-close--hidden`]: !clearVisible },
+        ]"
+        :title="clearAriaLabel"
+        :aria-label="clearAriaLabel"
+        @click="onClearClick"
+      >
+        <close-icon />
+      </button>
+    </div>
+  </component>
+</template>
+
+<script setup>
+import { carbonPrefix } from '../../global/settings';
+import { useIsLight, props as propsTheme } from '../../use/cvTheme';
+import { useCvId, props as propsCvId } from '../../use/cvId';
+import SearchIcon from '@carbon/icons-vue/es/search/16';
+import CloseIcon from '@carbon/icons-vue/es/close/16';
+import { computed, ref, watch } from 'vue';
+import { SEARCH_SIZES } from '.';
+import CvEmpty from '../CvEmpty/_CvEmpty.vue';
+
+defineOptions({
+  inheritAttrs: false,
+});
+
+const props = defineProps({
+  ariaLabel: { type: String, default: 'search input' },
+  /**
+   * Specify a label to be read by screen readers on the "close" button
+   */
+  clearAriaLabel: { type: String, default: 'Clear search input' },
+  /**
+   * Specify whether the `<input>` should be disabled
+   */
+  disabled: { type: Boolean, default: false },
+  /**
+   * Do no show full control until it has focus. Similar to deprecated toolbar search.
+   */
+  expandable: { type: Boolean, default: false },
+  /**
+   * Wrap search in `<div>` if part of a form
+   */
+  formItem: { type: Boolean, default: true },
+  /**
+   * @deprecated use expandable
+   */
+  kind: {
+    type: String,
+    default: undefined,
+    validator: () => {
+      console.warn('Deprecated: probably you want expandable=true');
+      return true;
+    },
+  },
+  /**
+   * Provide the label text for the Search icon
+   */
+  label: String,
+  /**
+   * Specify the search size ('sm', 'md', 'lg', 'xl')
+   */
+  size: {
+    type: String,
+    default: 'xl',
+    validator: val => SEARCH_SIZES.includes(val),
+  },
+  /**
+   * @deprecated use size
+   */
+  small: {
+    type: Boolean,
+    default: undefined,
+    validator: val => {
+      if (val !== undefined) {
+        console.error('Error: Use size property: sm, lg or xl (default)');
+        return false;
+      }
+      return true;
+    },
+  },
+  /**
+   * @deprecated use size
+   */
+  large: {
+    type: Boolean,
+    default: undefined,
+    validator: val => {
+      if (val !== undefined) {
+        console.error('Error: Use size property: sm, lg or xl (default)');
+        return false;
+      }
+      return true;
+    },
+  },
+  /**
+   * Optionally provide the default value of the `<input>`
+   */
+  value: String,
+  /**
+   * @deprecated use value
+   */
+  modelValue: {
+    type: String,
+    default: undefined,
+    validator: () => {
+      console.warn('Deprecated: use v-model:value instead');
+      return true;
+    },
+  },
+  /**
+   * Provide an optional placeholder text for the Search. Note: if the label and placeholder differ, VoiceOver on Mac will read both
+   */
+  placeholder: { type: String, default: 'Search' },
+  /**
+   * @deprecated
+   */
+  toolbarAriaLabel: {
+    type: String,
+    validator: () => {
+      console.warn('Deprecated: probably you want expandable=true');
+      return true;
+    },
+  },
+  ...propsTheme,
+  ...propsCvId,
+});
+const uid = useCvId(props, true);
+const isLight = useIsLight(props);
+
+const clearVisible = ref(props.value ? props.value.length : false);
+const internalSearchText = ref(props.value || props.modelValue);
+const searchActive = ref(false);
+watch(
+  () => props.value,
+  () => {
+    clearVisible.value = props.value ? props.value.length : false;
+    internalSearchText.value = props.value;
+  }
+);
+
+const internalAriaLabel = computed(() => {
+  if (!props.label) return props.ariaLabel;
+  else return undefined;
+});
+const internalAriaLabelBy = computed(() => {
+  if (props.label) return uid.value;
+  else return undefined;
+});
+
+const emit = defineEmits(['input', 'update:value', 'update:modelValue']);
+watch(internalSearchText, () => {
+  emit('input', internalSearchText.value);
+  emit('update:value', internalSearchText.value);
+  if (props.modelValue) {
+    console.warn('Deprecated: use v-model:value instead');
+    emit('update:modelValue', internalSearchText.value);
+  }
+});
+function onClearClick() {
+  internalSearchText.value = '';
+  clearVisible.value = false;
+  if (props.expandable) {
+    elInput.value?.focus();
+  }
+  checkFocus();
+}
+function onInput() {
+  clearVisible.value = internalSearchText.value.length > 0;
+}
+const elInput = ref(null);
+const isExpanded = computed(() => {
+  return props.expandable && searchActive.value;
+});
+function toggleActive(force) {
+  if (props.disabled) return;
+
+  if (typeof force === 'boolean') searchActive.value = force;
+  else if (internalSearchText.value?.length > 0) searchActive.value = true;
+  else searchActive.value = !searchActive.value;
+
+  if (searchActive.value) {
+    elInput.value?.focus();
+  }
+}
+const elSearch = ref(null);
+function checkFocus() {
+  if (props.disabled) return;
+
+  if (props.expandable) {
+    if (elInput.value !== document.activeElement)
+      searchActive.value = internalSearchText.value?.length > 0;
+  }
+}
+</script>