@onereach/ui-components 2.70.2-beta.2219.0 → 2.70.3-beta.2210.0

package/src/components/or-sidebar-v3/OrSidebar.stories3.ts

@@ -3,8 +3,11 @@ import OrSidebarDocs from './OrSidebar.docs.mdx';
 import OrSidebar from './OrSidebar.vue';
 import { OrSidebarPlacement } from './props';
 import { action } from '@storybook/addon-actions';
+import { ref } from 'vue-demi';
 import * as Faker from 'faker';
 import { OrButtonV3 as OrButton } from '../or-button-v3';
+import { OrIconButtonV3 as OrIconButton } from '../or-icon-button-v3';
+import { OrTabsV3 as OrTabs, TabsItem } from '../or-tabs-v3';
 
 export default {
   title: 'Components/Sidebar',
@@ -39,6 +42,15 @@ export default {
       control: { type: 'text' },
     },
 
+    toolbar: {
+      type: {
+        name: 'string',
+        required: false,
+      },
+
+      control: { type: 'text' },
+    },
+
     // Props
     width: {
       control: { type: 'number' },
@@ -52,6 +64,14 @@ export default {
       control: { type: 'select' },
       options: Object.values(OrSidebarPlacement),
     },
+
+    draggable: {
+      control: { type: 'boolean' },
+    },
+
+    collapsible: {
+      control: { type: 'boolean' },
+    },
   },
 
   parameters: {
@@ -67,6 +87,7 @@ const DefaultTemplate: StoryFn<typeof OrSidebar> = (args) => ({
   components: {
     OrSidebar,
     OrButton,
+    OrIconButton,
   },
 
   setup() {
@@ -78,9 +99,9 @@ const DefaultTemplate: StoryFn<typeof OrSidebar> = (args) => ({
   },
 
   template: `
-    <div style="display: flex; flex-direction: row; border: 1px solid gray; max-height: 500px">
+    <div style="display: flex; flex-direction: row; border: 1px solid gray; max-height: 750px">
       <div style="flex-grow: 1; overflow: auto">
-        ${Faker.lorem.paragraphs(3)}
+        ${Faker.lorem.paragraphs(10)}
       </div>
       <OrSidebar v-bind="args" @change:width="onChangeWidth">
           <template v-if="${!!args.header}" v-slot:header>
@@ -92,6 +113,9 @@ const DefaultTemplate: StoryFn<typeof OrSidebar> = (args) => ({
           <template v-if="${!!args.footer}" v-slot:footer>
             ${args.footer}
           </template>
+          <template v-if="${!!args.toolbar}" v-slot:toolbar>
+            ${args.toolbar}
+          </template>
       </OrSidebar>
     </div>
   `,
@@ -101,6 +125,7 @@ const LeftTemplate: StoryFn<typeof OrSidebar> = (args) => ({
   components: {
     OrSidebar,
     OrButton,
+    OrIconButton,
   },
 
   setup() {
@@ -112,7 +137,7 @@ const LeftTemplate: StoryFn<typeof OrSidebar> = (args) => ({
   },
 
   template: `
-    <div style="display: flex; flex-direction: row; border: 1px solid gray; max-height: 500px">
+    <div style="display: flex; flex-direction: row; border: 1px solid gray; max-height: 750px">
       <OrSidebar v-bind="args" @change:width="onChangeWidth">
           <template v-if="${!!args.header}" v-slot:header>
             ${args.header}
@@ -123,14 +148,137 @@ const LeftTemplate: StoryFn<typeof OrSidebar> = (args) => ({
           <template v-if="${!!args.footer}" v-slot:footer>
             ${args.footer}
           </template>
+          <template v-if="${!!args.toolbar}" v-slot:toolbar>
+            ${args.toolbar}
+          </template>
       </OrSidebar>
       <div style="flex-grow: 1; overflow: auto">
-        ${Faker.lorem.paragraphs(3)}
+        ${Faker.lorem.paragraphs(10)}
       </div>
     </div>
   `,
 });
 
+const TabsTemplate: StoryFn<typeof OrSidebar> = (args) => ({
+  components: {
+    OrSidebar,
+    OrButton,
+    OrIconButton,
+    OrTabs,
+  },
+
+  setup() {
+    // State
+    const model = ref<string>();
+
+    return {
+      args,
+      model,
+    };
+  },
+
+  methods: {
+    onChangeWidth: action('change:width'),
+  },
+
+  template: `
+    <div style="display: flex; flex-direction: row; border: 1px solid gray; max-height: 750px">
+      <div style="flex-grow: 1; overflow: auto">
+        ${Faker.lorem.paragraphs(10)}
+      </div>
+      <OrSidebar v-bind="args" @change:width="onChangeWidth">
+          <template v-if="${!!args.header}" v-slot:header>
+            ${args.header}
+          </template>
+          <template v-if="${!!args.default}" v-slot:default>
+            ${args.default}
+          </template>
+          <template v-else v-slot:default>
+            <or-tabs
+              v-model="model"
+              :items="args.items"
+            >
+              <template v-for="item in args.items" #[item.value]>
+                {{ item.label }} Content
+                ${Faker.lorem.paragraphs(3)}
+              </template>
+            </or-tabs>
+          </template>
+          <template v-if="${!!args.footer}" v-slot:footer>
+            ${args.footer}
+          </template>
+          <template v-if="${!!args.toolbar}" v-slot:toolbar>
+            ${args.toolbar}
+          </template>
+      </OrSidebar>
+    </div>
+  `,
+});
+
+const longToolbar = `
+  <or-icon-button
+    icon="refresh"
+    color="inherit"
+  />
+  <hr class="w-full border-outline-variant dark:border-outline-variant-dark" />
+  <or-icon-button
+    icon="add"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="zoom_out_map"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="remove"
+    color="inherit"
+  />
+  <hr class="w-full border-outline-variant dark:border-outline-variant-dark" />
+  <or-icon-button
+    icon="description"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="tab_unselected"
+    color="inherit"
+  />
+  <hr class="w-full border-outline-variant dark:border-outline-variant-dark" />
+  <or-icon-button
+    icon="create_new_folder"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="content_paste"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="location_on"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="copy_all"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="call_split"
+    color="inherit"
+  />
+  <hr class="w-full border-outline-variant dark:border-outline-variant-dark" />
+  <or-icon-button
+    icon="sell"
+    color="inherit"
+  />
+  <div class="mt-auto" />
+  <or-icon-button
+    icon="terminal"
+    color="inherit"
+  />
+  <or-icon-button
+    icon="delete"
+    color="inherit"
+  />
+`;
+
 export const Default = DefaultTemplate.bind({});
 Default.args = {
   header: 'Header',
@@ -138,11 +286,24 @@ Default.args = {
   footer: 'Footer',
 };
 
-export const WithMinimumWidth = DefaultTemplate.bind({});
-WithMinimumWidth.args = {
+export const WithCustomWidthConstraints = DefaultTemplate.bind({});
+WithCustomWidthConstraints.args = {
   ...Default.args,
   width: 250,
   minimumWidth: 200,
+  maximumWidth: 500,
+};
+
+export const NotDraggable = DefaultTemplate.bind({});
+NotDraggable.args = {
+  ...Default.args,
+  draggable: false,
+};
+
+export const Collapsible = DefaultTemplate.bind({});
+Collapsible.args = {
+  ...Default.args,
+  collapsible: true,
 };
 
 export const OnlyContent = DefaultTemplate.bind({});
@@ -167,8 +328,60 @@ WithFooter.args = {
   `,
 };
 
+export const WithToolbar = DefaultTemplate.bind({});
+WithToolbar.args = {
+  ...OnlyContent.args,
+  toolbar: longToolbar,
+};
+
+export const CollapsibleWithToolbar = DefaultTemplate.bind({});
+CollapsibleWithToolbar.args = {
+  ...WithToolbar.args,
+  collapsible: true,
+};
+
+export const WithTabs = TabsTemplate.bind({});
+WithTabs.args = {
+  minimumWidth: 352,
+  header: 'Headline',
+  items: Array.from<string, TabsItem>([
+    'Alfa',
+    'Bravo',
+    'Charlie',
+    'Delta',
+    'Echo',
+    'Foxtrot',
+    'Golf',
+    'Hotel',
+    'India',
+    'Juliett',
+  ], (item) => ({
+    value: item.toLowerCase(),
+    label: item,
+  })),
+  footer: `
+    <div style="display: flex; flex-direction: row; justify-content: end; gap: 16px">
+        <or-button color="danger" variant="outlined">Delete</or-button>
+        <or-button variant="outlined" class="ml-auto">Cancel</or-button>
+        <or-button>Save</or-button>
+    </div>
+  `,
+};
+
 export const LeftSidebar = LeftTemplate.bind({});
 LeftSidebar.args = {
   ...Default.args,
   side: 'left',
 };
+
+export const WithLeftToolbar = LeftTemplate.bind({});
+WithLeftToolbar.args = {
+  ...LeftSidebar.args,
+  toolbar: longToolbar,
+};
+
+export const CollapsibleWithWithLeftToolbar = LeftTemplate.bind({});
+CollapsibleWithWithLeftToolbar.args = {
+  ...WithLeftToolbar.args,
+  collapsible: true,
+};

package/src/components/or-sidebar-v3/OrSidebar.vue

@@ -2,28 +2,55 @@
   <aside
     ref="root"
     :class="rootStyles"
-    :style="sidebarStyle"
   >
     <div
-      ref="resizeBar"
-      :class="resizeStyles"
-    />
-    <div :class="mainStyles">
+      v-if="side === 'right' && isShowingToolbar"
+      :class="toolbarStyles"
+    >
+      <slot name="toolbar" />
+    </div>
+    <div
+      :class="sidebarStyles"
+      :style="sidebarStyle"
+    >
       <div
-        v-if="$slots.header"
-        :class="headerStyles"
+        v-if="draggable && !isCollapsed"
+        ref="resizeBar"
+        :class="resizeStyles"
+      />
+      <or-sidebar-collapse-button
+        v-if="collapsible"
+        v-model="isCollapsed"
+        :class="collapsibleButtonStyles"
+        :side="side"
+      />
+      <div
+        v-show="!isCollapsed"
+        :class="mainStyles"
       >
-        <slot name="header" />
+        <div
+          v-if="$slots.header"
+          :class="headerStyles"
+        >
+          <slot name="header" />
+        </div>
+        <div :class="contentStyles">
+          <slot />
+        </div>
       </div>
-      <div :class="contentStyles">
-        <slot />
+      <div
+        v-if="$slots.footer"
+        v-show="!isCollapsed"
+        :class="footerStyles"
+      >
+        <slot name="footer" />
       </div>
     </div>
     <div
-      v-if="$slots.footer"
-      :class="footerStyles"
+      v-if="side === 'left' && isShowingToolbar"
+      :class="toolbarStyles"
     >
-      <slot name="footer" />
+      <slot name="toolbar" />
     </div>
   </aside>
 </template>
@@ -31,34 +58,47 @@
 <script lang="ts">
 import { useDraggable, useElementBounding } from '@vueuse/core';
 import _ from 'lodash';
-import { computed, defineComponent, PropType, ref, watch } from 'vue-demi';
+import { computed, defineComponent, PropType, ref, watch, useSlots } from 'vue-demi';
 import { OrSidebarPlacement } from './props';
 import {
   SidebarRoot,
-  SidebarRootSides,
+  SidebarBar,
+  SidebarToolbar,
+  SidebarSides,
+  SidebarToolbarSides,
   SidebarResize,
   SidebarResizeSides,
+  SidebarCollapseButton,
+  SidebarCollapseButtonSides,
   SidebarResizingSides,
   SidebarMain,
   SidebarHeader,
   SidebarContent,
   SidebarFooter,
 } from './styles';
+import OrSidebarCollapseButton from './OrSidebarCollapseButton.vue';
 
 export default defineComponent({
   name: 'OrSidebar',
 
+  components: {
+    OrSidebarCollapseButton,
+  },
+
   props: {
     width: {
       type: Number,
-      required: false,
-      default: 0,
+      default: 320,
       validator: (value?: any) => _.isNumber(value) && value >= 0,
     },
     minimumWidth: {
       type: Number,
-      required: false,
-      default: 350,
+      default: 256,
+      validator: (value?: any) => _.isNumber(value) && value >= 0,
+    },
+    maximumWidth: {
+      type: Number,
+      default: 384,
       validator: (value?: any) => _.isNumber(value) && value >= 0,
     },
     /**
@@ -73,10 +113,24 @@ export default defineComponent({
       default: OrSidebarPlacement.right,
       validator: (value?: any) => _.includes(_.values(OrSidebarPlacement), value),
     },
+    draggable: {
+      type: Boolean,
+      default: true,
+    },
+    collapsible: {
+      type: Boolean,
+      default: false,
+    },
   },
 
   emits: ['change:width'],
 
+  expose: [
+    'root',
+    'open',
+    'close',
+  ],
+
   setup(props, { emit }) {
     // Refs
     const root = ref<HTMLElement>();
@@ -84,20 +138,36 @@ export default defineComponent({
 
     const parentContainer = computed(() => root.value?.parentElement);
 
+    // Slots
+    const { toolbar: toolbarSlot } = useSlots();
+
     // State
     const startPositionX = ref(0);
     const isResizing = ref(false);
+    const isCollapsed = ref(false);
+    const maximumWidth = ref(props.maximumWidth || 384);
     const localWidth = ref(props.width >= props.minimumWidth ? props.width : props.minimumWidth);
 
+    const isShowingToolbar = computed(() => !!toolbarSlot);
+
     // Styles
     const sidebarStyle = computed(() => ({
-      width: localWidth.value + 'px',
+      width: (isCollapsed.value ? 16 : localWidth.value) + 'px',
     }));
 
     const rootStyles = computed(() => [
       'or-sidebar',
       ...SidebarRoot,
-      ...SidebarRootSides[props.side],
+    ]);
+
+    const sidebarStyles = computed(() => [
+      ...SidebarBar,
+      ...SidebarSides[props.side],
+    ]);
+
+    const toolbarStyles = computed(() => [
+      ...SidebarToolbar,
+      ...SidebarToolbarSides[props.side],
     ]);
 
     const resizeStyles = computed(() => [
@@ -106,6 +176,11 @@ export default defineComponent({
       ...(isResizing.value ? SidebarResizingSides[props.side] : []),
     ]);
 
+    const collapsibleButtonStyles = computed(() => [
+      ...SidebarCollapseButton,
+      ...SidebarCollapseButtonSides[props.side],
+    ]);
+
     const mainStyles = computed(() => [...SidebarMain]);
 
     const headerStyles = computed(() => [...SidebarHeader]);
@@ -137,7 +212,16 @@ export default defineComponent({
       },
     });
 
-    const { width: maximumWidth } = useElementBounding(parentContainer);
+    // Methods
+    function open(): void {
+      isCollapsed.value = false;
+    }
+
+    function close(): void {
+      isCollapsed.value = true;
+    }
+
+    const { width: containerWidth } = useElementBounding(parentContainer);
 
     watch(() => props.width, (newValue: number) => {
       if (newValue !== localWidth.value) {
@@ -150,6 +234,14 @@ export default defineComponent({
       if (newMinimum > localWidth.value) localWidth.value = newMinimum;
     });
 
+    watch(() => props.maximumWidth, (newMaximum: number) => {
+      if (newMaximum < maximumWidth.value) maximumWidth.value = newMaximum;
+    });
+
+    watch(containerWidth, (newMaximum: number) => {
+      if (newMaximum < maximumWidth.value) maximumWidth.value = newMaximum;
+    });
+
     watch(maximumWidth, (newMaximum: number) => {
       if (newMaximum < localWidth.value) localWidth.value = newMaximum;
     });
@@ -160,14 +252,21 @@ export default defineComponent({
       root,
       resizeBar,
       isResizing,
+      isCollapsed,
       localWidth,
+      isShowingToolbar,
       sidebarStyle,
       rootStyles,
+      sidebarStyles,
+      toolbarStyles,
       resizeStyles,
+      collapsibleButtonStyles,
       mainStyles,
       headerStyles,
       contentStyles,
       footerStyles,
+      open,
+      close,
     };
   },
 });

package/src/components/or-sidebar-v3/OrSidebarCollapseButton.stories3.ts

@@ -0,0 +1,48 @@
+import { Meta, StoryFn } from '@storybook/vue3';
+import OrSidebarCollapseButton from './OrSidebarCollapseButton.vue';
+import { OrSidebarPlacement } from './props';
+import { action } from '@storybook/addon-actions';
+import { ref } from 'vue-demi';
+
+export default {
+  title: 'Components/Sidebar/Parts/CollapseButton',
+  component: OrSidebarCollapseButton,
+
+  argTypes: {
+    // Props
+    modelValue: {
+      control: { type: 'boolean' },
+    },
+
+    side: {
+      control: { type: 'select' },
+      options: Object.values(OrSidebarPlacement),
+    },
+  },
+} as Meta<typeof OrSidebarCollapseButton>;
+
+const DefaultTemplate: StoryFn<typeof OrSidebarCollapseButton> = (args) => ({
+  components: {
+    OrSidebarCollapseButton,
+  },
+
+  setup() {
+    const collapsed = ref<boolean>(!!args.modelValue);
+
+    return {
+      args,
+      collapsed,
+    };
+  },
+
+  methods: {
+    onUpdateModelValue: action('update:modelValue'),
+  },
+
+  template: '<OrSidebarCollapseButton v-model="collapsed" v-bind="args" @update:modelValue="onUpdateModelValue" />',
+});
+
+export const Default = DefaultTemplate.bind({});
+Default.args = {
+  side: OrSidebarPlacement.right,
+};

package/src/components/or-sidebar-v3/OrSidebarCollapseButton.vue

@@ -0,0 +1,74 @@
+<template>
+  <div
+    ref="root"
+    :class="rootStyles"
+  >
+    <or-icon-button
+      :class="buttonStyles"
+      :icon="{ icon, size: 'inherit' }"
+      color="inherit"
+      @click="$emit('update:modelValue', !modelValue)"
+    />
+  </div>
+</template>
+
+<script lang="ts">
+import _ from 'lodash';
+import { computed, defineComponent, PropType, ref } from 'vue-demi';
+import { OrSidebarPlacement } from './props';
+import { OrIconButtonV3 as OrIconButton } from '../or-icon-button-v3';
+import { CollapseButton, CollapseButtonContainer } from './styles';
+
+export default defineComponent({
+  name: 'OrSidebarCollapseButton',
+
+  components: {
+    OrIconButton,
+  },
+
+  props: {
+    /**
+     * Must be `true` if sidebar is collapsed.
+     */
+    modelValue: {
+      type: Boolean,
+      default: false,
+    },
+    side: {
+      type: String as PropType<OrSidebarPlacement>,
+      default: OrSidebarPlacement.right,
+      validator: (value?: any) => _.includes(_.values(OrSidebarPlacement), value),
+    },
+  },
+
+  emits: ['update:modelValue'],
+
+  expose: ['root'],
+
+  setup(props) {
+    // Refs
+    const root = ref<InstanceType<typeof HTMLDivElement>>();
+
+    const rootStyles = computed(() => [
+      'or-sidebar-collapse-button',
+      ...CollapseButtonContainer,
+    ]);
+
+    const buttonStyles = computed(() => [
+      ...CollapseButton,
+    ]);
+
+    const icon = computed(() => (props.side === OrSidebarPlacement.left !== props.modelValue) ?
+      'keyboard_arrow_left' :
+      'keyboard_arrow_right',
+    );
+
+    return {
+      root,
+      rootStyles,
+      buttonStyles,
+      icon,
+    };
+  },
+});
+</script>