Kanban macro

Last modified by slauriere on 2026/06/11 19:41

cogDisplays a Kanban view of AppWithinMinutes data.
TypeXAR
CategoryMacro
Developed by

Anca Luca, Ludovic Dubost, slauriere, Alexandru Brassat

Support
Active Installs103
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Success

Installable with the Extension Manager

Description

Displays a Kanban view from JSON or from AWM data:

Kanban from JSON

{{kanban width="30%" source="" updateService="" addBoardButton="true" addItemButton="true" removeBoardButton="true" removeBoardItem="true"}}
[
 {"id":"todo","title":"To Do","color":"red","item":[{"title":"Item 2"},{"title":"Item 1"}]},
 {"id":"working","title":"Working","color":"blue","item":[{"title":"Hello"},{"title":"Item 4"},{"title":"Item 6"}]},
 {"id":"done","title":"Done","color":"green","item":[{"title":"Item 5b"},{"title":"Item 5"}]}
]
{{/kanban}}

Additional parameters:

  • width width of each column in the kanban (default 30%)
  • source URL source of the Kanban data in JSON
  • updateService URL to update the Kanban data
  • addBoardButton display the add Board button (default true)
  • addItemButton display the add Item button (default true)
  • removeBoardButton display the remove Board button (default true)
  • addRemoveButton allow removing Item by drag and dropping them out of a board (default true; for non-JSON kanban sources, requires the implementation of a custom updateService page)

Example:

Kanban from AppWithinMinutes

{{awmkanban app="Help.Applications.Movies" category="databaseList1" columns="staticList1,boolean1" xwql="obj.boolean1=0" /}}

  • app or className - application or className for which to build the kanban board
  • category - class field used to group the kanban board into columns
  • displayedCategoryColumns - only display these values of the `category` field as columns
  • xwql - additional xwql to restrict the query
  • title - field to display the title
  • columns - the class fields to display as a description in each card
  • order - order to sort the data by. Example: 'doc.name desc', 'doc.date desc', 'customClassField1 asc, customClassField2 desc, doc.name desc' or 'customClassField1 asc' if the className object contains such custom fields
  • limit - the maximum amount of items to show. If the displayedCategoryColumns parameter is set, the limit is applied for each column.

Example:

awmkanban.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Versions

Get Connected