@onereach/ui-components 4.2.5 → 4.2.6-beta.2604.0

package/src/components/or-date-picker-v3/OrDatePicker.stories3.ts

@@ -0,0 +1,174 @@
+import { action } from '@storybook/addon-actions';
+import { Meta, StoryFn } from '@storybook/vue3';
+import * as Faker from 'faker';
+import { ref, watch } from 'vue-demi';
+import { OrIconV3 as OrIcon } from '../or-icon-v3';
+import OrDatePickerDocs from './OrDatePicker.docs.mdx';
+import OrDatePicker from './OrDatePicker.vue';
+import { DatePickerSize } from './props';
+
+export default {
+  title: 'Components/Date Picker',
+  component: OrDatePicker,
+
+  argTypes: {
+    // Slots
+    addon: {
+      type: {
+        name: 'string',
+        required: false,
+      },
+
+      control: { type: 'text' },
+    },
+
+    // Props
+    modelValue: {
+      control: { type: 'text' },
+    },
+
+    yearFilter: {
+      table: { disable: true },
+    },
+
+    monthFilter: {
+      table: { disable: true },
+    },
+
+    dateFilter: {
+      table: { disable: true },
+    },
+
+    size: {
+      control: { type: 'select' },
+      options: Object.values(DatePickerSize),
+    },
+
+    label: {
+      control: { type: 'text' },
+    },
+
+    hint: {
+      control: { type: 'text' },
+    },
+
+    error: {
+      control: { type: 'text' },
+    },
+
+    required: {
+      control: { type: 'boolean' },
+    },
+
+    readonly: {
+      control: { type: 'boolean' },
+    },
+
+    disabled: {
+      control: { type: 'boolean' },
+    },
+
+    disableDefaultStyles: {
+      control: { type: 'boolean' },
+    },
+
+    // Events
+    'update:modelValue': {
+      table: { disable: true },
+    },
+
+    input: {
+      table: { disable: true },
+    },
+
+    keydown: {
+      table: { disable: true },
+    },
+
+    keyup: {
+      table: { disable: true },
+    },
+
+    focus: {
+      table: { disable: true },
+    },
+
+    blur: {
+      table: { disable: true },
+    },
+  },
+
+  parameters: {
+    docs: {
+      page: OrDatePickerDocs,
+    },
+
+    design: {
+      type: 'figma',
+      url: 'https://www.figma.com/file/o7DdkaznUW2PtX4wiSuhhQ/Core?node-id=3175-41854&t=fEpVdGUcSv9iaRfM-0',
+    },
+  },
+} as Meta<typeof OrDatePicker>;
+
+const Template: StoryFn<typeof OrDatePicker> = (args) => ({
+  components: {
+    OrIcon,
+    OrDatePicker,
+  },
+
+  setup() {
+    // State
+    const model = ref<Date>();
+
+    // Effects
+    watch(model, (value) => {
+      console.debug(value);
+    });
+
+    return {
+      args,
+      model,
+      onUpdateModelValue: action('update:modelValue'),
+      onKeydown: action('keydown'),
+      onKeyup: action('keyup'),
+      onFocus: action('focus'),
+      onBlur: action('blur'),
+    };
+  },
+
+  template: `
+    <OrDatePicker
+      v-model="model"
+      v-bind="args"
+      @update:modelValue="onUpdateModelValue"
+      @keydown="onKeydown"
+      @keyup="onKeyup"
+      @focus="onFocus"
+      @blur="onBlur"
+    >
+      <template #addon>
+        ${args.addon}
+      </template>
+    </OrDatePicker>
+  `,
+});
+
+export const Default = Template.bind({});
+
+Default.args = {
+  // Slots
+  addon: '<OrIcon icon="info" />',
+
+  // Props
+  label: 'Label',
+  hint: Faker.lorem.sentence(20),
+};
+
+export const WithFilter = Template.bind({});
+
+WithFilter.args = {
+  ...Default.args,
+
+  // Props
+  dateFilter: (value: Date) => ![0, 6].includes(value.getUTCDay()),
+};

package/src/components/or-date-picker-v3/OrDatePicker.vue

@@ -0,0 +1,329 @@
+<template>
+  <div
+    ref="root"
+    :class="rootStyles"
+  >
+    <template v-if="label">
+      <OrLabel
+        :variant="'input'"
+        :required="required"
+        :disabled="disabled"
+      >
+        {{ label }}
+
+        <template v-slot:addon>
+          <slot name="addon" />
+        </template>
+      </OrLabel>
+    </template>
+
+    <OrInputBox
+      ref="inputBox"
+      :variant="disableDefaultStyles ? 'unstyled' : 'styled'"
+      :size="size"
+      :invalid="!!error"
+      :readonly="readonly"
+      :disabled="disabled"
+    >
+      <OrDateTimePickerDateControl
+        v-model="draftModelValue"
+        v-dropdown-open="togglePopover"
+        v-dropdown-close="closePopover"
+        :required="required"
+        :readonly="readonly"
+        :disabled="disabled"
+      />
+
+      <OrPopover
+        ref="popover"
+        :class="popoverStyles"
+        :variant="'auto'"
+        :trigger="inputBoxRoot"
+        :placement="'bottom-start'"
+        @update:state:closed-automatically="reset()"
+      >
+        <OrDateTimePickerPopoverHeader>
+          <OrDateTimePickerMobileControl label="Date">
+            {{ formatDateAlt(draftModelValue) }}
+          </OrDateTimePickerMobileControl>
+        </OrDateTimePickerPopoverHeader>
+
+        <OrDateTimePickerMonthSelect
+          v-model="draftModelValue"
+          :initial-value="initialModelValue"
+          :year-filter="yearFilter"
+          :month-filter="monthFilter"
+        />
+
+        <OrDateTimePickerDateSelect
+          v-model="draftModelValue"
+          :initial-value="initialModelValue"
+          :date-filter="dateFilter"
+        />
+
+        <OrDateTimePickerPopoverFooter
+          @apply="apply(); popover.close()"
+          @reset="reset(); popover.close()"
+        />
+      </OrPopover>
+
+      <div :class="['grow']" />
+
+      <div :class="['layout-inline-row']">
+        <template v-if="modelValue">
+          <OrIconButton
+            :icon="'close'"
+            :color="'inherit'"
+            :disabled="readonly || disabled"
+            @click.stop="$emit('update:modelValue', undefined)"
+          />
+        </template>
+
+        <template v-else>
+          <OrIcon
+            :icon="'calendar_month'"
+            :variant="'outlined'"
+          />
+        </template>
+      </div>
+    </OrInputBox>
+
+    <template v-if="!error">
+      <template v-if="hint">
+        <OrHint :disabled="disabled">
+          {{ hint }}
+        </OrHint>
+      </template>
+    </template>
+
+    <template v-if="typeof error === 'string'">
+      <OrError :disabled="disabled">
+        {{ error }}
+      </OrError>
+    </template>
+  </div>
+</template>
+
+<script lang="ts">
+import { computed, defineComponent, PropType, ref, watch } from 'vue-demi';
+import { DropdownClose, DropdownOpen } from '../../directives';
+import { FilterFunction } from '../or-date-time-picker-v3';
+import { useCurrentDate } from '../or-date-time-picker-v3/hooks/useCurrentDate';
+import OrDateTimePickerDateControl from '../or-date-time-picker-v3/partials/or-date-time-picker-date-control/OrDateTimePickerDateControl.vue';
+import OrDateTimePickerDateSelect from '../or-date-time-picker-v3/partials/or-date-time-picker-date-select/OrDateTimePickerDateSelect.vue';
+import OrDateTimePickerMobileControl from '../or-date-time-picker-v3/partials/or-date-time-picker-mobile-control/OrDateTimePickerMobileControl.vue';
+import OrDateTimePickerMonthSelect from '../or-date-time-picker-v3/partials/or-date-time-picker-month-select/OrDateTimePickerMonthSelect.vue';
+import OrDateTimePickerPopoverFooter from '../or-date-time-picker-v3/partials/or-date-time-picker-popover-footer/OrDateTimePickerPopoverFooter.vue';
+import OrDateTimePickerPopoverHeader from '../or-date-time-picker-v3/partials/or-date-time-picker-popover-header/OrDateTimePickerPopoverHeader.vue';
+import { OrErrorV3 as OrError } from '../or-error-v3';
+import { OrHintV3 as OrHint } from '../or-hint-v3';
+import { OrIconButtonV3 as OrIconButton } from '../or-icon-button-v3';
+import { OrIconV3 as OrIcon } from '../or-icon-v3';
+import { OrInputBoxV3 as OrInputBox } from '../or-input-box-v3';
+import { OrLabelV3 as OrLabel } from '../or-label-v3';
+import { OrPopoverV3 as OrPopover } from '../or-popover-v3';
+import { DatePickerSize } from './props';
+import { DatePicker, DatePickerPopover } from './styles';
+
+export default defineComponent({
+  name: 'OrDatePicker',
+
+  components: {
+    OrDateTimePickerDateControl,
+    OrDateTimePickerDateSelect,
+    OrDateTimePickerMobileControl,
+    OrDateTimePickerMonthSelect,
+    OrDateTimePickerPopoverFooter,
+    OrDateTimePickerPopoverHeader,
+    OrError,
+    OrHint,
+    OrIcon,
+    OrIconButton,
+    OrInputBox,
+    OrLabel,
+    OrPopover,
+  },
+
+  directives: {
+    DropdownClose,
+    DropdownOpen,
+  },
+
+  model: {
+    prop: 'modelValue',
+    event: 'update:modelValue',
+  },
+
+  props: {
+    modelValue: {
+      type: Date,
+      default: undefined,
+    },
+
+    yearFilter: {
+      type: Function as PropType<FilterFunction>,
+      default: undefined,
+    },
+
+    monthFilter: {
+      type: Function as PropType<FilterFunction>,
+      default: undefined,
+    },
+
+    dateFilter: {
+      type: Function as PropType<FilterFunction>,
+      default: undefined,
+    },
+
+    size: {
+      type: String as PropType<DatePickerSize>,
+      default: DatePickerSize.M,
+    },
+
+    label: {
+      type: String,
+      default: undefined,
+    },
+
+    hint: {
+      type: String,
+      default: undefined,
+    },
+
+    error: {
+      type: [String, Boolean],
+      default: undefined,
+    },
+
+    required: {
+      type: Boolean,
+      default: false,
+    },
+
+    readonly: {
+      type: Boolean,
+      default: false,
+    },
+
+    disabled: {
+      type: Boolean,
+      default: false,
+    },
+
+    disableDefaultStyles: {
+      type: Boolean,
+      default: false,
+    },
+  },
+
+  emits: [
+    'update:modelValue',
+
+    'keydown',
+    'keyup',
+    'focus',
+    'blur',
+  ],
+
+  expose: [
+    'root',
+
+    'focus',
+    'blur',
+  ],
+
+  setup(props, context) {
+    // Refs
+    const root = ref<HTMLElement>();
+
+    const inputBox = ref<InstanceType<typeof OrInputBox>>();
+    const inputBoxRoot = computed(() => inputBox.value?.root);
+
+    const popover = ref<InstanceType<typeof OrPopover>>();
+    const popoverState = computed(() => popover.value?.state);
+
+    // Styles
+    const rootStyles = computed(() => [
+      'or-date-picker',
+      ...DatePicker,
+    ]);
+
+    const popoverStyles = computed(() => [
+      ...DatePickerPopover,
+    ]);
+
+    // State
+    const initialModelValue = useCurrentDate();
+
+    const proxyModelValue = computed({
+      get: () => props.modelValue,
+
+      set: (value) => {
+        context.emit('update:modelValue', value);
+      },
+    });
+
+    const draftModelValue = ref<Date>();
+
+    watch(proxyModelValue, (value) => {
+      draftModelValue.value = value;
+    }, { immediate: true });
+
+    // Methods
+    function apply(): void {
+      proxyModelValue.value = draftModelValue.value ?? initialModelValue;
+    }
+
+    function reset(): void {
+      draftModelValue.value = proxyModelValue.value;
+    }
+
+    function togglePopover(): void {
+      if (!props.readonly && !props.disabled) {
+        const popoverInstance = popover.value;
+
+        if (popoverInstance) {
+          if (popoverState.value === 'open') {
+            (popoverInstance.close as () => void)();
+          } else {
+            (popoverInstance.open as () => void)();
+          }
+        }
+      }
+    }
+
+    function closePopover(): void {
+      const popoverInstance = popover.value;
+
+      if (popoverInstance) {
+        (popoverInstance.close as () => void)();
+      }
+    }
+
+    function formatDateAlt(value?: Date): string {
+      return value?.toLocaleString(navigator.language, {
+        dateStyle: 'medium',
+        timeZone: 'UTC',
+      }) ?? '--';
+    }
+
+    return {
+      root,
+      inputBox,
+      inputBoxRoot,
+      popover,
+      popoverState,
+      rootStyles,
+      popoverStyles,
+      initialModelValue,
+      proxyModelValue,
+      draftModelValue,
+      apply,
+      reset,
+      togglePopover,
+      closePopover,
+      formatDateAlt,
+    };
+  },
+});
+</script>

package/src/components/or-date-picker-v3/index.ts

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

package/src/components/or-date-picker-v3/props.ts

@@ -0,0 +1 @@
+export { InputBoxSize as DatePickerSize } from '../or-input-box-v3';

package/src/components/or-date-picker-v3/styles.ts

@@ -0,0 +1,12 @@
+export const DatePicker: string[] = [
+  // Layout
+  'layout-column',
+
+  // Spacing
+  'gap-xs',
+];
+
+export const DatePickerPopover: string[] = [
+  // Box
+  'w-[298px]',
+];

package/src/components/or-date-time-picker-v3/OrDateTimePicker.docs.mdx

@@ -0,0 +1,7 @@
+import { DocsPage } from '@storybook/addon-docs';
+
+```ts
+import { OrDateTimePickerV3 as OrDateTimePicker } from '@onereach/ui-components';
+```
+
+<DocsPage />

package/src/components/or-date-time-picker-v3/OrDateTimePicker.stories3.ts

@@ -0,0 +1,183 @@
+import { action } from '@storybook/addon-actions';
+import { Meta, StoryFn } from '@storybook/vue3';
+import * as Faker from 'faker';
+import { ref, watch } from 'vue-demi';
+import { OrIconV3 as OrIcon } from '../or-icon-v3';
+import OrDateTimePickerDocs from './OrDateTimePicker.docs.mdx';
+import OrDateTimePicker from './OrDateTimePicker.vue';
+import { DateTimePickerSize } from './props';
+
+export default {
+  title: 'Components/Date & Time Picker',
+  component: OrDateTimePicker,
+
+  argTypes: {
+    // Slots
+    addon: {
+      type: {
+        name: 'string',
+        required: false,
+      },
+
+      control: { type: 'text' },
+    },
+
+    // Props
+    modelValue: {
+      control: { type: 'text' },
+    },
+
+    yearFilter: {
+      table: { disable: true },
+    },
+
+    monthFilter: {
+      table: { disable: true },
+    },
+
+    dateFilter: {
+      table: { disable: true },
+    },
+
+    hoursFilter: {
+      table: { disable: true },
+    },
+
+    minutesFilter: {
+      table: { disable: true },
+    },
+
+    size: {
+      control: { type: 'select' },
+      options: Object.values(DateTimePickerSize),
+    },
+
+    label: {
+      control: { type: 'text' },
+    },
+
+    hint: {
+      control: { type: 'text' },
+    },
+
+    error: {
+      control: { type: 'text' },
+    },
+
+    required: {
+      control: { type: 'boolean' },
+    },
+
+    readonly: {
+      control: { type: 'boolean' },
+    },
+
+    disabled: {
+      control: { type: 'boolean' },
+    },
+
+    disableDefaultStyles: {
+      control: { type: 'boolean' },
+    },
+
+    // Events
+    'update:modelValue': {
+      table: { disable: true },
+    },
+
+    input: {
+      table: { disable: true },
+    },
+
+    keydown: {
+      table: { disable: true },
+    },
+
+    keyup: {
+      table: { disable: true },
+    },
+
+    focus: {
+      table: { disable: true },
+    },
+
+    blur: {
+      table: { disable: true },
+    },
+  },
+
+  parameters: {
+    docs: {
+      page: OrDateTimePickerDocs,
+    },
+
+    design: {
+      type: 'figma',
+      url: 'https://www.figma.com/file/o7DdkaznUW2PtX4wiSuhhQ/Core?node-id=4063%3A40967&t=H1iGW8hg2dduEfyc-4',
+    },
+  },
+} as Meta<typeof OrDateTimePicker>;
+
+const Template: StoryFn<typeof OrDateTimePicker> = (args) => ({
+  components: {
+    OrIcon,
+    OrDateTimePicker,
+  },
+
+  setup() {
+    // State
+    const model = ref<Date>();
+
+    // Effects
+    watch(model, (value) => {
+      console.debug(value);
+    });
+
+    return {
+      args,
+      model,
+      onUpdateModelValue: action('update:modelValue'),
+      onKeydown: action('keydown'),
+      onKeyup: action('keyup'),
+      onFocus: action('focus'),
+      onBlur: action('blur'),
+    };
+  },
+
+  template: `
+    <OrDateTimePicker
+      v-model="model"
+      v-bind="args"
+      @update:modelValue="onUpdateModelValue"
+      @keydown="onKeydown"
+      @keyup="onKeyup"
+      @focus="onFocus"
+      @blur="onBlur"
+    >
+      <template #addon>
+        ${args.addon}
+      </template>
+    </OrDateTimePicker>
+  `,
+});
+
+export const Default = Template.bind({});
+
+Default.args = {
+  // Slots
+  addon: '<OrIcon icon="info" />',
+
+  // Props
+  label: 'Label',
+  hint: Faker.lorem.sentence(20),
+};
+
+export const WithFilter = Template.bind({});
+
+WithFilter.args = {
+  ...Default.args,
+
+  // Props
+  dateFilter: (value: Date) => ![0, 6].includes(value.getUTCDay()),
+  hoursFilter: (value: Date) => value.getUTCHours() >= 9 && value.getUTCHours() <= 18,
+};