https://github.com/wagtail/wagtail-autocomplete

An Autocomplete edit handler for selecting Pages, Snippets, and more.
https://github.com/wagtail/wagtail-autocomplete

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/wagtail/wagtail-autocomplete
• Owner: wagtail
• License: bsd-3-clause
• Created: 2017-08-16T17:36:56.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T16:18:49.000Z (3 months ago)
• Last Synced: 2024-06-24T18:15:08.261Z (3 months ago)
• Language: Python
• Homepage: https://wagtail-autocomplete.readthedocs.io/
• Size: 1.76 MB
• Stars: 118
• Watchers: 11
• Forks: 53
• Open Issues: 44
• Metadata Files:
  • Readme: README.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-wagtail - wagtail-autocomplete - Autocompleting choosers for `ForeignKey`, `ParentalKey`, and `ManyToMany` fields. (Apps / Widgets)

README

        
Wagtail Autocomplete

====================

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

    :target: https://circleci.com/gh/wagtail/wagtail-autocomplete

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.

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

Join the Community at Wagtail Space!

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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 `_ 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)