Metadata-Version: 2.4
Name: dash-message-notification-plugin
Version: 0.1.0
Summary: A plugin to feedback by message or notification for Dash applications using Dash Hooks.
Home-page: https://github.com/luojiaaoo/dash-message-notification-plugin
Author: luojiaaoo
Author-email: 675925864@qq.com
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dash>=3.1.1
Requires-Dist: feffery-antd-components
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# dash-message-notification-plugin

[![GitHub](https://shields.io/badge/license-MIT-informational)](https://github.com/luojiaaoo/dash-message-notification-plugin/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/dash-message-notification-plugin.svg?color=dark-green)](https://pypi.org/project/dash-message-notification-plugin/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

English | [简体中文](./README-zh_CN.md)

A plugin to feedback by message or notification for Dash applications using Dash Hooks.. This plugin make feedback by message or notification easily.

## Installation

```bash
pip install dash-message-notification-plugin
```

## Usage

```python
import dash

# Import the message notification plugin
from dash_message_notification_plugin import (
    setup_message_notification_plugin,
    UtilMessage,
    UtilNotification,
)

# Enable the message notification plugin for the current app
setup_message_notification_plugin()

app = dash.Dash(__name__)

# Rest of your app code...
```

## Example

Run the included example:

```bash
python example.py
```

## API Reference

### 1. Activate Plugin

 `setup_message_notification_plugin()`

### 2. Using api in callback

`Please refer to the example.py`
