Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add resizable and ColPage component #5188

Merged
merged 2 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/@core/base/icons/src/lucide.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export {
Fullscreen,
Github,
Grip,
GripVertical,
Info,
InspectionPanel,
Languages,
Expand Down
1 change: 1 addition & 0 deletions packages/@core/ui-kit/shadcn-ui/src/ui/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export * from './pagination';
export * from './pin-input';
export * from './popover';
export * from './radio-group';
export * from './resizable';
export * from './scroll-area';
export * from './select';
export * from './separator';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<script setup lang="ts">
import { computed, type HTMLAttributes } from 'vue';

import { GripVertical } from '@vben-core/icons';
import { cn } from '@vben-core/shared/utils';

import {
SplitterResizeHandle,
type SplitterResizeHandleEmits,
type SplitterResizeHandleProps,
useForwardPropsEmits,
} from 'radix-vue';

const props = defineProps<
{
class?: HTMLAttributes['class'];
withHandle?: boolean;
} & SplitterResizeHandleProps
>();
const emits = defineEmits<SplitterResizeHandleEmits>();

const delegatedProps = computed(() => {
const { class: _, ...delegated } = props;
return delegated;
});

const forwarded = useForwardPropsEmits(delegatedProps, emits);
</script>

<template>
<SplitterResizeHandle
v-bind="forwarded"
:class="
cn(
'bg-border focus-visible:ring-ring relative flex w-px items-center justify-center after:absolute after:inset-y-0 after:left-1/2 after:w-1 after:-translate-x-1/2 focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-offset-1 [&[data-orientation=vertical]>div]:rotate-90 [&[data-orientation=vertical]]:h-px [&[data-orientation=vertical]]:w-full [&[data-orientation=vertical]]:after:left-0 [&[data-orientation=vertical]]:after:h-1 [&[data-orientation=vertical]]:after:w-full [&[data-orientation=vertical]]:after:-translate-y-1/2 [&[data-orientation=vertical]]:after:translate-x-0',
props.class,
)
"
>
<template v-if="props.withHandle">
<div
class="bg-border z-10 flex h-4 w-3 items-center justify-center rounded-sm border"
>
<GripVertical class="h-2.5 w-2.5" />
</div>
</template>
</SplitterResizeHandle>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<script setup lang="ts">
import { computed, type HTMLAttributes } from 'vue';

import { cn } from '@vben-core/shared/utils';

import {
SplitterGroup,
type SplitterGroupEmits,
type SplitterGroupProps,
useForwardPropsEmits,
} from 'radix-vue';

const props = defineProps<
{ class?: HTMLAttributes['class'] } & SplitterGroupProps
>();
const emits = defineEmits<SplitterGroupEmits>();

const delegatedProps = computed(() => {
const { class: _, ...delegated } = props;
return delegated;
});

const forwarded = useForwardPropsEmits(delegatedProps, emits);
</script>

<template>
<SplitterGroup
v-bind="forwarded"
:class="
cn(
'flex h-full w-full data-[panel-group-direction=vertical]:flex-col',
props.class,
)
"
>
<slot></slot>
</SplitterGroup>
</template>
3 changes: 3 additions & 0 deletions packages/@core/ui-kit/shadcn-ui/src/ui/resizable/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export { default as ResizableHandle } from './ResizableHandle.vue';
export { default as ResizablePanelGroup } from './ResizablePanelGroup.vue';
export { SplitterPanel as ResizablePanel } from 'radix-vue';
107 changes: 107 additions & 0 deletions packages/effects/common-ui/src/components/col-page/col-page.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<script lang="ts" setup>
import type { ColPageProps } from './types';

import { computed, ref, useSlots } from 'vue';

import {
ResizableHandle,
ResizablePanel,
ResizablePanelGroup,
} from '@vben-core/shadcn-ui';

import Page from '../page/page.vue';

defineOptions({
name: 'ColPage',
inheritAttrs: false,
});

const props = withDefaults(defineProps<ColPageProps>(), {
leftWidth: 30,
rightWidth: 70,
resizable: true,
});

const delegatedProps = computed(() => {
const { leftWidth: _, ...delegated } = props;
return delegated;
});

const slots = useSlots();

const delegatedSlots = computed(() => {
const resultSlots: string[] = [];

for (const key of Object.keys(slots)) {
if (!['default', 'left'].includes(key)) {
resultSlots.push(key);
}
}
return resultSlots;
});

const leftPanelRef = ref<InstanceType<typeof ResizablePanel>>();

function expandLeft() {
leftPanelRef.value?.expand();
}

function collapseLeft() {
leftPanelRef.value?.collapse();
}

defineExpose({
expandLeft,
collapseLeft,
});
</script>
<template>
<Page v-bind="delegatedProps">
<!-- 继承默认的slot -->
<template
v-for="slotName in delegatedSlots"
:key="slotName"
#[slotName]="slotProps"
>
<slot :name="slotName" v-bind="slotProps"></slot>
</template>

<ResizablePanelGroup class="w-full" direction="horizontal">
<ResizablePanel
ref="leftPanelRef"
:collapsed-size="leftCollapsedWidth"
:collapsible="leftCollapsible"
:default-size="leftWidth"
:max-size="leftMaxWidth"
:min-size="leftMinWidth"
>
<template #default="slotProps">
<slot
name="left"
v-bind="{
...slotProps,
expand: expandLeft,
collapse: collapseLeft,
}"
></slot>
</template>
</ResizablePanel>
<ResizableHandle
v-if="resizable"
:style="{ backgroundColor: splitLine ? undefined : 'transparent' }"
:with-handle="splitHandle"
/>
<ResizablePanel
:collapsed-size="rightCollapsedWidth"
:collapsible="rightCollapsible"
:default-size="rightWidth"
:max-size="rightMaxWidth"
:min-size="rightMinWidth"
>
<template #default>
<slot></slot>
</template>
</ResizablePanel>
</ResizablePanelGroup>
</Page>
</template>
2 changes: 2 additions & 0 deletions packages/effects/common-ui/src/components/col-page/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { default as ColPage } from './col-page.vue';
export * from './types';
26 changes: 26 additions & 0 deletions packages/effects/common-ui/src/components/col-page/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import type { PageProps } from '../page/types';

export interface ColPageProps extends PageProps {
/**
* 左侧宽度
* @default 30
*/
leftWidth?: number;
leftMinWidth?: number;
leftMaxWidth?: number;
leftCollapsedWidth?: number;
leftCollapsible?: boolean;
/**
* 右侧宽度
* @default 70
*/
rightWidth?: number;
rightMinWidth?: number;
rightCollapsedWidth?: number;
rightMaxWidth?: number;
rightCollapsible?: boolean;

resizable?: boolean;
splitLine?: boolean;
splitHandle?: boolean;
}
mynetfan marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions packages/effects/common-ui/src/components/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export * from './api-component';
export * from './captcha';
export * from './col-page';
export * from './ellipsis-text';
export * from './icon-picker';
export * from './page';
Expand Down
1 change: 1 addition & 0 deletions packages/effects/common-ui/src/components/page/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export { default as Page } from './page.vue';
export * from './types';
16 changes: 3 additions & 13 deletions packages/effects/common-ui/src/components/page/page.vue
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<script setup lang="ts">
import type { PageProps } from './types';

import {
computed,
nextTick,
Expand All @@ -11,23 +13,11 @@ import {
import { CSS_VARIABLE_LAYOUT_CONTENT_HEIGHT } from '@vben-core/shared/constants';
import { cn } from '@vben-core/shared/utils';

interface Props {
title?: string;
description?: string;
contentClass?: string;
/**
* 根据content可见高度自适应
*/
autoContentHeight?: boolean;
headerClass?: string;
footerClass?: string;
}

defineOptions({
name: 'Page',
});

const { autoContentHeight = false } = defineProps<Props>();
const { autoContentHeight = false } = defineProps<PageProps>();

const headerHeight = ref(0);
const footerHeight = ref(0);
Expand Down
11 changes: 11 additions & 0 deletions packages/effects/common-ui/src/components/page/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export interface PageProps {
title?: string;
description?: string;
contentClass?: string;
/**
* 根据content可见高度自适应
*/
autoContentHeight?: boolean;
headerClass?: string;
footerClass?: string;
}
6 changes: 6 additions & 0 deletions playground/src/locales/langs/en-US/examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,11 @@
"timestamp": "Timestamp:",
"x": "x:",
"y": "y:"
},
"resize": {
"title": "Resize"
},
"layout": {
"col-page": "ColPage Layout"
}
}
3 changes: 3 additions & 0 deletions playground/src/locales/langs/zh-CN/examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,8 @@
"timestamp": "时间戳:",
"x": "x:",
"y": "y:"
},
"layout": {
"col-page": "双列布局"
}
}
11 changes: 11 additions & 0 deletions playground/src/router/routes/modules/examples.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,17 @@ const routes: RouteRecordRaw[] = [
title: $t('examples.resize.title'),
},
},
{
name: 'ColPageDemo',
path: '/examples/layout/col-page',
component: () => import('#/views/examples/layout/col-page.vue'),
meta: {
badge: 'Alpha',
badgeVariants: 'destructive',
icon: 'material-symbols:horizontal-distribute',
title: $t('examples.layout.col-page'),
},
},
mynetfan marked this conversation as resolved.
Show resolved Hide resolved
],
},
];
Expand Down
Loading
Loading