Metadata-Version: 2.1
Name: locale_selector
Version: 1.0.2
Summary: An application made for the Django Web Framework.
Home-page: https://github.com/Nigel2392/locale_selector
Author: Nigel
Author-email: nigel@goodadvice.it
License: GPL-3.0-only
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
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.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=4.2
Requires-Dist: Wagtail>=5.0

locale_selector
================

A simple language selector pop-up modal for Django/Wagtail.

Has 2 integrated backends for wagtail-localize translate page subtree tasks.
 - `locale_selector.jobs.ThreadedBackend`
 - `locale_selector.tasks.CeleryBackend`

Quick start
-----------

1. Add 'locale_selector' to your INSTALLED_APPS setting like this:

```
INSTALLED_APPS = [
   ...,
   'locale_selector',
]
```

2. Add the following staticfiles accordingly:
```sh
locale_selector/css/locale_selector.css
locale_selector/js/locale_selector.js
```

3. Use the templatetag in your base.html:
```html
{% load locale_selector %}
...

{# maintainer        Which maintainer do you want to display      #}
{# maintainer_site   Which maintainer site do you want to display #}
{# current_flag      Show the flag for the current language       #}
{# modal             Show a modal or banner                       #}
{# sticky            Make the modal/banner open/close button sticky in the document #}

{% locale_selector current_flag=True modal=False sticky=True %}
```
