Files
TweakDrag/README.md
2026-07-01 09:50:16 -03:00

50 lines
2.2 KiB
Markdown

# TweakDrag -- board drag, touch and column-gap tweaks
A Kanboard plugin that groups board dragging and spacing tweaks. This first version
provides two options, both configurable under "Settings -> Tweak Drag":
- **Drag the board background to scroll** (desktop) -- click and drag on the empty board
background to scroll the columns sideways, like the Trello board canvas.
- **Widen the gap between columns** -- spread the columns further apart, easier to tell
apart and to touch.
These options were originally part of the ShrinkVertically plugin and moved here so that
drag/touch behaviour can grow on its own (planned: mobile drag-to-move cards, and a drag
movement threshold so ending a drag does not open the task) without bloating that plugin.
## How it works
- **Drag to scroll**: a small script (`Asset/js/drag-scroll.js`, loaded only when the
option is on) starts a horizontal pan on `#board-container` only when the press lands on
empty background -- pressing a task card, a drag handle or any control is ignored, so
Kanboard's own card and column drag-and-drop keep working unchanged.
- **Column gap**: the board is a table, so the gap is set with `border-spacing` (injected
in the page head from `Template/layout/variable.php` only when the option is on), sized
by the `--td-column-gap` CSS variable. This spreads the columns without shrinking the
cards and keeps each column header aligned with its list. It also adds some spacing at
the left and right edges of the board.
## Requirements
- Kanboard >= 1.2.0
## Installation
Copy this folder into your Kanboard installation as `plugins/TweakDrag/`. The directory
name must be exactly `TweakDrag` (Kanboard derives the plugin namespace from the folder
name). No build step and no database migration.
## Settings
These settings are global (per Kanboard instance) and admin-only. Go to
"Settings -> Tweak Drag":
- **Column gap in pixels** -- width of the column gap (`--td-column-gap`). Default: 25.
- **Widen the gap between columns** -- toggles the wider gap. Default: on.
- **Drag the board background to scroll horizontally** -- toggles the Trello-style
click-and-drag panning. Desktop (mouse) for now. Default: on.
## License
AGPL-3.0. See LICENSE.