ph-utils
Version:
js 开发工具集,前后端都可以使用(commonjs和es module)
45 lines (44 loc) • 2.01 kB
TypeScript
/** 获取当前系统的主题 */
export declare function getSystemTheme(): "light" | "dark" | "auto";
/**
* 初始化主题, 让网页能够适应系统主题, 同时根据缓存的主题切换主题
* @returns 当前应用的主题
*/
export declare function initTheme(): Promise<"light" | "dark" | "auto">;
/**
* 切换主题, 通常用于预览
* @param theme 切换的主题
* @param transition 是否使用过渡动画, 注意浏览器必须支持 document.startViewTransition, 默认: true
* @returns 切换后的主题
*/
export declare function toggleTheme(theme?: "light" | "dark" | "auto", transition?: boolean): Promise<"light" | "dark" | "auto">;
/** 获取当前主题 */
export declare function getTheme(): string;
/**
* 应用主题
* @param theme 待应用的主题
* @param cache 是否缓存应用的主题, 让应用下一次启动的时候, 可以应用主题, 默认: true
* @param transition 是否使用过渡动画, 注意浏览器必须支持 document.startViewTransition, 默认: true
* @returns 应用的主题
*/
export declare function applyTheme(theme?: "light" | "dark" | "auto", cache?: boolean, transition?: boolean): Promise<"light" | "dark" | "auto">;
/** 获取当前主题色 */
export declare function getColorTheme(defaultValue?: string): string | undefined;
/**
* 初始化主题色, 让网页能够适应系统主题色, 同时根据缓存的主题色切换主题色
* @returns 当前应用的主题色
*/
export declare function initColorTheme(): Promise<string> | null;
/**
* 切换主题色, 通常用于预览
* @param color 待切换的主题色
* @returns 切换后的主题色
*/
export declare function toggleColorTheme(color: string): Promise<string>;
/**
* 应用主题色
* @param color 主题色
* @param cache 是否缓存主题色, 让应用下一次启动的时候, 可以应用主题色, 默认: true
* @returns 切换后的主题色
*/
export declare function applyColorTheme(color: string, cache?: boolean): Promise<string>;