Merge pull request #62 from metonym/form

feat(components): add RadioButtonGroup, Select, SelectItem, SelectItemGroup

README.md

@@ -44,8 +44,13 @@ Currently, the following components are supported:
   - ProgressStep
 - RadioButton
   - RadioButtonSkeleton
+- RadioButtonGroup
 - Search
   - SearchSkeleton
+- Select
+  - SelectSkeleton
+  - SelectItem
+  - SelectItemGroup
 - SkeletonPlaceholder
 - SkeletonText
 - Tag

src/components/RadioButton/RadioButton.Skeleton.svelte

@@ -1,14 +1,14 @@
 <script>
   let className = undefined;
   export { className as class };
-  export let props = {};
+  export let style = undefined;
 
   import { cx } from '../../lib';
 
   const _class = cx('--radio-button-wrapper', className);
 </script>
 
-<div {...props} class={_class}>
+<div on:click on:mouseover on:mouseenter on:mouseleave class={_class} {style}>
   <div class={cx('--radio-button', '--skeleton')} />
   <span class={cx('--radio-button__label', '--skeleton')} />
 </div>

src/components/RadioButton/RadioButton.Story.svelte

@@ -8,11 +8,8 @@
 </script>
 
 <Layout>
-
   {#if story === 'skeleton'}
-    <div>
-      <RadioButtonSkeleton />
-    </div>
+    <RadioButtonSkeleton />
   {:else}
     <RadioButton {...$$props} id="radio-1" />
   {/if}

src/components/RadioButton/RadioButton.svelte

@@ -9,26 +9,38 @@
   export let hideLabel = false;
   export let labelPosition = 'right';
   export let name = '';
-  export let props = {};
+  export let style = undefined;
 
+  import { getContext } from 'svelte';
+  import { writable } from 'svelte/store';
   import { cx } from '../../lib';
 
+  const ctx = getContext('RadioButtonGroup');
   const _class = cx(
     '--radio-button-wrapper',
     labelPosition !== 'right' && `--radio-button-wrapper--label-${labelPosition}`,
     className
   );
   const _innerLabelClass = cx(hideLabel && '--visually-hidden');
+
+  let selected = ctx ? ctx.selected : writable(checked ? value : undefined);
+
+  if (ctx) {
+    ctx.add({ id, checked, disabled, value });
+  }
+
+  $: checked = $selected === value;
 </script>
 
-<div class={_class}>
+<div class={_class} {style}>
   <input
-    {...props}
     type="radio"
     class={cx('--radio-button')}
     on:change
-    on:change={event => {
-      value = event.target.value;
+    on:change={() => {
+      if (ctx) {
+        ctx.update(value);
+      }
     }}
     {id}
     {name}

src/components/RadioButtonGroup/RadioButtonGroup.Story.svelte

@@ -0,0 +1,16 @@
+<script>
+  import Layout from '../../internal/ui/Layout.svelte';
+  import RadioButtonGroup from './RadioButtonGroup.svelte';
+  import RadioButton from '../RadioButton';
+  import { FormGroup } from '../Form';
+</script>
+
+<Layout>
+  <FormGroup legendText="Radio Button heading">
+    <RadioButtonGroup {...$$props.group} defaultSelected="default-selected" legend="Group Legend">
+      <RadioButton {...$$props.radio} value="standard" id="radio-1" />
+      <RadioButton {...$$props.radio} value="default-selected" id="radio-2" />
+      <RadioButton {...$$props.radio} value="disabled" id="radio-3" />
+    </RadioButtonGroup>
+  </FormGroup>
+</Layout>

src/components/RadioButtonGroup/RadioButtonGroup.stories.js

@@ -0,0 +1,40 @@
+import { withKnobs, text, select, boolean } from '@storybook/addon-knobs';
+import Component from './RadioButtonGroup.Story.svelte';
+
+export default { title: 'RadioButtonGroup', decorators: [withKnobs] };
+
+const values = {
+  standard: 'standard',
+  'default-selected': 'default-selected',
+  disabled: 'disabled'
+};
+
+const orientations = {
+  'Horizontal (horizontal)': 'horizontal',
+  'Vertical (vertical)': 'vertical'
+};
+
+const labelPositions = {
+  'Left (left)': 'left',
+  'Right (right)': 'right'
+};
+
+export const Default = () => ({
+  Component,
+  props: {
+    group: {
+      name: text('The form control name (name in <RadioButtonGroup>)', 'radio-button-group'),
+      valueSelected: select(
+        'Value of the selected button (valueSelected in <RadioButtonGroup>)',
+        values,
+        'default-selected'
+      ),
+      orientation: select('Radio button orientation (orientation)', orientations, 'horizontal'),
+      labelPosition: select('Label position (labelPosition)', labelPositions, 'right')
+    },
+    radio: {
+      disabled: boolean('Disabled (disabled in <RadioButton>)', false),
+      labelText: text('Label text (labelText in <RadioButton>)', 'Radio button label')
+    }
+  }
+});

src/components/RadioButtonGroup/RadioButtonGroup.svelte

@@ -0,0 +1,46 @@
+<script>
+  let className = undefined;
+  export { className as class };
+  export let orientation = 'horizontal';
+  export let labelPosition = 'right';
+  export let defaultSelected = undefined;
+  export let disabled = false;
+  export let style = undefined;
+
+  import { createEventDispatcher, setContext } from 'svelte';
+  import { writable } from 'svelte/store';
+  import { cx } from '../../lib';
+
+  const dispatch = createEventDispatcher();
+  const _class = cx(
+    '--radio-button-group',
+    orientation === 'vertical' && `--radio-button-group--${orientation}`,
+    labelPosition && `--radio-button-group--label-${labelPosition}`,
+    className
+  );
+
+  let selected = writable(defaultSelected);
+
+  setContext('RadioButtonGroup', {
+    selected,
+    add: ({ checked, value }) => {
+      if (checked) {
+        selected.set(value);
+      }
+    },
+    update: value => {
+      selected.set(value);
+    }
+  });
+
+  $: {
+    defaultSelected = $selected;
+    dispatch('change', $selected);
+  }
+</script>
+
+<div on:click on:mouseover on:mouseenter on:mouseleave class={cx('--form-item')} {style}>
+  <div class={_class} {disabled}>
+    <slot />
+  </div>
+</div>

src/components/RadioButtonGroup/index.js

@@ -0,0 +1,3 @@
+import RadioButtonGroup from './RadioButtonGroup.svelte';
+
+export default RadioButtonGroup;

src/components/Select/Select.Skeleton.svelte

@@ -0,0 +1,19 @@
+<script>
+  let className = undefined;
+  export { className as class };
+  export let hideLabel = false;
+  export let style = undefined;
+
+  import { cx } from '../../lib';
+
+  const _class = cx('--form-item', className);
+</script>
+
+<div on:click on:mouseover on:mouseenter on:mouseleave class={_class} {style}>
+  {#if !hideLabel}
+    <span class={cx('--label', '--skeleton')} />
+  {/if}
+  <div class={cx('--select', '--skeleton')}>
+    <div class={cx('--select-input')} />
+  </div>
+</div>

src/components/Select/Select.Story.svelte

@@ -0,0 +1,29 @@
+<script>
+  export let story = undefined;
+
+  import Layout from '../../internal/ui/Layout.svelte';
+  import Select from './Select.svelte';
+  import SelectItem from './SelectItem.svelte';
+  import SelectSkeleton from './Select.Skeleton.svelte';
+  import SelectItemGroup from './SelectItemGroup.svelte';
+</script>
+
+<Layout>
+  <div>
+    {#if story === 'skeleton'}
+      <SelectSkeleton {...$$props} />
+    {:else}
+      <Select {...$$props.select} id="select-1" defaultValue="placeholder-item">
+        <SelectItem value="placeholder-item" text="Choose an option" disabled hidden />
+        <SelectItemGroup {...$$props.group} label="Category 1">
+          <SelectItem value="option-1" text="Option 1" />
+          <SelectItem value="option-2" text="Option 2" />
+        </SelectItemGroup>
+        <SelectItemGroup {...$$props.group} label="Category 2">
+          <SelectItem value="option-3" text="Option 3" />
+          <SelectItem value="option-4" text="Option 4" />
+        </SelectItemGroup>
+      </Select>
+    {/if}
+  </div>
+</Layout>

src/components/Select/Select.stories.js

@@ -0,0 +1,36 @@
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import Component from './Select.Story.svelte';
+
+export default { title: 'Select', decorators: [withKnobs] };
+
+const labelPositions = {
+  'Left (left)': 'left',
+  'Right (right)': 'right'
+};
+
+export const Default = () => ({
+  Component,
+  props: {
+    select: {
+      light: boolean('Light variant (light in <Select>)', false),
+      inline: boolean('Put control in-line with label (inline in <Select>)', false),
+      disabled: boolean('Disabled (disabled in <Select>)', false),
+      hideLabel: boolean('No label (hideLabel in <Select>)', false),
+      invalid: boolean('Show form validation UI (invalid in <Select>)', false),
+      invalidText: text(
+        'Form validation UI content (invalidText in <Select>)',
+        'A valid value is required'
+      ),
+      labelText: text('Label text (helperText)', 'Select'),
+      helperText: text('Helper text (helperText)', 'Optional helper text.')
+    },
+    group: {
+      disabled: boolean('Disabled (disabled in <SelectItemGroup>)', false)
+    }
+  }
+});
+
+export const Skeleton = () => ({
+  Component,
+  props: { story: 'skeleton', hideLabel: boolean('No label (hideLabel in <Select>)', false) }
+});

src/components/Select/Select.svelte

@@ -0,0 +1,110 @@
+<script>
+  let className = undefined;
+  export { className as class };
+  export let id = Math.random();
+  export let inline = false;
+  export let labelText = '';
+  export let disabled = false;
+  export let defaultValue = undefined;
+  export let hideLabel = false;
+  export let invalid = false;
+  export let invalidText = '';
+  export let helperText = '';
+  export let light = false;
+  export let noLabel = false;
+  export let style = undefined;
+
+  import { createEventDispatcher, setContext } from 'svelte';
+  import { writable } from 'svelte/store';
+  import ChevronDown16 from 'carbon-icons-svelte/lib/ChevronDown16';
+  import WarningFilled16 from 'carbon-icons-svelte/lib/WarningFilled16';
+  import { cx } from '../../lib';
+
+  const dispatch = createEventDispatcher();
+  const errorId = `error-${id}`;
+  const _class = cx(
+    '--select',
+    inline && '--select--inline',
+    light && '--select--light',
+    invalid && '--select--invalid',
+    disabled && '--select--disabled',
+    className
+  );
+  const _labelClass = cx(
+    '--label',
+    hideLabel && '--visually-hidden',
+    disabled && '--label--disabled'
+  );
+  const _helperTextClass = cx('--form__helper-text', disabled && '--form__helper-text--disabled');
+
+  let selected = writable(defaultValue);
+
+  setContext('Select', { selected });
+
+  $: {
+    defaultValue = $selected;
+    dispatch('change', $selected);
+  }
+</script>
+
+<div class={cx('--form-item')} {style}>
+  <div class={_class}>
+    {#if !noLabel}
+      <label for={id} class={_labelClass}>{labelText}</label>
+    {/if}
+    {#if !inline && helperText}
+      <div class={_helperTextClass}>{helperText}</div>
+    {/if}
+    {#if inline}
+      <div class={cx('--select-input--inline__wrapper')}>
+        <div class={cx('--select-input__wrapper')} data-invalid={invalid || undefined}>
+          <select
+            class={cx('--select-input')}
+            aria-describedby={invalid ? errorId : undefined}
+            disabled={disabled || undefined}
+            aria-invalid={invalid || undefined}
+            on:change={event => {
+              selected.set(event.target.value);
+            }}
+            {id}>
+            <slot />
+          </select>
+          <ChevronDown16 class={cx('--select__arrow')} />
+          {#if invalid}
+            <WarningFilled16 class={cx('--select__invalid-icon')} />
+          {/if}
+        </div>
+        {#if invalid}
+          <div class={cx('--form-requirement')} id={errorId}>{invalidText}</div>
+        {/if}
+      </div>
+      {#if helperText}
+        <div class={_helperTextClass}>{helperText}</div>
+      {/if}
+    {/if}
+
+    {#if !inline}
+      <div class={cx('--select-input__wrapper')} data-invalid={invalid || undefined}>
+        <select
+          class={cx('--select-input')}
+          aria-describedby={invalid ? errorId : undefined}
+          disabled={disabled || undefined}
+          aria-invalid={invalid || undefined}
+          on:change
+          on:change={event => {
+            selected.set(event.target.value);
+          }}
+          {id}>
+          <slot />
+        </select>
+        <ChevronDown16 class={cx('--select__arrow')} />
+        {#if invalid}
+          <WarningFilled16 class={cx('--select__invalid-icon')} />
+        {/if}
+      </div>
+      {#if invalid}
+        <div class={cx('--form-requirement')} id={errorId}>{invalidText}</div>
+      {/if}
+    {/if}
+  </div>
+</div>

src/components/Select/SelectItem.svelte

@@ -0,0 +1,19 @@
+<script>
+  let className = undefined;
+  export { className as class };
+  export let value = '';
+  export let text = '';
+  export let disabled = false;
+  export let hidden = false;
+  export let style = undefined;
+
+  import { getContext } from 'svelte';
+  import { cx } from '../../lib';
+
+  const { selected } = getContext('Select');
+  const _class = cx('--select-option', className);
+</script>
+
+<option class={_class} {value} {disabled} {hidden} {style} selected={$selected === value}>
+  {text}
+</option>

src/components/Select/SelectItemGroup.svelte

@@ -0,0 +1,15 @@
+<script>
+  let className = undefined;
+  export { className as class };
+  export let disabled = false;
+  export let label = 'Provide label';
+  export let style = undefined;
+
+  import { cx } from '../../lib';
+
+  const _class = cx('--select-optgroup', className);
+</script>
+
+<optgroup class={_class} {label} {disabled} {style}>
+  <slot />
+</optgroup>

src/components/Select/index.js

@@ -0,0 +1,6 @@
+import Select from './Select.svelte';
+
+export default Select;
+export { default as SelectSkeleton } from './Select.Skeleton.svelte';
+export { default as SelectItem } from './SelectItem.svelte';
+export { default as SelectItemGroup } from './SelectItemGroup.svelte';

src/components/TooltipDefinition/TooltipDefinition.Story.svelte

@@ -4,7 +4,5 @@
 </script>
 
 <Layout>
-  <div>
-    <TooltipDefinition {...$$props}>Defintion Tooltip</TooltipDefinition>
-  </div>
+  <TooltipDefinition {...$$props}>Defintion Tooltip</TooltipDefinition>
 </Layout>

src/components/TooltipDefinition/TooltipDefinition.svelte

@@ -7,7 +7,7 @@
   export let triggerClassName = undefined;
   export { triggerClassName as triggerClass };
   export let tooltipText = '';
-  export let props = {};
+  export let style = undefined;
 
   import { cx } from '../../lib';
 
@@ -22,7 +22,7 @@
   );
 </script>
 
-<div {...props} class={_class}>
+<div class={_class} {style}>
   <button
     on:click
     on:mouseover

src/components/TooltipIcon/TooltipIcon.svelte

@@ -5,7 +5,7 @@
   export let align = 'center';
   export let id = Math.random();
   export let tooltipText = '';
-  export let props = {};
+  export let style = undefined;
 
   import { cx } from '../../lib';
 
@@ -19,13 +19,13 @@
 </script>
 
 <button
-  {...props}
   on:click
   on:mouseover
   on:mouseenter
   on:mouseleave
+  aria-describedby={id}
   class={_class}
-  aria-describedby={id}>
+  {style}>
   <span class={cx('--assistive-text')} {id}>{tooltipText}</span>
   <slot />
 </button>

src/index.js

@@ -25,7 +25,9 @@ import ProgressIndicator, {
   ProgressStep
 } from './components/ProgressIndicator';
 import RadioButton, { RadioButtonSkeleton } from './components/RadioButton';
+import RadioButtonGroup from './components/RadioButtonGroup';
 import Search, { SearchSkeleton } from './components/Search';
+import Select, { SelectSkeleton, SelectItem, SelectItemGroup } from './components/Select';
 import SkeletonPlaceholder from './components/SkeletonPlaceholder';
 import SkeletonText from './components/SkeletonText';
 import Tag, { TagSkeleton } from './components/Tag';
@@ -80,9 +82,14 @@ export {
   ProgressStep,
   RadioButton,
   RadioButtonSkeleton,
+  RadioButtonGroup,
   Search,
   SearchSkeleton,
   SelectableTile,
+  Select,
+  SelectSkeleton,
+  SelectItem,
+  SelectItemGroup,
   SkeletonPlaceholder,
   SkeletonText,
   Switch,