Wagtail previews in headless mode.
Project description
Wagtail Headless Preview
Setup
Install using pip:
pip install wagtail-headless-preview
After installing the module, add wagtail_headless_preview to installed apps in your settings file:
# settings.py
INSTALLED_APPS = [
...
'wagtail_headless_preview',
]
then configure the preview client URL using the HEADLESS_PREVIEW_CLIENT_URLS setting.
For single site, the configuration should look like:
HEADLESS_PREVIEW_CLIENT_URLS = {
'default': 'http://localhost:8020/',
}
For a multi-site setup, add each site as a separate entry:
HEADLESS_PREVIEW_CLIENT_URLS = {
'default': 'http://localhost:8020/',
'site1.example.com': 'http://localhost:8020/',
'site2.example.com': 'http://localhost:8021/',
}
Usage
Add HeadlessPreviewMixin to your page class:
from wagtail_headless_preview.models import HeadlessPreviewMixin
class MyWonderfulPage(HeadlessPreviewMixin, Page):
pass
How do I access preview content?
It depends on your project.
For a quick test:
- Add
wagtail.api.v2to the installed apps:
# settings.py
INSTALLED_APPS = [
...
'wagtail.api.v2',
]
- Register the the API URLs so Django can route requests into the API:
# urls.py
from .api import api_router
urlpatterns = [
...
path('api/v2/', api_router.urls),
...
# Ensure that the api_router line appears above the default Wagtail page serving route
path('', include(wagtail_urls)),
]
- create an
api.pyfile in your project directory:
from django.contrib.contenttypes.models import ContentType
from wagtail.api.v2.endpoints import PagesAPIEndpoint
from wagtail.api.v2.router import WagtailAPIRouter
from wagtail_headless_preview.models import PagePreview
from rest_framework.response import Response
# Create the router. "wagtailapi" is the URL namespace
api_router = WagtailAPIRouter('wagtailapi')
class PagePreviewAPIEndpoint(PagesAPIEndpoint):
known_query_parameters = PagesAPIEndpoint.known_query_parameters.union(['content_type', 'token'])
def listing_view(self, request):
page = self.get_object()
serializer = self.get_serializer(page)
return Response(serializer.data)
def detail_view(self, request, pk):
page = self.get_object()
serializer = self.get_serializer(page)
return Response(serializer.data)
def get_object(self):
app_label, model = self.request.GET['content_type'].split('.')
content_type = ContentType.objects.get(app_label=app_label, model=model)
page_preview = PagePreview.objects.get(content_type=content_type, token=self.request.GET['token'])
page = page_preview.as_page()
if not page.pk:
# fake primary key to stop API URL routing from complaining
page.pk = 0
return page
api_router.register_endpoint('page_preview', PagePreviewAPIEndpoint)
For further details, refer to the Wagtail API v2 Configuration Guide
- Next, add a
client/index.htmlfile in your project root:
<!DOCTYPE html>
<html>
<head>
<script>
function go() {
var querystring = window.location.search.replace(/^\?/, '');
var params = {};
querystring.replace(/([^=&]+)=([^&]*)/g, function(m, key, value) {
params[decodeURIComponent(key)] = decodeURIComponent(value);
});
var apiUrl = 'http://localhost:8000/api/v2/page_preview/1/?content_type=' + encodeURIComponent(params['content_type']) + '&token=' + encodeURIComponent(params['token']) + '&format=json';
fetch(apiUrl).then(function(response) {
response.text().then(function(text) {
document.body.innerText = text;
});
});
}
</script>
</head>
<body onload="go()"></body>
</html>
- Install django-cors-headers:
pip install django-cors-headers - Add to your settings file
CORS_ORIGIN_ALLOW_ALL = True
CORS_URLS_REGEX = r'^/api/v2/'
- Start up your site as normal:
./manage.py runserver 0:8000 - Set up
client/index.htmlto be served athttp://localhost:8020/- this can be done by runningpython3 -m http.server 8020from inside the client directory - Edit (or created) and preview a page that uses
HeadlessPreviewMixin - The preview page should now show you the API response for the preview
Credits
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wagtail-headless-preview-0.0.3.tar.gz.
File metadata
- Download URL: wagtail-headless-preview-0.0.3.tar.gz
- Upload date:
- Size: 6.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e58b1e0d0eb48ac97ede2338b564683e2ec7527405debae296ead1e02b500dca |
|
| MD5 | 97112e58bd58c1d1690cbd6554e06dc1 |
|
| BLAKE2b-256 | af826e94652c668ab3f809066ce00f722a1c7afd287b6a55c80dfc9cfc3fa80a |
File details
Details for the file wagtail_headless_preview-0.0.3-py2-none-any.whl.
File metadata
- Download URL: wagtail_headless_preview-0.0.3-py2-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a10a061f74ba0d322de713dac3f1dc19b8e36e14137d84b7114c8277369911e7 |
|
| MD5 | 78e3d483023ce8d172c42570e811e3c6 |
|
| BLAKE2b-256 | 1d1e5a9a687b8bd959f1ca07a78389300b445b2d6061946481f7814a1239ff76 |
