Metadata-Version: 2.1
Name: django-messages-display
Version: 0.4.0
Summary: Display messages from django.contrib.messages as notifications in the browser.
Home-page: https://github.com/demestav/django-messages-display
Author: Demetris Stavrou
License: MIT
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENCE

# django-messages-display
Display messages from django.contrib.messages as notifications in the browser.

## Setup
Install package using `pip`:

```shell
python -m pip install django-messages-display
```

Add it to the installed apps:
```python
INSTALLED_APPS = [
    ...
    "django_messages_display",
    ...
]
```

## How to use
Include the package template in templates where notifications are needed. If site-wide notifications apply for the whole site, it is convenient to add it to the base template, if there is one.

```
{% include 'django_messages_display/django_messages_display.html' %}
```

Further, for the styling to apply, the CSS should be loaded:
```
{% load static %}
...
<head>
    ...
    <link rel="stylesheet" href="{% static 'django_messages_display/django_messages_display.css' %}">
</head>
```

## Accessibility
Notifications have the relevant attributes, so that the screen reader announces each one without interrupting the users' flow.
Even though visually the notifications disappear after a certain amount of time, they remain in the document in order to be accessible by the screen reader on demand.

The colors used for the notifications, meet the WCAG (2.1) AA contrast levels.
