{"id":17473743,"url":"https://github.com/dennissnijder/payload-workflow","last_synced_at":"2025-08-22T00:31:03.714Z","repository":{"id":178006433,"uuid":"660795685","full_name":"DennisSnijder/payload-workflow","owner":"DennisSnijder","description":"A workflow plugin for Payload CMS","archived":false,"fork":false,"pushed_at":"2024-03-05T15:10:20.000Z","size":2783,"stargazers_count":68,"open_issues_count":5,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-18T20:46:14.076Z","etag":null,"topics":["payload-plugin","payloadcms","workflow-tool"],"latest_commit_sha":null,"homepage":"https://github.com/DennisSnijder/payload-workflow","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DennisSnijder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-30T21:46:29.000Z","updated_at":"2024-09-24T14:58:23.000Z","dependencies_parsed_at":"2024-10-31T17:07:22.607Z","dependency_job_id":"3786f580-4678-412f-a734-da82a45e95cd","html_url":"https://github.com/DennisSnijder/payload-workflow","commit_stats":{"total_commits":24,"total_committers":1,"mean_commits":24.0,"dds":0.0,"last_synced_commit":"572e840ac4faf07a1890429e4e58e6386462b5ab"},"previous_names":["dennissnijder/payload-workflow"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DennisSnijder%2Fpayload-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DennisSnijder%2Fpayload-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DennisSnijder%2Fpayload-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DennisSnijder%2Fpayload-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DennisSnijder","download_url":"https://codeload.github.com/DennisSnijder/payload-workflow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230542288,"owners_count":18242332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["payload-plugin","payloadcms","workflow-tool"],"created_at":"2024-10-18T18:06:52.925Z","updated_at":"2024-12-20T06:06:27.651Z","avatar_url":"https://github.com/DennisSnijder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Payload workflow plugin\n\n\u003e **Note**\n\u003e This plugin is currently under active development and still in an early stage.\n\u003e Check the [roadmap](#roadmap) below in this readme for more details / upcoming features.\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" src=\"./preview-dark.png\" /\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" src=\"./preview-light.png\" /\u003e\n  \u003cimg alt=\"Shows an image illustrating the payload-workflow plugin\" src=\"./preview-dark.png\"\u003e\n\u003c/picture\u003e\n\n## Installation\nThe most recent version of payload-workflow currently only supports Payload 2.0 and up. \nFor older payload versions, please use `payload-workflow@0.2.0`\n\n```shell\n$ yarn add payload-workflow\n```\n\n## Basic usage\n\n```typescript\nimport { payloadWorkflow } from 'payload-workflow';\n\nconst config = buildConfig({\n  collections: [ ... ],\n  plugins: [\n    payloadWorkflow({\n      'my-collection-slug': {\n        statuses: [\n          {value: 'draft', label: 'Draft'},\n          {value: 'in-progress', label: 'In Progress'},\n          {value: 'ready-for-review', label: 'Ready for review'},\n          {value: 'published', label: 'Published'},\n        ],\n        defaultStatus: 'draft',\n        hideNoStatusColumn: false\n      }\n    })\n  ],\n});\n```\n\n## Differences with the draft/publish system of Payload.\n\nThe workflow plugin introduces a new field called `workflowStatus`. This field does not interact with the draft/publish\nsystem of Payload.\n\nYou can \"integrate\" the workflow status with the draft/publish system of Payload yourself by\nusing [Payloads hooks](https://payloadcms.com/docs/hooks/overview).\n\nFor example: Automatically publish the document when the `workflowStatus` has been changed to `published`.\n\n\u003ch2 id=\"roadmap\"\u003eRoadmap\u003c/h2\u003e\nUpcoming Features / Ideas. Have a suggestion for the plugin? Feel free to open an issue or contribute!\n\n- [X] Payload 2.0 support\n- [ ] Customize card properties (currently displays `title` and `createdAt`)\n- [ ] Edit relationships directly from the card (e.g., assigning users to a document)\n- [X] Toggleable column for posts without a workflow status (Currently, documents lacking `workflowStatus` aren't\n  visible on the board)\n- [ ] Lazy loading of column contents when scrolling (Currently, board only shows `defaultLimit` amount of cards)\n- [ ] Permissions for changing statuses\n- [ ] Allowed transitions between statuses\n- [ ] Integration with the draft/publish system of Payload (?)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdennissnijder%2Fpayload-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdennissnijder%2Fpayload-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdennissnijder%2Fpayload-workflow/lists"}