usbharu
/
misskey
mirror of https://github.com/misskey-dev/misskey.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor(frontend): menuの型定義の可読性向上 (#16261)

This commit is contained in:
かっこかり 2025-07-06 17:24:34 +09:00 committed by GitHub
parent 004cfd5e4b
commit 9dddc84750
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 101 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
packages/frontend/src/types/menu.ts
View File

@ -4,10 +4,10 @@
*/
import * as Misskey from 'misskey-js';
import type { Component, ComputedRef, Ref } from 'vue';
import type { Component, ComputedRef, Ref, MaybeRef } from 'vue';
import type { ComponentProps as CP } from 'vue-component-type-helpers';
type ComponentProps<T extends Component> = { [K in keyof CP<T>]: CP<T>[K] | Ref<CP<T>[K]> };
type ComponentProps<T extends Component> = { [K in keyof CP<T>]: MaybeRef<CP<T>[K]> };
type MenuRadioOptionsDef = Record<string, any>;
@ -15,22 +15,107 @@ type Text = string | ComputedRef<string>;
export type MenuAction = (ev: MouseEvent) => void;
export type MenuDivider = { type: 'divider' };
export type MenuNull = undefined;
export type MenuLabel = { type: 'label', text: Text, caption?: Text };
export type MenuLink = { type: 'link', to: string, text: Text, caption?: Text, icon?: string, indicate?: boolean, avatar?: Misskey.entities.User };
export type MenuA = { type: 'a', href: string, target?: string, download?: string, text: Text, caption?: Text, icon?: string, indicate?: boolean };
export type MenuUser = { type: 'user', user: Misskey.entities.User, active?: boolean, indicate?: boolean, action: MenuAction };
export type MenuSwitch = { type: 'switch', ref: Ref<boolean>, text: Text, caption?: Text, icon?: string, disabled?: boolean | Ref<boolean> };
export type MenuButton = { type?: 'button', text: Text, caption?: Text, icon?: string, indicate?: boolean, danger?: boolean, active?: boolean | ComputedRef<boolean>, avatar?: Misskey.entities.User; action: MenuAction };
export type MenuRadio = { type: 'radio', text: Text, caption?: Text, icon?: string, ref: Ref<MenuRadioOptionsDef[keyof MenuRadioOptionsDef]>, options: MenuRadioOptionsDef, disabled?: boolean | Ref<boolean> };
export type MenuRadioOption = { type: 'radioOption', text: Text, caption?: Text, action: MenuAction; active?: boolean | ComputedRef<boolean> };
export type MenuComponent<T extends Component = any> = { type: 'component', component: T, props?: ComponentProps<T> };
export type MenuParent = { type: 'parent', text: Text, caption?: Text, icon?: string, children: MenuItem[] | (() => Promise<MenuItem[]> | MenuItem[]) };
export interface MenuButton {
type?: 'button';
text: Text;
caption?: Text;
icon?: string;
indicate?: boolean;
danger?: boolean;
active?: boolean | ComputedRef<boolean>;
avatar?: Misskey.entities.User;
action: MenuAction;
}
export type MenuPending = { type: 'pending' };
interface MenuBase {
type: string;
}
type OuterMenuItem = MenuDivider | MenuNull | MenuLabel | MenuLink | MenuA | MenuUser | MenuSwitch | MenuButton | MenuRadio | MenuRadioOption | MenuComponent | MenuParent;
export interface MenuDivider extends MenuBase {
type: 'divider';
}
export interface MenuLabel extends MenuBase {
type: 'label';
text: Text;
caption?: Text;
}
export interface MenuLink extends MenuBase {
type: 'link';
to: string;
text: Text;
caption?: Text;
icon?: string;
indicate?: boolean;
avatar?: Misskey.entities.User;
}
export interface MenuA extends MenuBase {
type: 'a';
href: string;
target?: string;
download?: string;
text: Text;
caption?: Text;
icon?: string;
indicate?: boolean;
}
export interface MenuUser extends MenuBase {
type: 'user';
user: Misskey.entities.User;
active?: boolean;
indicate?: boolean;
action: MenuAction;
}
export interface MenuSwitch extends MenuBase {
type: 'switch';
ref: Ref<boolean>;
text: Text;
caption?: Text;
icon?: string;
disabled?: boolean | Ref<boolean>;
}
export interface MenuRadio extends MenuBase {
type: 'radio';
text: Text;
caption?: Text;
icon?: string;
ref: Ref<MenuRadioOptionsDef[keyof MenuRadioOptionsDef]>;
options: MenuRadioOptionsDef;
disabled?: boolean | Ref<boolean>;
}
export interface MenuRadioOption extends MenuBase {
type: 'radioOption';
text: Text;
caption?: Text;
action: MenuAction;
active?: boolean | ComputedRef<boolean>;
}
export interface MenuComponent<T extends Component = any> extends MenuBase {
type: 'component';
component: T;
props?: ComponentProps<T>;
}
export interface MenuParent extends MenuBase {
type: 'parent';
text: Text;
caption?: Text;
icon?: string;
children: MenuItem[] | (() => Promise<MenuItem[]> | MenuItem[]);
}
export interface MenuPending extends MenuBase {
type: 'pending';
}
type OuterMenuItem = MenuDivider | MenuLabel | MenuLink | MenuA | MenuUser | MenuSwitch | MenuButton | MenuRadio | MenuRadioOption | MenuComponent | MenuParent;
type OuterPromiseMenuItem = Promise<MenuLabel | MenuLink | MenuA | MenuUser | MenuSwitch | MenuButton | MenuComponent | MenuParent>;
export type MenuItem = OuterMenuItem | OuterPromiseMenuItem;
export type InnerMenuItem = MenuDivider | MenuPending | MenuLabel | MenuLink | MenuA | MenuUser | MenuSwitch | MenuButton | MenuRadio | MenuRadioOption | MenuComponent | MenuParent;