Skip to content

API Reference

Detailed type contracts and function signatures for @erag/vue-toastification.

useToast()

A composable hook returning triggers for non-blocking notifications.

Function Signatures

  • success(message, title?, duration?, position?)
  • error(message, title?, duration?, position?)
  • warning(message, title?, duration?, position?)
  • info(message, title?, duration?, position?)
  • setPosition(position)
  • remove(id)

Argument Types

ParameterTypeDefaultDescription
messagestringRequiredMain body text.
titlestringOptionalBold header text.
durationnumber4500Expiration time in milliseconds. Pass 0 to disable automatic removal.
positionToastPositionGlobal ValueScreen placement for this individual toast.

useModal() / useConfirmation()

A composable hook returning controls for interactive confirm overlay dialogs.

confirm(options)

Returns a Promise<boolean> which resolves when the user interacts with the buttons.

typescript
const modal = useModal()
const confirmed: boolean = await modal.confirm(options)

ModalOptions Properties

PropertyTypeDefaultDescription
titlestringRequiredBold heading.
messagestringRequiredMain details copy.
confirmTextstring'Confirm'Action button label.
cancelTextstring'Cancel'Cancel button label.
type'info' | 'warning' | 'danger''info'Button variant coloring logic.

MIT License. Copyright Er Amit Gupta