wagtail/wagtail-autocomplete

Join us at Wagtail Space US this year! The Call for Participation and Registration for both Wagtail Space 2024 events is open. We would love to have you give a talk, or just us as an attendee in June.

* [Wagtail Space NL](https://nl.wagtail.space/), Arnhem, The Netherlands. 2024-06-14
* [Wagtail Space US](https://us.wagtail.space/), Philadelphia, PA. 2024-06-20 to 2024-06-22

Features
~~~~~~~~

* Rapidly select related objects via a smooth autocomplete interface
* A drop-in alternative to ``FieldPanel``
* 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 <http://getbem.com/>`_ methodology

Who’s using it?
~~~~~~~~~~~~~~~

* The `U.S. Press Freedom Tracker <https://pressfreedomtracker.us/>`_ 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 <https://github.com/wagtail/wagtail/>`_.
This will require some work on the Wagtail API.

* Support endpoints for non-``Page`` models
* Support standard `Django field lookups <https://docs.djangoproject.com/en/1.11/ref/models/querysets/#id4>`_ 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 <https://wagtail-autocomplete.readthedocs.io/>`_ and includes `basic usage instructions <https://wagtail-autocomplete.readthedocs.io/en/latest/basic_usage.html>`_ as well as `contribution guidelines <https://wagtail-autocomplete.readthedocs.io/en/latest/contributing.html>`_.

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)