@onereach/ui-components 2.72.0 → 2.72.1-beta.2249.0

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,48 @@
 <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,
+  CollapsibleSidebarToolbar,
+  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,9 +114,27 @@ 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'],
+  emits: [
+    'change:width',
+    'open',
+    'close',
+  ],
+
+  expose: [
+    'root',
+    'open',
+    'close',
+  ],
 
   setup(props, { emit }) {
     // Refs
@@ -84,20 +143,37 @@ 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,
+      ...(props.collapsible ? CollapsibleSidebarToolbar : []),
+      ...SidebarToolbarSides[props.side],
     ]);
 
     const resizeStyles = computed(() => [
@@ -106,6 +182,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 +218,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,24 +240,41 @@ 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;
     });
 
     watch(localWidth, (val: number) => emit('change:width', val));
 
+    watch(isCollapsed, (val: boolean) => emit(val ? 'close' : 'open'));
+
     return {
       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>

package/src/components/or-sidebar-v3/styles.ts

@@ -4,28 +4,100 @@ export const SidebarRoot: string[] = [
   // Position
   'relative',
 
+  // Layout
+  'flex',
+  'flex-row',
+  'shrink-0',
+
+  // Box
+  'min-w-0',
+  'h-auto',
+  'p-0',
+
+  // Theme
+  'bg-background',
+  'dark:bg-background-dark',
+];
+
+export const SidebarBar: string[] = [
+  // Position
+  'relative',
+
   // Layout
   'flex',
   'flex-col',
   'shrink-0',
+  'grow',
 
   // Box
   'min-h-0',
   'p-0',
+
+  // Theme
+  'text-on-background',
+  'dark:text-on-background-dark',
+
+  // Transition
+  'transition-[width]',
 ];
 
-export const SidebarRootSides: Record<OrSidebarPlacement, string[]> = {
+export const SidebarToolbar: string[] = [
+  // Position
+  'relative',
+
+  // Layout
+  'flex',
+  'flex-col',
+  'shrink-0',
+  'grow',
+  'overflow-auto',
+  'items-center',
+
+  // Sizing
+  'gap-md',
+
+  // Box
+  'min-h-0',
+  'min-w-xl',
+  'p-[6px]',
+  'py-md+',
+
+  // Theme
+  'text-outline',
+  'dark:text-outline-dark',
+];
+
+export const CollapsibleSidebarToolbar: string[] = [
+  'pt-[56px]',
+];
+
+export const SidebarSides: Record<OrSidebarPlacement, string[]> = {
+  [OrSidebarPlacement.left]: [
+    // Borders
+    'border-r-[1px]',
+    'border-r-solid',
+    'border-r-outline-variant dark:border-r-outline-variant-dark',
+  ],
+  [OrSidebarPlacement.right]: [
+    // Borders
+    'border-l-[1px]',
+    'border-l-solid',
+    'border-l-outline-variant dark:border-l-outline-variant-dark',
+  ],
+};
+
+export const SidebarToolbarSides: Record<OrSidebarPlacement, string[]> = {
   [OrSidebarPlacement.left]: [
     // Borders
     'border-r-[1px]',
     'border-r-solid',
-    'border-r-secondary dark:border-r-secondary-dark',
+    'border-r-outline-variant dark:border-r-outline-variant-dark',
   ],
   [OrSidebarPlacement.right]: [
     // Borders
     'border-l-[1px]',
     'border-l-solid',
-    'border-l-secondary dark:border-l-secondary-dark',
+    'border-l-outline-variant dark:border-l-outline-variant-dark',
   ],
 };
 
@@ -36,7 +108,7 @@ export const SidebarResize: string[] = [
   'z-[1]',
 
   // Box
-  'w-[12px]',
+  'w-sm+',
   'h-[100%]',
 
   // Cursor
@@ -50,7 +122,7 @@ export const SidebarResizeSides: Record<OrSidebarPlacement, string[]> = {
 
     // Borders
     'hover:border-r-2',
-    'hover:border-r-primary hover:dark:border-r-primary-dark',
+    'hover:border-r-primary-hover hover:dark:border-r-primary-hover-dark',
 
     // Transition
     'transition-[border-right]',
@@ -61,23 +133,42 @@ export const SidebarResizeSides: Record<OrSidebarPlacement, string[]> = {
 
     // Borders
     'hover:border-l-2',
-    'hover:border-l-primary hover:dark:border-l-primary-dark',
+    'hover:border-l-primary-hover hover:dark:border-l-primary-hover-dark',
 
     // Transition
     'transition-[border-left]',
   ],
 };
 
+export const SidebarCollapseButton: string[] = [
+  // Position
+  'absolute',
+  'top-md',
+  'inset-y-none',
+  'z-[1]',
+];
+
+export const SidebarCollapseButtonSides: Record<OrSidebarPlacement, string[]> = {
+  [OrSidebarPlacement.left]: [
+    // Position
+    '-right-[12px]',
+  ],
+  [OrSidebarPlacement.right]: [
+    // Position
+    '-left-[12px]',
+  ],
+};
+
 export const SidebarResizingSides: Record<OrSidebarPlacement, string[]> = {
   [OrSidebarPlacement.left]: [
     // Borders
     'border-r-2',
-    'border-r-primary dark:border-r-primary-dark',
+    'border-r-primary-hover dark:border-r-primary-hover-dark',
   ],
   [OrSidebarPlacement.right]: [
     // Borders
     'border-l-2',
-    'border-l-primary dark:border-l-primary-dark',
+    'border-l-primary-hover dark:border-l-primary-hover-dark',
   ],
 };
 
@@ -86,14 +177,24 @@ export const SidebarMain: string[] = [
   'flex',
   'flex-col',
   'grow',
+  'overflow-x-hidden',
 
   // Box
   'min-h-0',
 ];
 
 export const SidebarHeader: string[] = [
+  // Layout
+  'shrink-0',
+  'overflow-hidden',
+
   // Sizing
   'p-md',
+
+  // Typography
+  'typography-headline-2',
+  'whitespace-nowrap',
+  'text-ellipsis',
 ];
 
 export const SidebarContent: string[] = [
@@ -106,11 +207,65 @@ export const SidebarContent: string[] = [
 ];
 
 export const SidebarFooter: string[] = [
+  // Layout
+  'shrink-0',
+  'overflow-x-hidden',
+
   // Sizing
   'p-md',
 
   // Borders
   'border-t-[1px]',
   'border-t-solid',
-  'border-t-secondary dark:border-t-secondary-dark',
+  'border-t-outline-variant dark:border-t-outline-variant-dark',
+];
+
+export const CollapseButtonContainer: string[] = [
+  // Box
+  'w-[24px]',
+  'h-[24px]',
+  'rounded-full',
+
+  // Theme
+  'text-primary dark:text-primary-dark',
+  'bg-background dark:bg-background-dark',
+];
+
+export const CollapseButton: string[] = [
+  // Box
+  'w-[24px]',
+  'h-[24px]',
+
+  // Typography
+  '!text-[16px]',
+
+  // Borders
+  '!border-[1px]',
+  '!border-solid',
+
+  // Theme
+  '!text-primary dark:!text-primary-dark',
+  '!bg-background dark:!bg-background-dark',
+  '!border-outline-variant dark:!border-outline-variant-dark',
+  '!outline-none',
+
+  // Theme (hover)
+  'hover:!text-primary hover:dark:!text-primary-dark',
+  'hover:!bg-primary-opacity-0-08 dark:hover:!bg-primary-opacity-0-08-dark',
+  'hover:!border-outline dark:hover:!border-outline-dark',
+
+  // Theme (active)
+  'active:!text-primary active:dark:!text-primary-dark',
+  'active:!bg-primary-opacity-0-12 dark:active:!bg-primary-opacity-0-12-dark',
+  'active:!border-primary dark:active:!border-primary-dark',
+
+  // Theme (focus)
+  'focus:!text-primary focus:dark:!text-primary-dark',
+  'focus:!bg-primary-opacity-0-12 dark:focus:!bg-primary-opacity-0-12-dark',
+  'focus:!border-outline dark:focus:!border-outline-dark',
+
+  // Theme (disabled)
+  'disabled:!text-on-disabled disabled:dark:!text-on-disabled-dark',
+  'disabled:!bg-background disabled:dark:!bg-background-dark',
+  'disabled:!border-outline-variant disabled:dark:!border-outline-variant-dark',
 ];