Hook

• useLoading shows or hides package-managed fullscreen loading.
• useOverlay shows or hides the page overlay with optional opacity.
• useScreenFull initializes/disposes fullscreen listeners and provides state, toggle, enter, and exit operations.

Hooks resolve browser globals when called; do not call them during SSR.

useLoading.show Reactive

Increments the active count and shows fullscreen loading.

Signature

show(): void;

Example

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

useLoading.show();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value.

useLoading.hide Reactive

Decrements the count; removes fullscreen loading after a delay when it reaches zero.

Signature

hide(): void;

Example

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

useLoading.hide();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value.

useOverlay.show Reactive

Increments the active count and shows the page overlay.

Signature

show(transparent?: number): void;

Example

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

useOverlay.show(0.35);

Input

Input	Type	Required / default	Description
transparent	number	Optional; defaults to 0	Overlay alpha used by CSS rgba.

Returns

Value	Type	Description
result	void	No return value.

useOverlay.hide Reactive

Decrements the count; removes the overlay at zero.

Signature

hide(): void;

Example

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

useOverlay.hide();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value.

useScreenFull.isFullscreen Reactive

Reads reactive fullscreen state.

Signature

isFullscreen(): boolean;

Example

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

const result = useScreenFull.isFullscreen();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	boolean	true while fullscreen is active.

useScreenFull.init Reactive

Initializes the Screenfull change listener once.

Signature

init(): void;

Example

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

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

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value; does nothing in unsupported browsers.

useScreenFull.dispose Reactive

Disposes the previously initialized fullscreen listener.

Signature

dispose(): void;

Example

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

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

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value.

useScreenFull.toggle Reactive

Toggles fullscreen.

Signature

toggle(): void;

Example

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

useScreenFull.toggle();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value; displays a warning if fullscreen is unsupported.

useScreenFull.full Reactive

Requests fullscreen; unchanged if already active.

Signature

full(): void;

Example

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

useScreenFull.full();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value; the underlying request runs asynchronously.

useScreenFull.exit Reactive

Requests exit when currently fullscreen.

Signature

exit(): void;

Example

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

useScreenFull.exit();

Input

This method has no input parameters.

Returns

Value	Type	Description
result	void	No return value; the underlying exit runs asynchronously.