Payload Workflow
|Updated:
6 Jan 2024
|87 Stars
A workflow plugin for Payload CMS
Categories
Overview
The Payload Workflow plugin is currently under active development and is in the early stages. It introduces a new field called workflowStatus, which interacts separately from the draft/publish system of Payload. However, it is possible to integrate the workflow status with the draft/publish system using Payload’s hooks. This plugin currently supports Payload 2.0 and up.
Features
- Payload 2.0 support: The plugin is compatible with Payload 2.0 and newer versions.
- Customize card properties: It allows you to customize the properties displayed on the card, such as title and createdAt.
- Edit relationships directly from the card: Users can assign relationships, such as assigning users to a document, directly from the card.
- Toggleable column for posts without a workflow status: Documents lacking the workflowStatus field are not visible on the board, but this can be toggled.
- Lazy loading of column contents when scrolling: Currently, the board only shows a default limit amount of cards, but lazy loading can be implemented to load more cards when scrolling.
- Permissions for changing statuses: Allows for setting permissions for changing statuses, providing control over who can change the workflow status.
- Allowed transitions between statuses: Defines the allowed transitions between different workflow statuses.
- Integration with the draft/publish system of Payload: This feature is currently marked as uncertain and requires further investigation.
Installation
To install the Payload Workflow plugin, follow these steps:
- Make sure you have Payload 2.0 or a newer version installed.
- If you have an older version of Payload, use payload-workflow@0.2.0.
- Add the plugin to your Payload project.
- Configure the plugin settings, including any required customization or permissions.
Summary
The Payload Workflow plugin offers enhanced workflow management features for Payload. It introduces a dedicated workflowStatus field and provides additional customization options for cards. While still in the early stages of development, the plugin already supports Payload 2.0 and offers several key features for managing documents within your project.
