Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/torchbox/wagtailquickcreate

Wagtail Quick Create offers shortcut links to create objects from models specified in your settings file.
https://github.com/torchbox/wagtailquickcreate

wagtail

Last synced: 2 months ago
JSON representation

Wagtail Quick Create offers shortcut links to create objects from models specified in your settings file.

Awesome Lists containing this project

README

        

# Wagtail Quick Create

## Wagtail Quick Create offers shortcut links to create objects from models specified in your settings file.

A panel is added to the admin home, offering a type:

![Quick Create Panel example](./docs/images/dashboard.png)

Clicking a create link will offer a parent selection for the new item

![Parent selection example](./docs/images/create.png)

## Note on parent pages

Wagtailquickcreate needs the [`parent_page_types`](http://docs.wagtail.io/en/v2.5.1/reference/pages/model_reference.html#wagtail.core.models.Page.parent_page_types) set on the model you wish to include so it can successfully provide the parent page selection. If this isn't specified, you will likely see every page offered as a parent, this will not work as it's looking up pages using `wagtail.core.models.Page` and this core wagtail class has `is_creatable = False`

### Configuration

Install using pip:

```bash
pip install wagtail-quick-create
```

After installing the module, add `wagtailquickcreate` to your installed apps in your settings file:

```python
INSTALLED_APPS = [
...
'wagtailquickcreate',
]
```

Also add the models you would like to create quick links for to your settings file as `'your_app_name.YourModelName'`:

EG:

```python
WAGTAIL_QUICK_CREATE_PAGE_TYPES = ['news.NewsPage', 'events.EventPage']
```

If you want the Quick Create links panel to _replace_ the wagtail summary panel, you can set this by adding the following to your settings

```python
WAGTAIL_QUICK_CREATE_REPLACE_SUMMARY_PANEL = True
```

If you would like to offer image and or document links, this can also be done by specifying the following in your settings:

```python
WAGTAIL_QUICK_CREATE_DOCUMENTS = True
WAGTAIL_QUICK_CREATE_IMAGES = True
```

## Contributing

We are happy to receive pull requests for bug fixes, improvements and new features. See [CONTRIBUTING.md](./docs/CONTRIBUTING.md) for more information.

## Credits/Authors

Concept created by Kate Statton - NYPR [@katestatton](https://twitter.com/katestatton)