Skip to content

Kanban Reference

Reference documentation for the Plutonium kanban board feature.

In this section

PageWhat it covers
DSLComplete kanban do…end DSL — board options, columns, column actions, static vs. dynamic, lazy loading, realtime
PositioningPlutonium::Positioning concern, positioned_on, position_on modes, reposition!, rebalancing
Authorizationkanban_move? policy predicate, read-only fallback, separating move rights from edit rights

Quick start

ruby
# app/definitions/task_definition.rb
class TaskDefinition < ResourceDefinition
  kanban do
    per_column 25

    column :todo,
      scope:   -> { where(status: "todo") },
      on_enter: ->(r) { r.update!(status: "todo") },
      role: :backlog

    column :doing,
      scope:   -> { where(status: "doing") },
      on_enter: ->(r) { r.update!(status: "doing") },
      wip: 3

    column :done,
      scope:   -> { where(status: "done") },
      on_enter: :mark_done!,
      accepts: [:doing],
      role: :done
  end
end

See the Kanban guide for a full walkthrough including model setup and migrations.

Released under the MIT License.