# @types/jquery-toastmessage-plugin

> TypeScript definitions for jquery-toastmessage-plugin

Latest version **0.2.9** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jquery-toastmessage-plugin
pnpm add @types/jquery-toastmessage-plugin
yarn add @types/jquery-toastmessage-plugin
bun add @types/jquery-toastmessage-plugin
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.9 |
| Published | 2023-11-07 |
| First published | 2017-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51419 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jquery-toastmessage-plugin
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery-toastmessage-plugin
- npm.io page: https://npm.io/package/@types/jquery-toastmessage-plugin

## Dependencies (1)

- [@types/jquery](https://npm.io/package/@types/jquery.md) *

## Recent versions

- 0.2.9 (latest) — 2023-11-07
- 0.2.6 (ts3.6) — 2021-07-08
- 0.2.5 (ts2.3) — 2019-02-14
- 0.2.2 (ts2.0) — 2017-03-31
- 0.2.8 — 2023-10-18
- 0.2.7 — 2023-09-15
- 0.2.4 — 2017-08-21
- 0.2.3 — 2017-06-15
- 0.2.1 — 2017-03-24
- 0.2.0 — 2017-03-11

## README

# Installation
> `npm install --save @types/jquery-toastmessage-plugin`

# Summary
This package contains type definitions for jquery-toastmessage-plugin (https://github.com/akquinet/jquery-toastmessage-plugin).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery-toastmessage-plugin.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jquery-toastmessage-plugin/index.d.ts)
````ts
/// <reference types="jquery" />

interface JQuery {
    toastmessage: JQueryToastmessage.ToastmessageStatic;
}

/** jQuery Toastmessage (http://akquinet.github.io/jquery-toastmessage-plugin/) */
declare namespace JQueryToastmessage {
    interface ToastmessageStatic {
        /* shows a toast message of the specified type */
        (command: ShowToastCommand, message: string): JQuery;
        /** shows a custom toast */
        (command: "showToast", toastOpts: ToastOptions): JQuery;
        /** removes the specified toast and returns it */
        (command: "removeToast", toast: JQuery, closeOpts?: ToastOptions): void;
        /** configures the default toast options */
        (toastOpts: ToastOptions): void;
    }

    type ShowToastCommand = "showNoticeToast" | "showSuccessToast" | "showWarningToast" | "showErrorToast";
    type ToastType = "notice" | "warning" | "error" | "success";
    type ToastPosition = "top-left" | "top-center" | "top-right" | "middle-left" | "middle-center" | "middle-right";

    interface ToastOptions {
        /** in effect duration in miliseconds @default 600 */
        inEffectDuration?: number | undefined;
        /**
         * time in miliseconds before the item has to disappear @default 3000
         */
        stayTime?: number | undefined;
        /** content of the item @default '' */
        text?: string | undefined;
        /** should the toast item sticky or not? @default false */
        sticky?: boolean | undefined;
        /** the type of toast @default 'notice' */
        type?: ToastType | undefined;
        /**
         * Position of the toast container holding different toast.
         * Position can be set only once at the very first call,
         * changing the position after the first call does nothing
         * @default 'top-right'
         */
        position?: ToastPosition | undefined;
        /**
         * text which will be shown as close button,
         * set to '' when you want to introduce an image via css
         * @default ''
         */
        closeText?: string | undefined;
        /** callback function when the toastmessage is closed @default null */
        close?(): void;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/jquery](https://npmjs.com/package/@types/jquery)

# Credits
These definitions were written by [Joe Skeen](https://github.com/joeskeen).

---
_Source: https://npm.io/package/@types/jquery-toastmessage-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._