Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 51eba0ad5e | |||
| 54b9fa93fb | |||
| 65b4771e51 | |||
| dbfe98b3c7 | |||
| 3beaa88fe9 | |||
| dcb672777d |
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
PLAN-*
|
||||
|
||||
@@ -48,3 +48,55 @@
|
||||
.sv-top-scroll-inner {
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
/*
|
||||
* Make the top scrollbar thick enough to grab easily (touch / big fingers).
|
||||
* WebKit/Blink (most desktop browsers and mobile Chrome/Safari) let us size the
|
||||
* scrollbar; styling the thumb/track is needed for it to stay visible once customised.
|
||||
* Thickness comes from the --sv-bar-size variable (Settings -> Shrink Vertically),
|
||||
* injected in the page head; falls back to 25px. Chromium/WebKit only (Chrome/Edge/
|
||||
* Safari, mobile Chrome/Safari); Firefox ignores ::-webkit-scrollbar and keeps its
|
||||
* default thin bar -- accepted for now.
|
||||
*/
|
||||
.sv-top-scroll::-webkit-scrollbar {
|
||||
height: var(--sv-bar-size, 25px);
|
||||
}
|
||||
|
||||
.sv-top-scroll::-webkit-scrollbar-track {
|
||||
background: rgba(0, 0, 0, 0.05);
|
||||
}
|
||||
|
||||
.sv-top-scroll::-webkit-scrollbar-thumb {
|
||||
background: rgba(0, 0, 0, 0.35);
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
/*
|
||||
* 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;
|
||||
}
|
||||
|
||||
/*
|
||||
* Wider gutter between board columns is applied conditionally from
|
||||
* Template/layout/variable.php (only when the "Widen the gap between columns" setting is
|
||||
* on), using border-spacing with the --sv-bar-size value. border-spacing is the natural
|
||||
* control for the gap between table columns: it spreads them without shrinking the cards
|
||||
* and keeps each column header aligned with its task list. It is not in this static
|
||||
* stylesheet so it can be toggled per the setting.
|
||||
*/
|
||||
|
||||
75
Asset/js/drag-scroll.js
Normal file
75
Asset/js/drag-scroll.js
Normal file
@@ -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();
|
||||
}
|
||||
})();
|
||||
@@ -14,15 +14,21 @@ class ConfigController extends BaseController
|
||||
const MIN_OFFSET = 0;
|
||||
const MAX_OFFSET = 2000;
|
||||
|
||||
const DEFAULT_BAR_SIZE = 25;
|
||||
const MIN_BAR_SIZE = 0;
|
||||
const MAX_BAR_SIZE = 200;
|
||||
|
||||
public function show()
|
||||
{
|
||||
$offset = (int) $this->configModel->get('shrink_vertically_offset', self::DEFAULT_OFFSET);
|
||||
$topScrollbar = (int) $this->configModel->get('shrink_vertically_top_scrollbar', 0);
|
||||
$barSize = (int) $this->configModel->get('shrink_vertically_bar_size', self::DEFAULT_BAR_SIZE);
|
||||
$topScrollbar = (int) $this->configModel->get('shrink_vertically_top_scrollbar', 1);
|
||||
|
||||
$this->response->html($this->helper->layout->config('shrinkVertically:config/show', array(
|
||||
'title' => t('Settings').' > '.t('Shrink Vertically'),
|
||||
'values' => array(
|
||||
'shrink_vertically_offset' => $offset,
|
||||
'shrink_vertically_bar_size' => $barSize,
|
||||
'shrink_vertically_top_scrollbar' => $topScrollbar,
|
||||
),
|
||||
'errors' => array(),
|
||||
@@ -36,10 +42,14 @@ class ConfigController extends BaseController
|
||||
$offset = isset($values['shrink_vertically_offset']) ? (int) $values['shrink_vertically_offset'] : self::DEFAULT_OFFSET;
|
||||
$offset = max(self::MIN_OFFSET, min(self::MAX_OFFSET, $offset));
|
||||
|
||||
$barSize = isset($values['shrink_vertically_bar_size']) ? (int) $values['shrink_vertically_bar_size'] : self::DEFAULT_BAR_SIZE;
|
||||
$barSize = max(self::MIN_BAR_SIZE, min(self::MAX_BAR_SIZE, $barSize));
|
||||
|
||||
$topScrollbar = isset($values['shrink_vertically_top_scrollbar']) ? 1 : 0;
|
||||
|
||||
if ($this->configModel->save(array(
|
||||
'shrink_vertically_offset' => $offset,
|
||||
'shrink_vertically_bar_size' => $barSize,
|
||||
'shrink_vertically_top_scrollbar' => $topScrollbar,
|
||||
))) {
|
||||
$this->flash->success(t('Settings saved successfully.'));
|
||||
|
||||
@@ -27,7 +27,7 @@ class Plugin extends Base
|
||||
$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) {
|
||||
if ((int) $this->configModel->get('shrink_vertically_top_scrollbar', 1) === 1) {
|
||||
$this->hook->on('template:layout:js', array(
|
||||
'template' => 'plugins/ShrinkVertically/Asset/js/top-scrollbar.js',
|
||||
));
|
||||
@@ -51,7 +51,7 @@ class Plugin extends Base
|
||||
|
||||
public function getPluginVersion()
|
||||
{
|
||||
return '1.0.0';
|
||||
return '1.3.0';
|
||||
}
|
||||
|
||||
public function getPluginHomepage()
|
||||
|
||||
40
README.md
40
README.md
@@ -1,9 +1,10 @@
|
||||
# ShrinkVertically -- keep the board horizontal scrollbar visible
|
||||
|
||||
A small Kanboard plugin focused on the board's horizontal scrollbar. It fixes the
|
||||
vertically-collapsed board view so the bottom scrollbar stays on screen, and can
|
||||
optionally add a second, mirrored horizontal scrollbar above the columns. Both are
|
||||
configurable under "Settings -> Shrink Vertically".
|
||||
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".
|
||||
|
||||
## The problem
|
||||
|
||||
@@ -71,16 +72,35 @@ a second, mirrored scrollbar just above the columns. A small script
|
||||
strip above `#board-container` and keeps its scroll position in sync with the board both
|
||||
ways.
|
||||
|
||||
## Drag to scroll on Desktop (optional)
|
||||
|
||||
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.
|
||||
|
||||
## Settings
|
||||
|
||||
Go to "Settings -> Shrink Vertically":
|
||||
These settings are global (per Kanboard instance) and admin-only. 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.
|
||||
- **Vertical offset in pixels** -- pixels reserved around the collapsed columns. 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.
|
||||
- **Scrollbar thickness and column gap in pixels** -- a single value that sets both the
|
||||
thickness of the top scrollbar (Chromium/WebKit only) and the width of the column gap.
|
||||
Injected as the `--sv-bar-size` CSS variable. Default: 25.
|
||||
- **Add a top horizontal scrollbar to the board** -- toggles the mirrored top scrollbar
|
||||
described above.
|
||||
described above. Default: on.
|
||||
- **Widen the gap between columns** -- toggles the wider gap between board columns (sized
|
||||
by the value above). Also adds some spacing at the left and right edges of the board.
|
||||
Default: on.
|
||||
- **Drag the board background to scroll horizontally** -- toggles the Trello-style
|
||||
click-and-drag panning described above. Default: on.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -13,6 +13,14 @@
|
||||
</p>
|
||||
</fieldset>
|
||||
|
||||
<fieldset>
|
||||
<?= $this->form->label(t('Scrollbar thickness in pixels'), 'shrink_vertically_bar_size') ?>
|
||||
<?= $this->form->number('shrink_vertically_bar_size', $values, $errors) ?>
|
||||
<p class="form-help">
|
||||
<?= t('Thickness of the top horizontal scrollbar (Chromium/WebKit browsers only). Default: 25.') ?>
|
||||
</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">
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
<style type="text/css">
|
||||
:root { --sv-shrink-offset: <?= (int) $this->app->config('shrink_vertically_offset', 240) ?>px; }
|
||||
:root {
|
||||
--sv-shrink-offset: <?= (int) $this->app->config('shrink_vertically_offset', 240) ?>px;
|
||||
--sv-bar-size: <?= (int) $this->app->config('shrink_vertically_bar_size', 25) ?>px;
|
||||
}
|
||||
<?php if ((int) $this->app->config('shrink_vertically_column_gap', 1) === 1): ?>
|
||||
#board { border-collapse: separate !important; border-spacing: var(--sv-bar-size, 25px) 0 !important; }
|
||||
<?php endif ?>
|
||||
</style>
|
||||
|
||||
Reference in New Issue
Block a user