Skip to content

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 ​

ts
show(): void;

Example ​

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

useLoading.show();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value.

useLoading.hide Reactive ​

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

Signature ​

ts
hide(): void;

Example ​

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

useLoading.hide();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value.

useOverlay.show Reactive ​

Increments the active count and shows the page overlay.

Signature ​

ts
show(transparent?: number): void;

Example ​

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

useOverlay.show(0.35);

Input ​

InputTypeRequired / defaultDescription
transparentnumberOptional; defaults to 0Overlay alpha used by CSS rgba.

Returns ​

ValueTypeDescription
resultvoidNo return value.

useOverlay.hide Reactive ​

Decrements the count; removes the overlay at zero.

Signature ​

ts
hide(): void;

Example ​

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

useOverlay.hide();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value.

useScreenFull.isFullscreen Reactive ​

Reads reactive fullscreen state.

Signature ​

ts
isFullscreen(): boolean;

Example ​

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

const result = useScreenFull.isFullscreen();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultbooleantrue while fullscreen is active.

useScreenFull.init Reactive ​

Initializes the Screenfull change listener once.

Signature ​

ts
init(): void;

Example ​

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

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

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value; does nothing in unsupported browsers.

useScreenFull.dispose Reactive ​

Disposes the previously initialized fullscreen listener.

Signature ​

ts
dispose(): void;

Example ​

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

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

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value.

useScreenFull.toggle Reactive ​

Toggles fullscreen.

Signature ​

ts
toggle(): void;

Example ​

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

useScreenFull.toggle();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value; displays a warning if fullscreen is unsupported.

useScreenFull.full Reactive ​

Requests fullscreen; unchanged if already active.

Signature ​

ts
full(): void;

Example ​

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

useScreenFull.full();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value; the underlying request runs asynchronously.

useScreenFull.exit Reactive ​

Requests exit when currently fullscreen.

Signature ​

ts
exit(): void;

Example ​

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

useScreenFull.exit();

Input ​

This method has no input parameters.

Returns ​

ValueTypeDescription
resultvoidNo return value; the underlying exit runs asynchronously.