# datocms-plugin-workflowtracker

> Visualise workflow progress more prominently in record editor

Latest version **0.1.2** (published 2021-12-15) · 0 weekly downloads

## Install

```sh
npm install datocms-plugin-workflowtracker
pnpm add datocms-plugin-workflowtracker
yarn add datocms-plugin-workflowtracker
bun add datocms-plugin-workflowtracker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2021-12-15 |
| First published | 2021-12-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | emile.swain |
| Keywords | workflow, datocms, blocks, field-addon, datocms-plugin |

## Links

- npm: https://www.npmjs.com/package/datocms-plugin-workflowtracker
- Homepage: https://github.com/emileswain/datocms-plugin-workflowtracker
- npm.io page: https://npm.io/package/datocms-plugin-workflowtracker

## Dependencies (12)

- [react](https://npm.io/package/react.md) ^17.0.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [nanoid](https://npm.io/package/nanoid.md) ^3.1.30
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [typescript](https://npm.io/package/typescript.md) ^4.5.2
- [@types/node](https://npm.io/package/@types/node.md) ^16.11.11
- [@types/react](https://npm.io/package/@types/react.md) ^17.0.37
- [react-scripts](https://npm.io/package/react-scripts.md) 4.0.3
- [datocms-client](https://npm.io/package/datocms-client.md) ^3.5.9
- [@types/react-dom](https://npm.io/package/@types/react-dom.md) ^17.0.11
- [datocms-react-ui](https://npm.io/package/datocms-react-ui.md) ^0.3.21
- [datocms-plugin-sdk](https://npm.io/package/datocms-plugin-sdk.md) ^0.3.20

## Recent versions

- 0.1.2 (latest) — 2021-12-15
- 0.1.1 — 2021-12-15
- 0.1.0 — 2021-12-15

## README

# Workflow Tracker plugin

## Note
This is still in development and has some workarounds applied (commented inline below).

## Introduction
This plugin provides a way of visualising the workflow status with a greater presence than the sidebar widget.

![](docs/record.png)


## Setup
To visualise the workflow associated with a record you just add a `text field` and set its id to `workflowfield`. The plugin will then automatically apply the custom editor to that field. 

If you for some reason have a field called this and don't want it to use this editor, then you'll have to fork the repo and edit the `overrideFieldExtensions` method in index.tsx.

You can name the field what ever you want to. The field ID must be `workflowfield`
![](docs/model.png)
![](docs/workflow_field.png)

(I'll see if there is an option to customise this somehow);


## Usage

Once you added the field the custom editor will then display the stages you've defined as a ButtonGroup. You can click the buttons to set the stage. When you do this, it should disable the buttons and display a spinner. It can take a couple of seconds for the update to be applied. 


## TODO
I haven't implemented any tests around permissions, so it may fail if you don't have access rules to either update the stage, or apply a specific stage. 

I'll see about adding this in.

---
_Source: https://npm.io/package/datocms-plugin-workflowtracker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
