@onereach/ui-components 3.0.1 → 3.0.2-beta.2475.0

package/dist/esm/v3/components/or-tree-v3/TreeNode.vue.d.ts

@@ -0,0 +1,82 @@
+import { PropType } from 'vue-demi';
+import { ITreeNode } from './types';
+declare const _default: import("vue").ComponentOptions<import("vue").default, import("@vue/composition-api").ShallowUnwrapRef<{
+    rootClasses: string[];
+}> & import("@vue/composition-api").Data, {}, {
+    expandIcon(): "keyboard_arrow_down" | "arrow_right";
+    styleCSS(): {
+        'padding-left': string;
+    };
+}, {
+    node: {
+        type: PropType<ITreeNode>;
+        default: undefined;
+    };
+    nodeKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    isExpanded: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isLeaf: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    level: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, import("@vue/composition-api").ExtractPropTypes<{
+    node: {
+        type: PropType<ITreeNode>;
+        default: undefined;
+    };
+    nodeKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    isExpanded: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isLeaf: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    level: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>> & Omit<import("vue").VueConstructor<import("vue").default>, never> & (new (...args: any[]) => import("@vue/composition-api").ComponentRenderProxy<{
+    node: ITreeNode;
+    nodeKey: string;
+    isExpanded: boolean;
+    isLeaf: boolean;
+    level: number;
+} & {} & {
+    [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
+}, import("@vue/composition-api").ShallowUnwrapRef<{
+    rootClasses: string[];
+}>, import("@vue/composition-api").Data, {
+    expandIcon(): "keyboard_arrow_down" | "arrow_right";
+    styleCSS(): {
+        'padding-left': string;
+    };
+}, {}, {}, {}, string[], {
+    node: ITreeNode;
+    nodeKey: string;
+    isExpanded: boolean;
+    isLeaf: boolean;
+    level: number;
+} & {} & {
+    [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
+}, {
+    node: ITreeNode;
+    nodeKey: string;
+    isExpanded: boolean;
+    isLeaf: boolean;
+    level: number;
+}, true>);
+export default _default;

package/dist/esm/v3/components/or-tree-v3/index.d.ts

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

package/dist/esm/v3/components/or-tree-v3/index.js

@@ -0,0 +1,14 @@
+export { s as OrTreeV3 } from '../../OrTree-f4ee81ef.js';
+import 'vue-demi';
+import '../../OrIconButton-41ee266c.js';
+import '../../OrIcon-62793572.js';
+import 'vue';
+import '../../OrTooltip-02f07fa2.js';
+import '@vueuse/core';
+import '../../OrPopover-52250a03.js';
+import '@floating-ui/dom';
+import '../../useElevation-92fce12c.js';
+import '../../useResponsive-a02e95b7.js';
+import '../../OrBottomSheet-0f24ecae.js';
+import '../../OrOverlay-7cf03aea.js';
+import '../../OrTeleport.vue3-8099178c.js';

package/dist/esm/v3/components/or-tree-v3/styles.d.ts

@@ -0,0 +1 @@
+export declare const TreeNodeRoot: string[];

package/dist/esm/v3/components/or-tree-v3/types.d.ts

@@ -0,0 +1,10 @@
+export interface ITreeNode {
+    key: string;
+    isLeaf: boolean;
+    children?: ITreeNode[];
+}
+export interface ITreeNodeMetadata {
+    level: number;
+    isExpanded: boolean;
+    parentNodeKey: string;
+}

package/dist/esm/v3/components/or-tree-v3/utils.d.ts

@@ -0,0 +1,5 @@
+import { ITreeNode, ITreeNodeMetadata } from './types';
+export declare const getFlatTree: (tree: ITreeNode[]) => {
+    flatTree: ITreeNode[];
+    nodeMetadataByKey: Record<string, ITreeNodeMetadata>;
+};

package/dist/esm/v3/index.js

@@ -96,6 +96,7 @@ export { a as OrToastContainerV3, s as OrToastV3, t as TypesV3 } from './types-9
 export { p as PropsV3, a as useQueueV3, u as useToastV3 } from './useToast-0665462d.js';
 export { s as OrTooltip, a as OrTooltipContent } from './OrTooltip-8d7385bc.js';
 export { s as OrTooltipV3 } from './OrTooltip-02f07fa2.js';
+export { s as OrTreeV3 } from './OrTree-f4ee81ef.js';
 export { D as DropdownClose, a as DropdownOpen } from './dropdown-open-0d314aa4.js';
 export { u as useControlAttributes, a as useIdAttribute } from './useIdAttribute-859439f0.js';
 export { u as useElevation } from './useElevation-92fce12c.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/ui-components",
-  "version": "3.0.1",
+  "version": "3.0.2-beta.2475.0",
   "description": "Vue components library for v2/3",
   "sideEffects": false,
   "main": "./dist/auto/index.js",
@@ -124,6 +124,5 @@
       "default": "./dist/bundled/v3/components/*/index.js"
     },
     "./package.json": "./package.json"
-  },
-  "gitHead": "011555419b20001e8b4691da8d27b016bb106c67"
+  }
 }

package/src/components/index.ts

@@ -93,3 +93,4 @@ export * from './or-toast';
 export * from './or-toast-v3';
 export * from './or-tooltip';
 export * from './or-tooltip-v3';
+export * from './or-tree-v3';

package/src/components/or-tree-v3/OrTree.stories3.ts

@@ -0,0 +1,104 @@
+import { action } from '@storybook/addon-actions';
+import { StoryFn } from '@storybook/vue3';
+import OrTree from './OrTree.vue';
+
+const TREE_DATA = [
+  {
+    key: '0-0',
+    children: [
+      {
+        key: '0-0-0',
+        children: [
+          {
+            key: '0-0-0-0',
+          },
+          {
+            key: '0-0-0-1',
+          },
+          {
+            key: '0-0-0-2',
+          },
+        ],
+      },
+      {
+        key: '0-0-1',
+        children: [
+          {
+            key: '0-0-1-0',
+          },
+          {
+            key: '0-0-1-1',
+          },
+          {
+            key: '0-0-1-2',
+            children: [
+              {
+                key: '0-0-1-2-0',
+              },
+            ],
+          },
+        ],
+      },
+      {
+        key: '0-0-2',
+      },
+    ],
+  },
+  {
+    key: '0-1',
+    children: [
+      {
+        key: '0-1-0-0',
+      },
+      {
+        key: '0-1-0-1',
+      },
+      {
+        key: '0-1-0-2',
+      },
+    ],
+  },
+  {
+    key: '0-2',
+    isLeaf: true,
+  },
+];
+
+export default {
+  title: 'Components/Tree',
+  component: OrTree,
+  argTypes: {
+  },
+};
+
+const Template: StoryFn<typeof OrTree> = (args) => ({
+  components: {
+    OrTree,
+  },
+
+  data() {
+    return {
+      TREE_DATA,
+    };
+  },
+
+  setup() {
+    return {
+      args,
+      onUpdateState: action('update:state'),
+    };
+  },
+
+  template: `
+    <OrTree
+      v-bind="args"
+    />
+  `,
+});
+
+export const Default = Template.bind({});
+
+Default.args = {
+  // Props
+  initialData: TREE_DATA,
+};

package/src/components/or-tree-v3/OrTree.vue

@@ -0,0 +1,85 @@
+<template>
+  <div
+    class="or-tree"
+    @drop="onDrop"
+  >
+    <tree-node
+      v-for="node in visibleItems"
+      :key="node[identifierKey]"
+      :node="node"
+      :node-key="node[identifierKey]"
+      :is-expanded="nodeMetadataByKey[node.key].isExpanded"
+      :is-leaf="!!node.isLeaf"
+      :level="nodeMetadataByKey[node.key].level"
+      @trigger-expand="onTriggerExpand"
+    >
+      <template
+        v-slot:default="props"
+      >
+        <slot v-bind="props" />
+      </template>
+    </tree-node>
+  </div>
+</template>
+
+<script lang="ts">
+import { defineComponent, PropType } from 'vue-demi';
+import { ITreeNode, ITreeNodeMetadata } from './types';
+import { getFlatTree } from './utils';
+import TreeNode from './TreeNode.vue';
+
+export default defineComponent({
+  components: {
+    TreeNode,
+  },
+  props: {
+    initialData: {
+      type: Array as PropType<ITreeNode[]>,
+      default: () => ([]),
+    },
+    identifierKey: {
+      type: String,
+      default: 'key',
+    },
+  },
+
+  data() {
+    return {
+      flatTree: [] as ITreeNode[],
+      nodeMetadataByKey: {} as Record<string, ITreeNodeMetadata>,
+    };
+  },
+
+  computed: {
+    visibleItems() {
+      return this.flatTree.filter(treeNode => {
+        return this.isNodeExpanded(treeNode.key);
+      });
+    },
+  },
+
+  mounted() {
+    const {
+      nodeMetadataByKey, flatTree,
+    } = getFlatTree(this.initialData);
+    this.flatTree = flatTree;
+    this.nodeMetadataByKey = nodeMetadataByKey;
+  },
+
+  methods: {
+    onTriggerExpand(key: string) {
+      this.nodeMetadataByKey[key].isExpanded = !this.nodeMetadataByKey[key].isExpanded;
+    },
+
+    isNodeExpanded(key: string): boolean {
+      const { parentNodeKey, level } = this.nodeMetadataByKey[key];
+      const parentMetadata = this.nodeMetadataByKey[parentNodeKey];
+
+      if (level === 0) return true;
+      if (!parentMetadata.isExpanded) return false;
+
+      return this.isNodeExpanded(parentNodeKey);
+    },
+  },
+});
+</script>

package/src/components/or-tree-v3/TreeNode.vue

@@ -0,0 +1,72 @@
+<template>
+  <div
+    class="tree-node"
+    :class="rootClasses"
+    :style="styleCSS"
+  >
+    <or-icon-button
+      v-if="!isLeaf"
+      :icon="expandIcon"
+      @click="$emit('trigger-expand', nodeKey)"
+    />
+
+    <slot v-bind="$props">
+      {{ nodeKey }}
+    </slot>
+  </div>
+</template>
+
+<script lang="ts">
+import { defineComponent, PropType } from 'vue-demi';
+import { OrIconButtonV3 as OrIconButton } from '../or-icon-button-v3';
+import { TreeNodeRoot } from './styles';
+import { ITreeNode } from './types';
+
+export default defineComponent({
+  components: {
+    OrIconButton,
+  },
+  props: {
+    node: {
+      type: Object as PropType<ITreeNode>,
+      default: undefined,
+    },
+    nodeKey: {
+      type: String,
+      default: '',
+    },
+    isExpanded: {
+      type: Boolean,
+      default: false,
+    },
+    isLeaf: {
+      type: Boolean,
+      default: false,
+    },
+    level: {
+      type: Number,
+      default: 0,
+    },
+  },
+  emits: ['trigger-expand'],
+
+  setup() {
+    return {
+      rootClasses: TreeNodeRoot,
+    };
+  },
+
+  computed: {
+    expandIcon() {
+      return this.isExpanded ? 'keyboard_arrow_down' : 'arrow_right';
+    },
+
+    styleCSS() {
+      return {
+        // 24px -- gap-sm + tooltip width
+        'padding-left': (this.isLeaf && this.level === 0) ? '24px' : `${this.level * 10}px`,
+      };
+    },
+  },
+});
+</script>

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

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

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

@@ -0,0 +1,13 @@
+export const TreeNodeRoot: string[] = [
+  'flex',
+  'items-center',
+  'gap-sm',
+  'pt-6',
+  'my-sm',
+
+  // Theme
+  'text-on-background',
+  'dark:text-on-background-dark',
+  'hover:bg-primary-opacity-0-08',
+  'dark:hover:bg-primary-opacity-0-08-dark',
+];

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

@@ -0,0 +1,12 @@
+export interface ITreeNode {
+  key: string;
+  isLeaf: boolean;
+  children?: ITreeNode[];
+}
+
+
+export interface ITreeNodeMetadata {
+  level: number;
+  isExpanded: boolean;
+  parentNodeKey: string;
+}

package/src/components/or-tree-v3/utils.ts

@@ -0,0 +1,31 @@
+import { ITreeNode, ITreeNodeMetadata } from './types';
+
+export const getFlatTree = (tree: ITreeNode[]) => {
+  const flatTree: ITreeNode[] = [];
+  const nodeMetadataByKey: Record<string, ITreeNodeMetadata> = {};
+
+  const goDeeper = (treeNode: ITreeNode, level: number, parentNodeKey: string) => {
+    flatTree.push(treeNode);
+    nodeMetadataByKey[treeNode.key] = {
+      level,
+      isExpanded: false,
+      parentNodeKey,
+    };
+
+    if (treeNode.children) {
+      for (const child of treeNode.children) {
+        goDeeper(child, level + 1, treeNode.key);
+      }
+
+    }
+  };
+
+  for (const node of tree) {
+    goDeeper(node, 0, '');
+  }
+
+  return {
+    flatTree,
+    nodeMetadataByKey,
+  };
+};