refactor(components): migrate DockView to dynamic panel/tab components with store-based API exposure and autoAdd flag

This commit is contained in:
cfngc4594 2025-04-13 11:35:29 +08:00
parent 737965dc91
commit 56782b83fc

View File

@ -8,51 +8,64 @@ import type {
IDockviewPanelProps,
} from "dockview";
import "@/styles/dockview.css";
import * as Icons from "lucide-react";
import { useEffect, useState } from "react";
import type { LucideIcon } from "lucide-react";
import { useDockviewStore } from "@/stores/dockview";
import { useEffect, useMemo, useState } from "react";
import { DockviewReact, themeAbyssSpaced } from "dockview";
interface PanelContent {
icon?: LucideIcon;
content?: React.ReactNode;
autoAdd?: boolean;
}
interface DockviewProps {
storageKey: string;
options: AddPanelOptions[];
components: Record<string, React.FunctionComponent<IDockviewPanelProps>>;
tabComponents?: Record<string, React.FunctionComponent<IDockviewPanelHeaderProps>>;
onApiReady?: (api: DockviewApi) => void;
options: AddPanelOptions<PanelContent>[];
}
const DefaultTab = (
props: IDockviewPanelHeaderProps<{ icon?: string }>
) => {
const { icon } = props.params;
const Icon =
icon && icon in Icons
? (Icons[icon as keyof typeof Icons] as LucideIcon)
: null;
return (
<div className="flex items-center px-1 text-sm font-medium">
{Icon && (
<Icon
className="-ms-0.5 me-1.5 opacity-60"
size={16}
aria-hidden="true"
/>
)}
{props.api.title}
</div>
);
};
export default function DockView({
storageKey,
options,
components,
tabComponents,
onApiReady,
}: DockviewProps) {
export default function DockView({ storageKey, options }: DockviewProps) {
const { setApi: _setApi } = useDockviewStore();
const [api, setApi] = useState<DockviewApi>();
const { components, tabComponents } = useMemo(() => {
const components: Record<
string,
React.FunctionComponent<IDockviewPanelProps<PanelContent>>
> = {};
const tabComponents: Record<
string,
React.FunctionComponent<IDockviewPanelHeaderProps<PanelContent>>
> = {};
options.forEach((option) => {
const { id, params } = option;
components[id] = () => {
const content = params?.content;
return <>{content}</>;
};
tabComponents[id] = (props) => {
const Icon = params?.icon;
return (
<div className="flex items-center px-1 text-sm font-medium">
{Icon && (
<Icon
className="-ms-0.5 me-1.5 opacity-60"
size={16}
aria-hidden="true"
/>
)}
{props.api.title}
</div>
);
};
});
return { components, tabComponents };
}, [options]);
useEffect(() => {
if (!api) return;
@ -66,7 +79,7 @@ export default function DockView({
const onReady = (event: DockviewReadyEvent) => {
setApi(event.api);
onApiReady?.(event.api);
_setApi(event.api);
let success = false;
const serializedLayout = localStorage.getItem(storageKey);
@ -84,6 +97,8 @@ export default function DockView({
if (!success) {
options.forEach((option) => {
const autoAdd = option.params?.autoAdd ?? true;
if (!autoAdd) return;
event.api.addPanel({ ...option });
});
}
@ -94,7 +109,6 @@ export default function DockView({
theme={themeAbyssSpaced}
onReady={onReady}
components={components}
defaultTabComponent={DefaultTab}
tabComponents={tabComponents}
/>
);