Hook

• useLoading：显示或隐藏包管理的全页 Loading。
• useOverlay：显示或隐藏包管理的页面遮罩，并接受可选透明度。
• useScreenFull：初始化或释放全屏状态监听，并提供查询、切换、进入和退出操作。

Hook 只在调用时解析浏览器全局对象，服务端渲染阶段不得调用。

useLoading.show 响应式

增加活动计数并显示全页 Loading。

签名

show(): void;

示例

import { useLoading } from "fast-element-plus";

useLoading.show();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

useLoading.hide 响应式

减少活动计数；计数归零后延迟移除全页 Loading。

签名

hide(): void;

示例

import { useLoading } from "fast-element-plus";

useLoading.hide();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

useOverlay.show 响应式

增加活动计数并显示全页遮罩。

签名

show(transparent?: number): void;

示例

import { useOverlay } from "fast-element-plus";

useOverlay.show(0.35);

输入

输入值	输入值类型	必填/默认值	输入值说明
transparent	number	否，默认 0	CSS rgba 使用的遮罩透明度。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

useOverlay.hide 响应式

减少活动计数；计数归零时移除遮罩。

签名

hide(): void;

示例

import { useOverlay } from "fast-element-plus";

useOverlay.hide();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

useScreenFull.isFullscreen 响应式

读取当前响应式全屏状态。

签名

isFullscreen(): boolean;

示例

import { useScreenFull } from "fast-element-plus";

const result = useScreenFull.isFullscreen();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	boolean	当前处于全屏状态时为 true。

useScreenFull.init 响应式

初始化一次 Screenfull change 监听。

签名

init(): void;

示例

import { onMounted } from "vue";
import { useScreenFull } from "fast-element-plus";

onMounted(() => useScreenFull.init());

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；浏览器不支持时不执行操作。

useScreenFull.dispose 响应式

释放此前初始化的全屏状态监听。

签名

dispose(): void;

示例

import { onUnmounted } from "vue";
import { useScreenFull } from "fast-element-plus";

onUnmounted(() => useScreenFull.dispose());

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

useScreenFull.toggle 响应式

在进入和退出全屏之间切换。

签名

toggle(): void;

示例

import { useScreenFull } from "fast-element-plus";

useScreenFull.toggle();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；不支持全屏时显示警告。

useScreenFull.full 响应式

请求进入全屏；已经全屏时保持不变。

签名

full(): void;

示例

import { useScreenFull } from "fast-element-plus";

useScreenFull.full();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；底层请求异步执行。

useScreenFull.exit 响应式

当前全屏时请求退出。

签名

exit(): void;

示例

import { useScreenFull } from "fast-element-plus";

useScreenFull.exit();

输入

该方法没有输入参数。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；底层退出异步执行。