Using the Checklist Editor

Issue Checklist for Jira is now Checklists for Jira. New name, same great app. Please go here to see our new documentation site.

Using the Checklist Editor

The editor allows you to quickly make changes to multiple items at once. It is also a convenient way to add rich formatting to checklist items using Markdown.

Editor vs. Checklist Text Custom Field

The Editor and the Checklist Text field function similarly with important difference.

If the Allow multiple checklists per work item global setting is enabled then a work item can have more than local one checklists. The Checklist Text field will hold the content of all the local checklists on the work item. Therefore, the formatting of the Checklist Text field contains the name of the checklist.

In contrast, the checklist editor is associate with an individual checklist on the work item, and does not show the name of the checklist.

Opening the Editor

To open the checklist editor, click the pencil button located in the top-right corner of the Checklist panel.

The contents will reflect the checklist.

Copying / Pasting Checklist

The Editor allows you to instantly create and reformat a checklist from a bullet list in an external sources (Word, Trello, OSX Notes, web page, etc.). Simply copy the list to the clipboard, open the Editor and paste.

You can also paste in plain text and format it using the instructions below.

Delete Multiple Items

You can quickly delete multiple items, or all items in a checklist, by opening the editor, selecting all items, then deleting.

Formatting in the Editor

Saving the editor's content overwrites the entire checklist for the given work item. Any changes made in other tabs will be lost.

Editor Toolbar

Checklist items can be formatted using the Editor Toolbar or by using the text formatting described below. Functions available via the toolbar include:

  • Bold text

  • Italic text

  • Strikethrough text

  • Inline code

  • Links

  • Toggle item complete

  • Make item optional/mandatory

  • Create description

  • Create header/separator

  • Mention user

  • Insert date

  • Insert emoji

 

 

Checklist Formatting

Special Elements

Text Formatting

Formatting

 

Escaping Markdown