Toast Message Component

The Toast component is mainly used for eye-catching prompt effects such as message notifications, loading prompts, and operation result notifications, providing a rich variety of APIs.

📌 Platform Differences

APP(vue)	H5	WeChat Mini Program	Alipay Mini Program
✔	✔	✔	✔

⚠️ Notes

Notes

• Since elements cannot be created via JS in uni, you need to include the toast component in the page and then open it via ref
• Use the useToast() hook function to create a toast instance, which supports global calls
• toast.loading() must be closed by manually calling toast.close(), otherwise it will not close automatically
• When duration is set to -1, it will not close automatically
• The icon property supports a boolean value (shows the default icon), a string (custom icon name), or an icon property object
• The component communicates via the global events __hy_toast_open__ and __hy_toast_close__
• It is recommended to add the <hy-toast></hy-toast> tag in the page root component

🏯 Basic Usage Example

<!-- Add the component in the page -->
<template>
    <view>
        <hy-toast></hy-toast>
        <!-- Other content -->
    </view>
</template>

import { useToast } from '@hy-app/ui';
import { onMounted } from 'vue';

const toast = useToast();

onMounted(() => {
    toast.success('Operation successful');
});

Multiple Prompt Types

// Default prompt (no icon)
toast.show('Default prompt message');

// Info prompt
toast.info('This is an info prompt');

// Success prompt
toast.success('Operation successful');

// Error prompt
toast.error('Operation failed');

// Warning prompt
toast.warning('Warning message');

// Primary color prompt
toast.primary('Important notice');

Loading Prompt

// Show loading prompt (default text "Loading...")
toast.loading();

// Custom loading text
toast.loading('Loading, please wait...');

// Automatically close after 5 seconds
setTimeout(() => {
    toast.close();
}, 5000);

Custom Configuration

// Custom display position
toast.success('Top prompt', { position: 'top' });
toast.success('Bottom prompt', { position: 'bottom' });
toast.success('Center prompt', { position: 'center' }); // Default

// Custom display duration
toast.info('Closes after 3 seconds', { duration: 3000 });

// No automatic closing
toast.info('Manual close', { duration: -1 });

// Show overlay (prevents touch-through)
toast.success('Prompt', { overlay: true });

// Hide overlay (allows touch-through)
toast.success('Prompt', { overlay: false });

// Custom icon (string: icon name)
toast.info('Custom icon', { icon: 'star' });

// Custom icon (object: can set size, color, etc.)
toast.info('Custom icon', {
    icon: { name: 'time', size: '24', color: '#2979ff' },
});

// Callback function
toast.success('Operation successful', {
    complete: () => {
        console.log('toast closed');
    },
});

Complete Example

<template>
    <view class="demo">
        <hy-toast></hy-toast>
        <hy-button text="Show success prompt" @click="showSuccess"></hy-button>
        <hy-button text="Show loading prompt" @click="showLoading"></hy-button>
    </view>
</template>

<script setup lang="ts">
    import { useToast } from '@hy-app/ui';

    const toast = useToast();

    const showSuccess = () => {
        toast.success('Operation successful', {
            duration: 2000,
            position: 'bottom',
            complete: () => {
                console.log('Prompt closed');
            },
        });
    };

    const showLoading = () => {
        toast.loading('Loading data...', { position: 'center' });

        // Simulate an async operation
        setTimeout(() => {
            toast.close();
            toast.success('Loading complete');
        }, 3000);
    };
</script>

API

Options

Parameter	Description	Type	Default
message	Text to display	string	-
type	Theme type	'error' | 'warning' | 'success' | 'primary' | 'info'	info
icon	Icon name or boolean (true shows the default icon)	string | boolean	false
loading	Whether in loading state	boolean	false
loadMode	Loading icon mode	'circle' | 'spinner' | 'semicircle'	circle
overlay	Whether to prevent touch-through	boolean	false
cover	Whether to show the overlay	boolean	false
position	Position where the toast appears	'top' | 'center' | 'bottom'	center
duration	Display duration (ms); no auto-close when set to -1	number	2000
complete	Callback function executed after completion	Function	-

Methods

Method	Description	Parameters
show	Show default toast (no icon)	message: string, options?: ToastOptions
info	Show info prompt (with icon)	message: string, options?: ToastOptions
success	Show success prompt (with icon)	message: string, options?: ToastOptions
error	Show error prompt (with icon)	message: string, options?: ToastOptions
warning	Show warning prompt (with icon)	message: string, options?: ToastOptions
primary	Show primary color prompt (with icon)	message: string, options?: ToastOptions
loading	Show loading prompt (requires manual close)	message?: string, options?: ToastOptions
close	Close all toasts	-

Typings

Type Description

/** Toast configuration options */
export interface ToastOptions {
    /** Text to display */
    message?: string;
    /** Theme type: primary, success, error, warning, info */
    type?: string;
    /** Position where the toast appears: top, center, bottom */
    position?: string;
    /** Icon to display (true shows the default icon, a string is a custom icon name, an object is icon property configuration) */
    icon?: boolean | string | { name: string; size?: string | number; color?: string };
    /** Whether to show the overlay (prevents touch-through) */
    overlay?: boolean;
    /** Whether in loading state */
    loading?: boolean;
    /** Loading icon mode: circle, spinner, semicircle */
    loadMode?: string;
    /** Display duration (ms); no auto-close when -1 */
    duration?: number;
    /** Callback function executed after completion */
    complete?: Function | null;
}

03:29