drag-scroll checkbox VERSION 1.1

Asset/css/shrink-vertically.css

@@ -0,0 +1,71 @@
+/*
+ * ShrinkVertically -- keep the board's horizontal scrollbar visible when columns
+ * are vertically collapsed (gear menu "collapse vertically" / shortcut, which sets
+ * localStorage vertical_scroll=0 and adds the class .board-task-list-compact).
+ *
+ * Kanboard core sets:  .board-task-list-compact { max-height: 90vh; }
+ * That 90vh is measured from the top of the viewport and ignores the page header
+ * above the board, so column + header together exceed the viewport and push the
+ * horizontal scrollbar below the fold.
+ *
+ * We instead reserve a fixed pixel budget for the chrome above and below the task
+ * list (page header + board column header + the horizontal scrollbar + a little
+ * breathing room). A fixed-px budget is more reliable than a proportional vh value
+ * because that chrome is a fixed height regardless of screen size.
+ *
+ * The pixel budget is the --sv-shrink-offset CSS variable. It is injected in the
+ * page head from the plugin setting (Settings -> Shrink Vertically); when unset it
+ * falls back to 240px below. Increase it if the scrollbar is still clipped, or
+ * decrease it to make the columns taller.
+ *
+ * The selector is intentionally more specific than core's single-class rule, and
+ * uses !important, so this override wins even alongside a theme (e.g. Essential).
+ *
+ * The min-height override is essential: Kanboard's drag-and-drop sets an INLINE
+ * min-height on each column equal to its full content height
+ * (BoardDragAndDrop.js: css("min-height", parent().height())). In CSS, min-height
+ * beats max-height, so that inline value keeps tall columns from shrinking and our
+ * max-height alone does nothing. A stylesheet !important overrides the inline
+ * (non-important) min-height, so we reset it to 0 and let max-height win.
+ */
+#board td .board-task-list.board-task-list-compact {
+    max-height: calc(100vh - var(--sv-shrink-offset, 240px)) !important;
+    min-height: 0 !important;
+}
+
+/*
+ * Optional top horizontal scrollbar (added by Asset/js/top-scrollbar.js when the
+ * "Add a top horizontal scrollbar" setting is enabled). The inner element is given a
+ * width equal to the board's scrollable width by the script; overflow-x: auto then
+ * produces a scrollbar whose range mirrors the board's own bottom scrollbar. The 1px
+ * inner height keeps the bar to just the scrollbar itself.
+ */
+.sv-top-scroll {
+    overflow-x: auto;
+    overflow-y: hidden;
+}
+
+.sv-top-scroll-inner {
+    height: 1px;
+}
+
+/*
+ * Click-and-drag horizontal scrolling (added by Asset/js/drag-scroll.js when the
+ * "Drag the board background to scroll" setting is enabled). The .sv-drag-scroll class
+ * is set on #board-container by the script, so these rules are inert when disabled.
+ * A grab cursor advertises the empty background; cards keep the normal cursor since
+ * pressing them does a card drag, not a pan.
+ */
+#board-container.sv-drag-scroll {
+    cursor: grab;
+}
+
+#board-container.sv-drag-scroll .task-board {
+    cursor: default;
+}
+
+.sv-grabbing,
+.sv-grabbing * {
+    cursor: grabbing !important;
+    user-select: none !important;
+}

Asset/css/skeleton.css

@@ -1 +0,0 @@
-/* Skeleton plugin styles -- add CSS here. Loaded via template:layout:css. */

Asset/js/drag-scroll.js

@@ -0,0 +1,75 @@
+/*
+ * ShrinkVertically -- optional click-and-drag horizontal scrolling of the board.
+ *
+ * Like the Trello board canvas: press the empty board background and drag left/right
+ * to scroll #board-container horizontally. The pan only starts on empty background --
+ * pressing a task card, a drag handle, or any interactive control is ignored, so this
+ * never interferes with Kanboard's own card and column drag-and-drop.
+ *
+ * Loaded only when the "Drag the board background to scroll" setting is enabled.
+ */
+(function () {
+    "use strict";
+
+    // Pressing any of these (or their descendants) must NOT start a background pan.
+    var IGNORE = "a, button, input, textarea, select, label, " +
+        ".task-board, [data-task-id], .task-board-sort-handle, " +
+        ".draggable-row-handle, .dropdown, .ui-sortable-handle";
+
+    function isIgnored(el) {
+        return !!(el && el.closest && el.closest(IGNORE));
+    }
+
+    function init() {
+        var container = document.getElementById("board-container");
+
+        if (!container || container.getAttribute("data-sv-drag") === "1") {
+            return;
+        }
+
+        container.setAttribute("data-sv-drag", "1");
+        container.classList.add("sv-drag-scroll");
+
+        var dragging = false;
+        var startX = 0;
+        var startScrollLeft = 0;
+
+        container.addEventListener("mousedown", function (e) {
+            // Left button only, and only on empty board background.
+            if (e.button !== 0 || isIgnored(e.target)) {
+                return;
+            }
+
+            dragging = true;
+            startX = e.clientX;
+            startScrollLeft = container.scrollLeft;
+            container.classList.add("sv-grabbing");
+            e.preventDefault();
+        });
+
+        document.addEventListener("mousemove", function (e) {
+            if (!dragging) {
+                return;
+            }
+            container.scrollLeft = startScrollLeft - (e.clientX - startX);
+            e.preventDefault();
+        });
+
+        function stop() {
+            if (!dragging) {
+                return;
+            }
+            dragging = false;
+            container.classList.remove("sv-grabbing");
+        }
+
+        document.addEventListener("mouseup", stop);
+        document.addEventListener("mouseleave", stop);
+    }
+
+    if (document.readyState === "loading") {
+        document.addEventListener("DOMContentLoaded", init);
+    } else {
+        init();
+    }
+})();

Asset/js/shrink-vertically.js

@@ -0,0 +1,34 @@
+/*
+ * ShrinkVertically -- mark the two vertical-collapse menu items so it is obvious the
+ * behaviour comes from this plugin and not from Kanboard core.
+ *
+ * Core renders these labels in app/Template/project_header/dropdown.php:
+ *   .filter-vert-collapse .filter-vert-toggle-collapse  ->  "Collapse vertically"
+ *   .filter-vert-expand   .filter-vert-toggle-collapse  ->  "Expand vertically"
+ *
+ * We append a "+" to each so they read "Collapse vertically+" / "Expand vertically+".
+ * This is locale-independent (it edits the rendered text, not the translation table).
+ */
+(function () {
+    "use strict";
+
+    function addPlus() {
+        var links = document.querySelectorAll(
+            ".filter-vert-collapse .filter-vert-toggle-collapse, " +
+            ".filter-vert-expand .filter-vert-toggle-collapse"
+        );
+
+        for (var i = 0; i < links.length; i++) {
+            var text = links[i].textContent;
+            if (text.charAt(text.length - 1) !== "+") {
+                links[i].textContent = text + "+";
+            }
+        }
+    }
+
+    if (document.readyState === "loading") {
+        document.addEventListener("DOMContentLoaded", addPlus);
+    } else {
+        addPlus();
+    }
+})();

Asset/js/skeleton.js

@@ -1 +0,0 @@
-// Skeleton plugin script -- add JS here. Loaded via template:layout:js.

Asset/js/top-scrollbar.js

@@ -0,0 +1,68 @@
+/*
+ * ShrinkVertically -- optional horizontal scrollbar above the board.
+ *
+ * Kanboard's board scrolls horizontally inside #board-container (overflow-x: auto),
+ * so the only horizontal scrollbar sits at the very bottom of the board. On a wide
+ * board you have to scroll all the way down to reach it. This adds a second, mirrored
+ * scrollbar just above the columns and keeps the two scroll positions in sync.
+ *
+ * Loaded only when the "Add a top horizontal scrollbar" setting is enabled.
+ */
+(function () {
+    "use strict";
+
+    function init() {
+        var container = document.getElementById("board-container");
+
+        // Only on the board, and never add it twice.
+        if (!container || document.querySelector(".sv-top-scroll")) {
+            return;
+        }
+
+        var bar = document.createElement("div");
+        bar.className = "sv-top-scroll";
+
+        var inner = document.createElement("div");
+        inner.className = "sv-top-scroll-inner";
+        bar.appendChild(inner);
+
+        container.parentNode.insertBefore(bar, container);
+
+        function sync() {
+            // Match the dummy bar's content width to the board's scrollable width
+            // so its scrollbar has the same range as the board's own scrollbar.
+            inner.style.width = container.scrollWidth + "px";
+        }
+
+        var lock = false;
+
+        bar.addEventListener("scroll", function () {
+            if (lock) { return; }
+            lock = true;
+            container.scrollLeft = bar.scrollLeft;
+            lock = false;
+        });
+
+        container.addEventListener("scroll", function () {
+            if (lock) { return; }
+            lock = true;
+            bar.scrollLeft = container.scrollLeft;
+            lock = false;
+        });
+
+        window.addEventListener("resize", sync);
+
+        // The board can be redrawn by the AJAX polling/refresh; keep the width current.
+        if (window.MutationObserver) {
+            new MutationObserver(sync).observe(container, { childList: true, subtree: true });
+        }
+
+        sync();
+    }
+
+    if (document.readyState === "loading") {
+        document.addEventListener("DOMContentLoaded", init);
+    } else {
+        init();
+    }
+})();

Controller/ConfigController.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Kanboard\Plugin\ShrinkVertically\Controller;
+
+use Kanboard\Controller\BaseController;
+
+/**
+ * Settings page for the ShrinkVertically plugin: configure how many pixels are
+ * reserved around the vertically collapsed board columns.
+ */
+class ConfigController extends BaseController
+{
+    const DEFAULT_OFFSET = 240;
+    const MIN_OFFSET = 0;
+    const MAX_OFFSET = 2000;
+
+    public function show()
+    {
+        $offset = (int) $this->configModel->get('shrink_vertically_offset', self::DEFAULT_OFFSET);
+        $topScrollbar = (int) $this->configModel->get('shrink_vertically_top_scrollbar', 0);
+        $dragScroll = (int) $this->configModel->get('shrink_vertically_drag_scroll', 0);
+
+        $this->response->html($this->helper->layout->config('shrinkVertically:config/show', array(
+            'title' => t('Settings').' &gt; '.t('Shrink Vertically'),
+            'values' => array(
+                'shrink_vertically_offset' => $offset,
+                'shrink_vertically_top_scrollbar' => $topScrollbar,
+                'shrink_vertically_drag_scroll' => $dragScroll,
+            ),
+            'errors' => array(),
+        )));
+    }
+
+    public function save()
+    {
+        $values = $this->request->getValues();
+
+        $offset = isset($values['shrink_vertically_offset']) ? (int) $values['shrink_vertically_offset'] : self::DEFAULT_OFFSET;
+        $offset = max(self::MIN_OFFSET, min(self::MAX_OFFSET, $offset));
+
+        $topScrollbar = isset($values['shrink_vertically_top_scrollbar']) ? 1 : 0;
+        $dragScroll = isset($values['shrink_vertically_drag_scroll']) ? 1 : 0;
+
+        if ($this->configModel->save(array(
+            'shrink_vertically_offset' => $offset,
+            'shrink_vertically_top_scrollbar' => $topScrollbar,
+            'shrink_vertically_drag_scroll' => $dragScroll,
+        ))) {
+            $this->flash->success(t('Settings saved successfully.'));
+        } else {
+            $this->flash->failure(t('Unable to save your settings.'));
+        }
+
+        $this->response->redirect($this->helper->url->to('ConfigController', 'show', array('plugin' => 'ShrinkVertically')));
+    }
+}

Plugin.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Kanboard\Plugin\Skeleton;
+namespace Kanboard\Plugin\ShrinkVertically;
 
 use Kanboard\Core\Plugin\Base;
 
@@ -8,28 +8,47 @@ class Plugin extends Base
 {
     public function initialize()
     {
-        // 1. Render a visible word at the top of every page (the demo output).
-        $this->template->hook->attach('template:layout:top', 'skeleton:layout/header');
-
-        // 2. Load the plugin stylesheet (currently empty -- proves the CSS hook fires).
+        // Inject a small CSS override that reduces the height of vertically
+        // collapsed board columns so the horizontal scrollbar stays visible.
         $this->hook->on('template:layout:css', array(
-            'template' => 'plugins/Skeleton/Asset/css/skeleton.css',
+            'template' => 'plugins/ShrinkVertically/Asset/css/shrink-vertically.css',
         ));
 
-        // 3. Load the plugin script (currently empty -- proves the JS hook fires).
+        // Inject the configured pixel offset as a CSS variable in the page head.
+        $this->template->hook->attach('template:layout:head', 'shrinkVertically:layout/variable');
+
+        // Append a "+" to the two vertical-collapse menu labels so it is visible
+        // that the behaviour is modified by this plugin.
         $this->hook->on('template:layout:js', array(
-            'template' => 'plugins/Skeleton/Asset/js/skeleton.js',
+            'template' => 'plugins/ShrinkVertically/Asset/js/shrink-vertically.js',
         ));
+
+        // Add a "Shrink Vertically" entry to the Settings sidebar.
+        $this->template->hook->attach('template:config:sidebar', 'shrinkVertically:config/sidebar');
+
+        // Optional: a second, mirrored horizontal scrollbar above the board columns.
+        if ((int) $this->configModel->get('shrink_vertically_top_scrollbar', 0) === 1) {
+            $this->hook->on('template:layout:js', array(
+                'template' => 'plugins/ShrinkVertically/Asset/js/top-scrollbar.js',
+            ));
+        }
+
+        // Optional: click-and-drag the board background to scroll horizontally.
+        if ((int) $this->configModel->get('shrink_vertically_drag_scroll', 0) === 1) {
+            $this->hook->on('template:layout:js', array(
+                'template' => 'plugins/ShrinkVertically/Asset/js/drag-scroll.js',
+            ));
+        }
     }
 
     public function getPluginName()
     {
-        return 'Skeleton';
+        return 'ShrinkVertically';
     }
 
     public function getPluginDescription()
     {
-        return t('Reusable skeleton/template for building Kanboard plugins.');
+        return t('Shrink vertically-collapsed board columns so the horizontal scrollbar stays visible.');
     }
 
     public function getPluginAuthor()
@@ -39,12 +58,12 @@ class Plugin extends Base
 
     public function getPluginVersion()
     {
-        return '0.1.0';
+        return '1.1.0';
     }
 
     public function getPluginHomepage()
     {
-        return 'https://code.beco.cc/beco/kanboard-plugin-skeleton';
+        return 'https://code.beco.cc/beco/shrink-vertically';
     }
 
     public function getCompatibleVersion()

README.md

@@ -1,19 +1,56 @@
-# Skeleton -- a Kanboard plugin template
+# ShrinkVertically -- keep the board horizontal scrollbar visible
 
-A minimal, working Kanboard plugin that you copy and rename as the starting point for a
-real plugin. By itself it does only one trivial thing: it renders the word "Skeleton" at
-the top of every page. It changes no data and runs no database migration.
+A small Kanboard plugin focused on getting around the board horizontally. It fixes the
+vertically-collapsed board view so the bottom scrollbar stays on screen, can optionally
+add a second mirrored scrollbar above the columns, and can optionally let you drag the
+board background to scroll (like Trello). Everything is configurable under
+"Settings -> Shrink Vertically".
 
-## What it demonstrates
+## The problem
 
-- A complete `Plugin.php` registration class with all the metadata Kanboard shows in
-  Settings -> Plugins (name, description, author, version, homepage, compatible version).
-- A template hook (`template:layout:top`) that injects a template into the page.
-- Asset hooks (`template:layout:css` and `template:layout:js`) that load a stylesheet and
-  a script. They are empty for now but prove the injection path works -- handy when a real
-  plugin needs custom CSS or JS.
-- The standard plugin directory layout, with stub folders (`Controller/`, `Model/`,
-  `Schema/`, `Locale/`, `Test/`) ready to grow into.
+Kanboard's board gear menu has an "expand vertically / collapse vertically" toggle. When
+collapsed, each column gets a limited height so the horizontal scrollbar sits closer.
+Core implements this with a single rule:
+
+```css
+.board-task-list-compact { max-height: 90vh; }
+```
+
+That `90vh` is measured from the top of the viewport and does not account for the page
+header above the board. So even when collapsed, the column plus the header together
+exceed the viewport height and the horizontal scrollbar is pushed below the fold.
+
+## The fix
+
+This plugin injects one CSS rule (via the `template:layout:css` hook) that replaces the
+proportional `90vh` with a fixed-pixel budget for the chrome above and below the task
+list:
+
+```css
+#board td .board-task-list.board-task-list-compact {
+    max-height: calc(100vh - var(--sv-shrink-offset, 240px)) !important;
+    min-height: 0 !important;
+}
+```
+
+The offset reserves room for the page header, the board column header, the horizontal
+scrollbar, and a little breathing space. A fixed-pixel budget is more reliable than a
+proportional value because that chrome is a fixed height regardless of screen size. It
+defaults to `240px` and is configurable (see Settings below).
+
+The `min-height: 0` is essential: Kanboard's drag-and-drop sets an inline `min-height` on
+each column equal to its full content height, and in CSS `min-height` beats `max-height`,
+so without this reset the tall columns would never shrink.
+
+The override only applies while columns are collapsed (when core adds the
+`board-task-list-compact` class). It changes no data and runs no database migration.
+
+## Menu labels
+
+So it is obvious the collapsed behaviour comes from this plugin and not from core, a
+small script (via `template:layout:js`) appends a `+` to the two gear-menu items, so they
+read "Collapse vertically+" and "Expand vertically+". It only edits the rendered link
+text, so it works in any locale.
 
 ## Requirements
 
@@ -21,45 +58,42 @@ the top of every page. It changes no data and runs no database migration.
 
 ## Installation
 
-No build step and no dependencies.
+Copy this folder into your Kanboard installation as `plugins/ShrinkVertically/`. The
+directory name must be exactly `ShrinkVertically` (Kanboard derives the plugin namespace
+from the folder name). Reload the board; no build step, no configuration.
 
-1. Copy this folder into your Kanboard installation as `plugins/Skeleton/`.
-2. Reload any page. The word "Skeleton" appears at the top.
-3. Confirm it under Settings -> Plugins.
+## Top horizontal scrollbar (optional)
 
-To uninstall, delete `plugins/Skeleton/`. Nothing else is left behind.
+Kanboard's board scrolls horizontally inside `#board-container`, so its only horizontal
+scrollbar is at the very bottom of the board -- on a wide board you must scroll all the
+way down to move sideways. Enable "Add a top horizontal scrollbar" in the settings to get
+a second, mirrored scrollbar just above the columns. A small script
+(`Asset/js/top-scrollbar.js`, loaded only when the option is on) inserts a dummy scroll
+strip above `#board-container` and keeps its scroll position in sync with the board both
+ways.
 
-## Directory layout
+## Drag to scroll (optional)
 
-```
-Skeleton/
-  Plugin.php              Registration and hook wiring (the only required file).
-  README.md
-  LICENSE                 AGPL-3.0.
-  Template/
-    layout/header.php     The visible "Skeleton" word.
-  Asset/
-    css/skeleton.css      Loaded via template:layout:css.
-    js/skeleton.js        Loaded via template:layout:js.
-  Controller/             Stub for future request handlers.
-  Model/                  Stub for future business logic / DB access.
-  Schema/                 Stub for future database migrations.
-  Locale/                 Stub for future translations (e.g. pt_BR/, fr_FR/).
-  Test/                   Stub for future unit tests.
-```
+Kanboard has no way to pan the board by grabbing it; you must use the scrollbar. Enable
+"Drag the board background to scroll" to click and drag on the empty board background to
+scroll the columns sideways, like the Trello board canvas. 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.
 
-## How to fork this into a new plugin
+## Settings
 
-1. Copy the folder and rename it, e.g. `plugins/MyPlugin/`. The folder name must match the
-   namespace and start with a capital letter.
-2. In `Plugin.php`, change the namespace from `Kanboard\Plugin\Skeleton` to
-   `Kanboard\Plugin\MyPlugin`.
-3. Update the metadata methods (`getPluginName`, `getPluginDescription`, `getPluginAuthor`,
-   `getPluginVersion`, `getPluginHomepage`, `getCompatibleVersion`).
-4. Update the hook target paths: the lowercase prefix in `'skeleton:layout/header'` and the
-   `plugins/Skeleton/Asset/...` asset paths must match the new plugin name.
-5. Replace `Template/layout/header.php` with your real template, or attach to a different
-   hook. See the Kanboard plugin hooks documentation for the full list of hook points.
+Go to "Settings -> Shrink Vertically":
+
+- **Vertical offset in pixels** -- pixels reserved around the collapsed columns. Stored in
+  the Kanboard configuration and injected in the page head as the `--sv-shrink-offset` CSS
+  variable. Increase it if the scrollbar is still clipped (for example with a taller theme
+  header); decrease it to make the collapsed columns taller. Default: 240.
+- **Add a top horizontal scrollbar to the board** -- toggles the mirrored top scrollbar
+  described above.
+- **Drag the board background to scroll horizontally** -- toggles the Trello-style
+  click-and-drag panning described above.
 
 ## License
 

Template/config/show.php

@@ -0,0 +1,33 @@
+<div class="page-header">
+    <h2><?= t('Shrink Vertically') ?></h2>
+</div>
+
+<form method="post" action="<?= $this->url->href('ConfigController', 'save', array('plugin' => 'ShrinkVertically')) ?>" autocomplete="off">
+    <?= $this->form->csrf() ?>
+
+    <fieldset>
+        <?= $this->form->label(t('Vertical offset in pixels'), 'shrink_vertically_offset') ?>
+        <?= $this->form->number('shrink_vertically_offset', $values, $errors) ?>
+        <p class="form-help">
+            <?= t('Pixels reserved above and below the vertically collapsed board columns (page header, column header and the horizontal scrollbar). A larger value makes the columns shorter. Default: 240.') ?>
+        </p>
+    </fieldset>
+
+    <fieldset>
+        <?= $this->form->checkbox('shrink_vertically_top_scrollbar', t('Add a top horizontal scrollbar to the board'), 1, isset($values['shrink_vertically_top_scrollbar']) && $values['shrink_vertically_top_scrollbar'] == 1) ?>
+        <p class="form-help">
+            <?= t('Adds a second horizontal scrollbar above the columns, mirrored with the board scrollbar, so you do not have to scroll to the bottom to move sideways.') ?>
+        </p>
+    </fieldset>
+
+    <fieldset>
+        <?= $this->form->checkbox('shrink_vertically_drag_scroll', t('Drag the board background to scroll horizontally'), 1, isset($values['shrink_vertically_drag_scroll']) && $values['shrink_vertically_drag_scroll'] == 1) ?>
+        <p class="form-help">
+            <?= t('Like Trello: click and drag on the empty board background to scroll the columns sideways. Dragging a task card or a handle still works as usual.') ?>
+        </p>
+    </fieldset>
+
+    <div class="form-actions">
+        <button type="submit" class="btn btn-blue"><?= t('Save') ?></button>
+    </div>
+</form>

Template/config/sidebar.php

@@ -0,0 +1,3 @@
+<li <?= $this->app->checkMenuSelection('ConfigController', 'show', 'ShrinkVertically') ?>>
+    <?= $this->url->link(t('Shrink Vertically'), 'ConfigController', 'show', array('plugin' => 'ShrinkVertically')) ?>
+</li>

Template/layout/header.php

@@ -1 +0,0 @@
-<div class="skeleton-plugin-marker">Skeleton</div>

Template/layout/variable.php

@@ -0,0 +1,3 @@
+<style type="text/css">
+    :root { --sv-shrink-offset: <?= (int) $this->app->config('shrink_vertically_offset', 240) ?>px; }
+</style>

VERSION

@@ -0,0 +1 @@
+ShrinkVertically v1.1