Skip to main content

An Autocomplete edit handler for Pages, Snippets, and more.

Project description

https://circleci.com/gh/wagtail/wagtail-autocomplete.svg?style=svg

An edit handler for the Wagtail content editor allowing single or multi autocompleted selection of Pages, Snippets, or other models. The widget is written in React and can be used outside the Wagtail admin, if desired.

https://raw.githubusercontent.com/wagtail/wagtail-autocomplete/master/docs/_static/autocomplete-m2m-demo.gif

Features

  • Rapidly select related objects via a smooth autocomplete interface

  • A drop-in alternative to PageChooserPanel or SnippetChooserPanel

  • Create new objects from the autocomplete input if your search turns up blank

  • React component can be used outside of the Wagtail admin for public-facing forms

  • Default theme shares the color scheme and styles of the Wagtail admin

  • Easy to re-theme with BEM methodology

Who’s using it?

  • The U.S. Press Freedom Tracker makes extensive use of this edit handler with its public-facing filters and content editor to rapidly select and create new related metadata objects.

Merge into wagtail/wagtail

Eventually we would like this to be merged into wagtail/wagtail. This will require some work on the Wagtail API.

  • Support endpoints for non-Page models

  • Support standard Django field lookups such as id__in

  • Create objects from the API

  • Permission system for non-administrator access to the API

Documentation

Our documentation is on Read the Docs and includes basic usage instructions as well as contribution guidelines.

Contributors

  • Harris Lapiroff (Little Weaver Web Collective) for the UX and UI design

  • Rachel Stevens (Little Weaver Web Collective)

  • Emily Horsman (Little Weaver Web Collective)

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-autocomplete-0.11.0.tar.gz (62.3 kB view hashes)

Uploaded Source

Built Distribution

wagtail_autocomplete-0.11.0-py3-none-any.whl (66.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page