@onereach/ui-components 4.2.0-beta.2548.0 → 4.2.0

package/src/components/or-checkbox-tree-v3/OrCheckboxTree.vue

@@ -0,0 +1,192 @@
+<template>
+  <div
+    ref="root"
+    :class="rootStyles"
+  >
+    <template v-if="hasChildren">
+      <div :class="parentStyles">
+        <template
+          v-if="collapsible"
+        >
+          <OrButton
+            variant="link"
+            :disabled="disabled"
+            @click="() => setIsOpen(!isOpen)"
+          >
+            <OrIcon
+              :class="[isOpen ? 'rotate-[180deg]': 'rotate-0']"
+              icon="arrow_drop_down"
+              size="l"
+            />
+          </OrButton>
+        </template>
+        <OrCheckbox
+          value="true"
+          :model-value="isAllChildrenSelected"
+          :indeterminate="isIntermediate"
+          :label="item.label"
+          :disabled="disabled"
+          @click="handleParentClick"
+        />
+      </div>
+      <div
+        v-if="hasChildren && isOpen"
+        :class="{
+          'ml-2xl': collapsible,
+          'ml-lg': !collapsible
+        }"
+      >
+        <OrCheckboxTree
+          v-for="child in item.children"
+          :key="child.value || child.label"
+          v-model="proxyModelValue"
+          class="mt-xs"
+          :item="child"
+          :collapsible="child.collapsible"
+          :expanded="child.expanded"
+          :disabled="disabled || child.disabled"
+        />
+      </div>
+    </template>
+    <template v-else>
+      <OrCheckbox
+        v-model="proxyModelValue"
+        :disabled="disabled || item.disabled"
+        :label="item.label"
+        :value="item.value"
+      />
+    </template>
+  </div>
+</template>
+
+<script lang="ts">
+import { computed, defineComponent, PropType, watch } from 'vue-demi';
+import { useVModel, useToggle } from '@vueuse/core';
+import { OrCheckboxV3 as OrCheckbox } from '../or-checkbox-v3';
+import { OrIconV3 as OrIcon } from '../or-icon-v3';
+import { OrButtonV3 as OrButton } from '../or-button-v3';
+import { CheckboxTreeRoot, CheckboxTreeRootParent } from './styles';
+import { CheckboxTreeNode } from './types';
+import flattenDeep from '../../utils/functions/flattenDeep';
+
+export default defineComponent({
+  name: 'OrCheckboxTree',
+  components: {
+    OrIcon,
+    OrCheckbox,
+    OrButton,
+  },
+
+  model: {
+    prop: 'modelValue',
+    event: 'update:modelValue',
+  },
+
+  props: {
+    modelValue: {
+      type: Array as PropType<string[]>,
+      default: () => [],
+    },
+    item: {
+      type: Object as PropType<CheckboxTreeNode>,
+      required: true,
+    },
+    collapsible: {
+      type: Boolean,
+      default: false,
+    },
+    disabled: {
+      type: Boolean,
+      default: false,
+    },
+    expanded: {
+      type: Boolean,
+      default: true,
+    },
+  },
+
+  emits: [
+    'update:modelValue',
+  ],
+
+  setup(props, { emit }) {
+
+    // State
+    const hasChildren = computed(() => props.item.children && props.item.children.length > 0);
+    const childrenValues = computed(() => {
+      const getChildValues = (children?: CheckboxTreeNode[]): any[] | undefined => {
+        return children?.map((child) => {
+          if (child.children) {
+            return getChildValues(child.children);
+          } else {
+            return child.value;
+          }
+        });
+      };
+
+      return flattenDeep(getChildValues(props.item.children));
+    });
+
+    const proxyModelValue = useVModel(props, 'modelValue', emit);
+
+    const isAnyChildrenSelected = computed(() => {
+      return proxyModelValue.value?.some((value) => childrenValues.value?.includes(value));
+    });
+
+    const isAllChildrenSelected = computed(() => {
+      return childrenValues.value?.every((value) => proxyModelValue.value?.includes(value));
+    });
+
+    const isIntermediate = computed(() => {
+      return isAnyChildrenSelected.value && !isAllChildrenSelected.value;
+    });
+
+    const [isOpen, setIsOpen] = useToggle(props.expanded);
+
+    watch(() => props.expanded, (value) => {
+      if (value !== undefined) {
+        setIsOpen(value);
+      }
+    });
+
+    // Styles
+    const rootStyles = computed(() => [
+      'or-checkbox-tree-v3',
+      ...CheckboxTreeRoot,
+    ]);
+
+    // Styles
+    const parentStyles = computed(() => [
+      ...CheckboxTreeRootParent,
+    ]);
+
+    // Methods
+    const handleParentClick = () => {
+      if (isAllChildrenSelected.value) {
+        proxyModelValue.value = proxyModelValue.value.filter((value) => !childrenValues.value.includes(value));
+      } else {
+        proxyModelValue.value = [
+          ...new Set([
+            ...proxyModelValue.value,
+            ...childrenValues.value,
+          ]),
+        ];
+      }
+    };
+
+    return {
+      rootStyles,
+      parentStyles,
+      hasChildren,
+      proxyModelValue,
+      isOpen,
+      setIsOpen,
+      isIntermediate,
+      isAllChildrenSelected,
+      isAnyChildrenSelected,
+      childrenValues,
+      handleParentClick,
+    };
+  },
+});
+</script>

package/src/components/or-checkbox-tree-v3/index.ts

@@ -0,0 +1,2 @@
+export { default as OrCheckboxTreeV3 } from './OrCheckboxTree.vue';
+export * from './types';

package/src/components/or-checkbox-tree-v3/styles.ts

@@ -0,0 +1,15 @@
+export const CheckboxTreeRoot: string[] = [
+  // Layout
+  'flex',
+  'flex-col',
+
+  // Spacing
+  'gap-sm+ md:gap-sm',
+];
+
+export const CheckboxTreeRootParent: string[] = [
+  // Layout
+  'flex',
+  'flex-row',
+  'gap-xs',
+];

package/src/components/or-checkbox-tree-v3/types.ts

@@ -0,0 +1,8 @@
+export type CheckboxTreeNode = {
+  label: string;
+  value: string;
+  children?: CheckboxTreeNode[];
+  collapsible?: boolean;
+  disabled?: boolean;
+  expanded?: boolean;
+};

package/src/components/or-checkbox-v3/OrCheckbox.vue

@@ -5,16 +5,18 @@
   >
     <input
       ref="control"
-      v-model="proxyModelValue"
+      :checked="isChecked"
       v-bind="controlAttributes"
       :class="controlStyles"
       :type="'checkbox'"
       :value="value"
-      :indeterminate="indeterminate"
+      :indeterminate.prop="indeterminate"
       :required="required"
       :disabled="disabled"
+      @change="handleChange"
       @focus="$emit('focus', $event)"
       @blur="$emit('blur', $event)"
+      @click="$emit('click', $event)"
     >
 
     <template v-if="$slots.default || label">
@@ -36,6 +38,7 @@
 
 <script lang="ts">
 import { computed, defineComponent, PropType, reactive, ref } from 'vue-demi';
+import { useVModel } from '@vueuse/core';
 import { useControlAttributes, useIdAttribute } from '../../hooks';
 import { LabelVariant, OrLabelV3 as OrLabel } from '../or-label-v3';
 import { CheckboxControl, CheckboxControlHandle, CheckboxRoot } from './styles';
@@ -54,13 +57,13 @@ export default defineComponent({
 
   props: {
     modelValue: {
-      type: [Boolean, Array] as PropType<boolean | string[]>,
-      default: undefined,
+      type: null as any,
+      default: null,
     },
 
     value: {
-      type: String,
-      default: undefined,
+      type: [String, Boolean, Number] as PropType<string | boolean | number>,
+      default: null,
     },
 
     label: {
@@ -92,6 +95,7 @@ export default defineComponent({
   emits: [
     'update:modelValue',
 
+    'click',
     'focus',
     'blur',
   ],
@@ -103,7 +107,7 @@ export default defineComponent({
     'blur',
   ],
 
-  setup(props, context) {
+  setup(props, { emit }) {
     // Refs
     const root = ref<HTMLElement>();
     const control = ref<HTMLInputElement>();
@@ -125,15 +129,30 @@ export default defineComponent({
       ...useControlAttributes(),
     });
 
-    const proxyModelValue = computed({
-      get: () => props.modelValue,
+    const proxyModelValue = useVModel(props, 'modelValue', emit);
+
+    const isChecked = computed(() => {
+      if (Array.isArray(proxyModelValue.value)) {
+        return props.value && proxyModelValue.value.includes(props.value);
+      }
 
-      set: (value) => {
-        context.emit('update:modelValue', value);
-      },
+      return !!proxyModelValue.value;
     });
 
     // Methods
+
+    function handleChange(): void {
+      if (Array.isArray(proxyModelValue.value)) {
+        if (isChecked.value) {
+          proxyModelValue.value = proxyModelValue.value.filter((v) => v !== props.value);
+        } else {
+          proxyModelValue.value = [...proxyModelValue.value, props.value];
+        }
+      } else {
+        proxyModelValue.value = !proxyModelValue.value;
+      }
+    }
+
     function focus(): void {
       control.value?.focus();
     }
@@ -148,7 +167,8 @@ export default defineComponent({
       rootStyles,
       controlStyles,
       controlAttributes,
-      proxyModelValue,
+      isChecked,
+      handleChange,
       focus,
       blur,
     };

package/src/components/or-form-group-v3/OrFormGroup.stories3.ts

@@ -0,0 +1,114 @@
+import OrFormGroup from './OrFormGroup.vue';
+import { ref } from 'vue-demi';
+import { Meta, StoryFn } from '@storybook/vue3';
+import { OrRadioV3 as OrRadio } from '../or-radio-v3';
+import { OrCheckboxV3 as OrCheckbox } from '../or-checkbox-v3';
+import { OrSwitchV3 as OrSwitch } from '../or-switch-v3';
+import { FormGroupDirection } from './props';
+export default {
+  title: 'Components/Forms/Group',
+  component: OrFormGroup,
+  argTypes: {
+    // Props
+    label: {
+      control: { type: 'text' },
+    },
+    error: {
+      control: { type: 'text' },
+    },
+    hint: {
+      control: { type: 'text' },
+    },
+    direction: {
+      control: { type: 'select' },
+      options: Object.values(FormGroupDirection),
+    },
+  },
+} as Meta<typeof OrFormGroup>;
+
+const RadioTemplate: StoryFn<typeof OrFormGroup> = (args) => ({
+  components: {
+    OrFormGroup,
+    OrRadio,
+  },
+  setup() {
+    const modelValue = ref('');
+    return {
+      args,
+      modelValue,
+    };
+  },
+  template: `
+    <OrFormGroup
+      v-bind="args"
+    >
+      <OrRadio :label="'Option 1'" value="1" v-model="modelValue"/>
+      <OrRadio :label="'Option 2'" value="3" v-model="modelValue"/>
+      <OrRadio :label="'Option 3'" value="4" v-model="modelValue"/>
+    </OrFormGroup>
+    `,
+});
+
+export const RadioGroup = RadioTemplate.bind({});
+RadioGroup.args = {
+  label: 'Radio Group',
+  hint: 'This is a hint',
+};
+
+const CheckboxTemplate: StoryFn<typeof OrFormGroup> = (args) => ({
+  components: {
+    OrFormGroup,
+    OrCheckbox,
+  },
+  setup() {
+    const modelValue = ref([]);
+    return {
+      args,
+      modelValue,
+    };
+  },
+  template: `
+    <OrFormGroup
+      v-bind="args"
+    >
+      <OrCheckbox :label="'Option 1'" value="1" v-model="modelValue"/>
+      <OrCheckbox :label="'Option 2'" value="3" v-model="modelValue"/>
+      <OrCheckbox :label="'Option 3'" value="4" v-model="modelValue"/>
+    </OrFormGroup>
+  `,
+});
+
+export const CheckboxGroup = CheckboxTemplate.bind({});
+CheckboxGroup.args = {
+  label: 'Checkbox Group',
+  hint: 'This is a hint',
+};
+
+const SwitchTemplate: StoryFn<typeof OrFormGroup> = (args) => ({
+  components: {
+    OrFormGroup,
+    OrSwitch,
+  },
+  setup() {
+    const modelValue = ref([]);
+    return {
+      args,
+      modelValue,
+    };
+  },
+  template: `
+    <OrFormGroup
+      v-bind="args"
+    >
+      <OrSwitch :label="'Option 1'" value="1" v-model="modelValue"/>
+      <OrSwitch :label="'Option 2'" value="3" v-model="modelValue"/>
+      <OrSwitch :label="'Option 3'" value="4" v-model="modelValue"/>
+    </OrFormGroup>
+    `,
+});
+
+export const SwitchGroup = SwitchTemplate.bind({});
+SwitchGroup.args = {
+  label: 'Switch Group',
+  hint: 'This is a hint',
+};

package/src/components/or-form-group-v3/OrFormGroup.vue

@@ -0,0 +1,116 @@
+<template>
+  <div
+    ref="root"
+    :class="rootStyles"
+  >
+    <div class="layout-row">
+      <slot name="label">
+        <OrLabel
+          v-if="label"
+          :required="required"
+          :disabled="disabled"
+          :invalid="invalid ? '' : null"
+          :class="labelStyles"
+        >
+          {{ label }}
+
+          <template v-slot:addon>
+            <slot name="addon" />
+          </template>
+        </OrLabel>
+      </slot>
+    </div>
+    <div :class="contentStyles">
+      <slot />
+    </div>
+
+    <template v-if="hint && !error">
+      <OrHint :disabled="disabled">
+        {{ hint }}
+      </OrHint>
+    </template>
+
+    <template
+      v-if="typeof error === 'string'"
+    >
+      <OrError :disabled="disabled">
+        {{ error }}
+      </OrError>
+    </template>
+  </div>
+</template>
+
+<script lang="ts">
+import { defineComponent, ref, PropType, computed } from 'vue-demi';
+import { OrLabelV3 as OrLabel } from '../or-label-v3';
+import { OrErrorV3 as OrError } from '../or-error-v3';
+import { OrHintV3 as OrHint } from '../or-hint-v3';
+import { FormGroupDirection } from './props';
+import { FormGroupContent, FormGroupContentDirections, FormGroupRoot, FormGroupLabel } from './styles';
+
+export default defineComponent({
+  name: 'OrFormGroupV3',
+  components: {
+    OrLabel,
+    OrError,
+    OrHint,
+  },
+  props: {
+    label: {
+      type: String,
+      default: undefined,
+    },
+    required: {
+      type: Boolean,
+      default: false,
+    },
+    disabled: {
+      type: Boolean,
+      default: false,
+    },
+    direction: {
+      type: String as PropType<FormGroupDirection>,
+      default: FormGroupDirection.Vertical,
+    },
+    error: {
+      type: [String, Boolean],
+      default: undefined,
+    },
+    hint: {
+      type: String,
+      default: undefined,
+    },
+  },
+  setup(props) {
+    // Refs
+    const root = ref<HTMLElement>();
+
+    // State
+    const invalid = computed(() => !!props.error);
+
+    // Styles
+    const rootStyles = computed(() => [
+      'or-form-group-v3',
+      ...FormGroupRoot,
+    ]);
+
+    const labelStyles = computed(() => [
+      ...FormGroupLabel,
+    ]);
+
+    const contentStyles = computed(() => [
+      ...FormGroupContent,
+      ...FormGroupContentDirections[props.direction],
+    ]);
+
+    return {
+      root,
+      rootStyles,
+      labelStyles,
+      contentStyles,
+      invalid,
+    };
+  },
+});
+
+</script>

package/src/components/or-form-group-v3/index.ts

@@ -0,0 +1,2 @@
+export { default as OrFormGroupV3 } from './OrFormGroup.vue';
+export * from './props';

package/src/components/or-form-group-v3/props.ts

@@ -0,0 +1,4 @@
+export enum FormGroupDirection {
+  Vertical = 'vertical',
+  Horizontal = 'horizontal',
+}

package/src/components/or-form-group-v3/styles.ts

@@ -0,0 +1,33 @@
+import { FormGroupDirection } from './props';
+
+export const FormGroupRoot: string[] = [
+  // Layout
+  'layout-column',
+  'gap-md md:gap-sm',
+];
+export const FormGroupContent: string[] = [
+  // Layout
+  'pl-[10px] md:pl-[0]',
+  'gap-md md:gap-sm',
+];
+
+export const FormGroupLabel: string[] = [
+  // Typography
+  '!typography-body-2-regular',
+  '!theme-foreground',
+  'dark:!theme-foreground-dark',
+
+  'invalid:!theme-foreground-error',
+  'dark:invalid:!theme-foreground-error-dark',
+];
+
+export const FormGroupContentDirections: Record<FormGroupDirection, string[]> = {
+  [FormGroupDirection.Vertical]: [
+    'layout-column',
+    'gap-sm',
+  ],
+  [FormGroupDirection.Horizontal]: [
+    'layout-row',
+    'gap-[18px] md:gap-md',
+  ],
+};

package/src/components/or-radio-group-v3/OrRadioGroup.stories3.ts

@@ -0,0 +1,81 @@
+import { action } from '@storybook/addon-actions';
+import { Meta, StoryFn } from '@storybook/vue3';
+import { ref, watch } from 'vue-demi';
+import OrRadioGroup from './OrRadioGroup.vue';
+import { FormGroupDirection } from '../or-form-group-v3';
+
+export default {
+  title: 'Components/Forms/Radio/Group',
+  component: OrRadioGroup,
+
+  argTypes: {
+    options: {
+      control: { type: 'object' },
+    },
+    direction: {
+      control: { type: 'select' },
+      options: Object.values(FormGroupDirection),
+    },
+  },
+
+  parameters: {
+    layout: 'centered',
+  },
+} as Meta<typeof OrRadioGroup>;
+
+const Template: StoryFn<typeof OrRadioGroup> = (args) => ({
+  components: {
+    OrRadioGroup,
+  },
+
+  setup() {
+    // State
+    const model = ref<string>();
+
+    // Effects
+    watch(model, (value) => {
+      console.debug(value);
+    });
+
+    return {
+      args,
+      model,
+      onUpdateModelValue: action('update:modelValue'),
+    };
+  },
+
+  template: `
+    <div class="contents">
+      <OrRadioGroup
+        v-model="model"
+        v-bind="args"
+        @update:modelValue="onUpdateModelValue"
+      />
+    </div>
+  `,
+});
+
+export const Group = Template.bind({});
+
+Group.args = {
+  label: 'Radio Group',
+  options: [
+    {
+      label: 'Radio 1',
+      value: 'radio-1',
+    },
+    {
+      label: 'Radio 2',
+      value: 'radio-2',
+    },
+    {
+      label: 'Radio 3',
+      value: 'radio-3',
+      disabled: true,
+    },
+    {
+      label: 'Radio 4',
+      value: 'radio-4',
+    },
+  ],
+};