vue-sileo

A Vue 3 port of sileo by @hiaaryan. All credit for the design and animations goes to the original library.

🚀 View Demo

Installation

# npm
npm install vue-sileo

# pnpm
pnpm add vue-sileo

# yarn
yarn add vue-sileo

Usage

<script setup lang="ts">
import { Toaster, sileo } from "vue-sileo";
import "vue-sileo/styles.css";

function notify() {
  sileo.success({
    title: "Success",
    description: "Your changes have been saved.",
  });
}
</script>

<template>
  <Toaster position="top-right" />
  <button @click="notify">Save</button>
</template>

API

Toast Types

sileo.success({ title: "Success", description: "Operation completed" });
sileo.error({ title: "Error", description: "Something went wrong" });
sileo.warning({ title: "Warning", description: "Please confirm" });
sileo.info({ title: "Info", description: "New version available" });
sileo.action({ 
  title: "Update", 
  description: "Click to install",
  button: { title: "Install", onClick: () => {} }
});

Promise Handling

sileo.promise(
  fetchData(),
  {
    loading: { title: "Loading..." },
    success: (data) => ({ title: "Done", description: data }),
    error: (err) => ({ title: "Failed", description: err.message }),
  }
);

Configuration

<Toaster
  position="top-right"
  :offset="16"
  :max-visible-toasts="3"
  :options="{ duration: 5000, roundness: 18 }"
/>

Positions: top-left, top-center, top-right, bottom-left, bottom-center, bottom-right

Options

{
  title?: string;
  description?: string;
  position?: SileoPosition;
  duration?: number | null;      // milliseconds, null = infinite
  fill?: string;                 // background color
  roundness?: number;            // border radius
  autopilot?: boolean;           // auto expand/collapse
  descriptionAlign?: "left" | "center" | "right";  // default: "left"
  closable?: boolean;              // show dismiss button (default: true)
  button?: { title: string; onClick: () => void };
}

Toaster Props

Credits

This is a Vue 3 port of sileo by @hiaaryan. Check out the original library and documentation.

License

MIT