Skip to main content

JavaScript powered frontend for Wagtail

Project description

Wagtail Shell

Wagtail Shell is an experimental frontend for Wagtail admin that converts it into a single-page-application and improvements to the left hand menu.

Features:

  • No page reloads for general navigation!
  • Left hand menu rewritten in React, with improved animations and a new collapsed mode
  • Support for views written for different frontend frameworks, such as Django admin
  • A new modal workflow UI that supports rendering any view in a modal

Coming soon:

  • Ability to write new API-driven views entirely in JavaScript (using React, Vue, or something else)

What does it look like?

Wagtail Shell Expanded Wagtail Shell Collapsed

Installation

Please note that this project is still very much experimental, is not very well tested, and is likely to change in backwards-incompatible ways without notice

But if you'd like help this project by being an early tester, here's how to install!

Install wagtail-shell with pip:

pip install wagtail-shell

Add it to INSTALLED_APPS:

# settings.py

INSTALLED_APPS = [
    # ...

    # Must be above wagtail.admin
    'wagtail_shell',

    # ...
]

Decorate all Wagtail admin URLs with shell_enable using Wagtail's decorate_urlpatterns helper:

# urls.py

from django.conf.urls import include, url
from wagtail.admin import urls as wagtailadmin_urls
from wagtail.utils.urlpatterns import decorate_urlpatterns
from wagtail_shell.decorators import shell_enable


urlpatterns = decorate_urlpatterns([
    # All URLs that you want to use the Wagtail menu on go here
    # You can also add Django admin or custom views here if you want to!
    url(r'^admin/', include(wagtailadmin_urls)),
], shell_enable) + [
    # All other URLs here
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail-shell-0.1.0.tar.gz (3.3 MB view hashes)

Uploaded source

Built Distribution

wagtail_shell-0.1.0-py3-none-any.whl (3.3 MB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page