5 Commits

7 changed files with 158 additions and 14 deletions

86
Asset/js/auto-adjust.js Normal file
View File

@@ -0,0 +1,86 @@
/*
* ShrinkVertically -- "Auto adjust" mode. Measure the collapsed board live and set the
* --sv-shrink-offset CSS variable so the columns exactly fill the remaining viewport and the
* native right-side vertical scrollbar is not needed. Loaded only when the setting is on
* (Settings -> Shrink Vertically); it overrides the static offset injected by layout/variable.php.
*
* The collapsed column height is calc(100vh - var(--sv-shrink-offset)). To fit the screen we need:
* offset = (task-list top, i.e. the chrome above) + (horizontal scrollbar below) + a small margin
* so column_bottom + scrollbar stays within the viewport. Both terms are measured from the DOM, so
* this adapts to any screen size, theme, or header height.
*
* Re-measures on resize, on collapse/expand (a class toggle), and after a board refresh
* (BoardDragAndDrop replaces #board-container -- so, like the other plugins, the observer is bound
* to the STABLE parent, not to the container that gets swapped out).
*/
(function () {
"use strict";
var BOTTOM_MARGIN = 20; // breathing room below the columns (covers sub-pixel + borders so nothing overflows)
var scheduled = false;
function apply() {
scheduled = false;
var list = document.querySelector("#board .board-task-list.board-task-list-compact");
if (! list) {
return; // board not collapsed -> nothing to auto-size
}
var top = list.getBoundingClientRect().top;
var container = document.getElementById("board-container");
var bar = container ? (container.offsetHeight - container.clientHeight) : 0; // horizontal scrollbar
if (bar < 0) {
bar = 0;
}
var offset = Math.ceil(top + bar + BOTTOM_MARGIN);
if (offset < 0) {
offset = 0;
}
var next = offset + "px";
var root = document.documentElement;
// Only write when it actually changes, so mid-drag class churn does not thrash layout.
if (root.style.getPropertyValue("--sv-shrink-offset") !== next) {
root.style.setProperty("--sv-shrink-offset", next);
}
}
function schedule() {
if (! scheduled) {
scheduled = true;
window.requestAnimationFrame(apply);
}
}
function init() {
var container = document.getElementById("board-container");
if (! container) {
return; // not a board page
}
schedule();
window.addEventListener("resize", schedule);
if (window.MutationObserver && container.parentNode) {
new MutationObserver(schedule).observe(container.parentNode, {
childList: true,
subtree: true,
attributes: true,
attributeFilter: ["class"]
});
}
}
if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", init);
} else {
init();
}
})();

View File

@@ -1,13 +1,17 @@
/* /*
* ShrinkVertically -- mark the two vertical-collapse menu items so it is obvious the * ShrinkVertically page scripts (loaded on every page via template:layout:js). Each runs only where
* behaviour comes from this plugin and not from Kanboard core. * its elements exist, so both are no-ops elsewhere:
* *
* Core renders these labels in app/Template/project_header/dropdown.php: * 1. addPlus() -- mark the two vertical-collapse gear-menu items with a trailing "+" so it is
* obvious the behaviour comes from this plugin and not core. Core renders these labels in
* app/Template/project_header/dropdown.php:
* .filter-vert-collapse .filter-vert-toggle-collapse -> "Collapse vertically" * .filter-vert-collapse .filter-vert-toggle-collapse -> "Collapse vertically"
* .filter-vert-expand .filter-vert-toggle-collapse -> "Expand vertically" * .filter-vert-expand .filter-vert-toggle-collapse -> "Expand vertically"
* Editing the rendered text (not the translation table) is locale-independent.
* *
* We append a "+" to each so they read "Collapse vertically+" / "Expand vertically+". * 2. syncAutoAdjust() -- on Settings -> Shrink Vertically, dim + disable the pixel-offset input
* This is locale-independent (it edits the rendered text, not the translation table). * while "Auto adjust" is checked. This lives here (not an inline <script> on the config page)
* because Kanboard's CSP (default-src 'self') blocks inline scripts and event handlers.
*/ */
(function () { (function () {
"use strict"; "use strict";
@@ -26,9 +30,31 @@
} }
} }
if (document.readyState === "loading") { function syncAutoAdjust() {
document.addEventListener("DOMContentLoaded", addPlus); var auto = document.getElementById("form-shrink_vertically_auto");
} else { var offset = document.getElementById("form-shrink_vertically_offset");
if (! auto || ! offset) {
return;
}
function sync() {
offset.disabled = auto.checked;
offset.style.opacity = auto.checked ? "0.4" : "";
}
auto.addEventListener("change", sync);
sync();
}
function init() {
addPlus(); addPlus();
syncAutoAdjust();
}
if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", init);
} else {
init();
} }
})(); })();

View File

@@ -23,6 +23,7 @@ class ConfigController extends BaseController
$offset = (int) $this->configModel->get('shrink_vertically_offset', self::DEFAULT_OFFSET); $offset = (int) $this->configModel->get('shrink_vertically_offset', self::DEFAULT_OFFSET);
$barSize = (int) $this->configModel->get('shrink_vertically_bar_size', self::DEFAULT_BAR_SIZE); $barSize = (int) $this->configModel->get('shrink_vertically_bar_size', self::DEFAULT_BAR_SIZE);
$topScrollbar = (int) $this->configModel->get('shrink_vertically_top_scrollbar', 1); $topScrollbar = (int) $this->configModel->get('shrink_vertically_top_scrollbar', 1);
$auto = (int) $this->configModel->get('shrink_vertically_auto', 0);
$this->response->html($this->helper->layout->config('shrinkVertically:config/show', array( $this->response->html($this->helper->layout->config('shrinkVertically:config/show', array(
'title' => t('Settings').' &gt; '.t('Shrink Vertically'), 'title' => t('Settings').' &gt; '.t('Shrink Vertically'),
@@ -30,6 +31,7 @@ class ConfigController extends BaseController
'shrink_vertically_offset' => $offset, 'shrink_vertically_offset' => $offset,
'shrink_vertically_bar_size' => $barSize, 'shrink_vertically_bar_size' => $barSize,
'shrink_vertically_top_scrollbar' => $topScrollbar, 'shrink_vertically_top_scrollbar' => $topScrollbar,
'shrink_vertically_auto' => $auto,
), ),
'errors' => array(), 'errors' => array(),
))); )));
@@ -39,18 +41,24 @@ class ConfigController extends BaseController
{ {
$values = $this->request->getValues(); $values = $this->request->getValues();
$offset = isset($values['shrink_vertically_offset']) ? (int) $values['shrink_vertically_offset'] : self::DEFAULT_OFFSET; // In auto mode the offset input is disabled client-side, so the browser does not submit it.
// Fall back to the stored value (not the default) so enabling auto never wipes the manual offset.
$offset = isset($values['shrink_vertically_offset'])
? (int) $values['shrink_vertically_offset']
: (int) $this->configModel->get('shrink_vertically_offset', self::DEFAULT_OFFSET);
$offset = max(self::MIN_OFFSET, min(self::MAX_OFFSET, $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 = 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)); $barSize = max(self::MIN_BAR_SIZE, min(self::MAX_BAR_SIZE, $barSize));
$topScrollbar = isset($values['shrink_vertically_top_scrollbar']) ? 1 : 0; $topScrollbar = isset($values['shrink_vertically_top_scrollbar']) ? 1 : 0;
$auto = isset($values['shrink_vertically_auto']) ? 1 : 0;
if ($this->configModel->save(array( if ($this->configModel->save(array(
'shrink_vertically_offset' => $offset, 'shrink_vertically_offset' => $offset,
'shrink_vertically_bar_size' => $barSize, 'shrink_vertically_bar_size' => $barSize,
'shrink_vertically_top_scrollbar' => $topScrollbar, 'shrink_vertically_top_scrollbar' => $topScrollbar,
'shrink_vertically_auto' => $auto,
))) { ))) {
$this->flash->success(t('Settings saved successfully.')); $this->flash->success(t('Settings saved successfully.'));
} else { } else {

View File

@@ -32,6 +32,14 @@ class Plugin extends Base
'template' => 'plugins/ShrinkVertically/Asset/js/top-scrollbar.js', 'template' => 'plugins/ShrinkVertically/Asset/js/top-scrollbar.js',
)); ));
} }
// Optional: auto-adjust the collapsed column height to the screen (measured live on the
// board), overriding the static pixel offset so the vertical scrollbar is not needed.
if ((int) $this->configModel->get('shrink_vertically_auto', 0) === 1) {
$this->hook->on('template:layout:js', array(
'template' => 'plugins/ShrinkVertically/Asset/js/auto-adjust.js',
));
}
} }
public function getPluginName() public function getPluginName()
@@ -51,7 +59,7 @@ class Plugin extends Base
public function getPluginVersion() public function getPluginVersion()
{ {
return '1.5.2'; return '1.6.4';
} }
public function getPluginHomepage() public function getPluginHomepage()

View File

@@ -86,6 +86,11 @@ These settings are global (per Kanboard instance) and admin-only. Go to
in the page head as the `--sv-shrink-offset` CSS variable. Increase it if the scrollbar 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 is still clipped (for example with a taller theme header); decrease it to make the
collapsed columns taller. Default: 240. collapsed columns taller. Default: 240.
- **Auto adjust** -- instead of a fixed offset, measure the collapsed board live and size
the columns to fit the screen automatically, so the right-side vertical scrollbar is not
needed. It re-measures on window resize, on collapse/expand, and after a board refresh.
While enabled, the pixel-offset field above is disabled and dimmed (the measured value is
used instead). Loaded as `Asset/js/auto-adjust.js` only when the option is on. Default: off.
- **Top Horizontal Scrollbar thickness in pixels** -- thickness of the custom top - **Top Horizontal Scrollbar thickness in pixels** -- thickness of the custom top
scrollbar (all browsers). Injected as the `--sv-bar-size` CSS variable. Default: 25. scrollbar (all browsers). Injected as the `--sv-bar-size` CSS variable. Default: 25.
- **Add a top horizontal scrollbar to the board** -- toggles the mirrored top scrollbar - **Add a top horizontal scrollbar to the board** -- toggles the mirrored top scrollbar
@@ -95,7 +100,7 @@ These settings are global (per Kanboard instance) and admin-only. Go to
AGPL-3.0. See LICENSE. AGPL-3.0. See LICENSE.
## More Kanboard plugins by Ruben (drbeco) ## More Kanboard plugins by Dr. Beco
All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco): All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
@@ -103,6 +108,10 @@ All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
monthly, weekly, daily), driven by the card due date. monthly, weekly, daily), driven by the card due date.
- **[FinanceBuddy](https://code.beco.cc/beco/FinanceBuddy)** -- attach a money value (debit/credit - **[FinanceBuddy](https://code.beco.cc/beco/FinanceBuddy)** -- attach a money value (debit/credit
and installments) to cards, shown on the card and totalled per column. and installments) to cards, shown on the card and totalled per column.
- **[QualKard](https://code.beco.cc/beco/QualKard)** -- flashcard spaced repetition: grade a card by
dragging it to a column, and it comes back when due (needs RecoReco).
- **[WorkspaceOrg](https://code.beco.cc/beco/WorkspaceOrg)** -- group your projects into personal
per-user workspaces, shown on a "My workspaces" dashboard page with a badge on each project.
- **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small - **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small
quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due
dates, extra search keywords and shared board filters, and more. dates, extra search keywords and shared board filters, and more.

View File

@@ -11,6 +11,11 @@
<p class="form-help"> <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.') ?> <?= 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> </p>
<?= $this->form->checkbox('shrink_vertically_auto', t('Auto adjust (fit columns to the screen automatically)'), 1, isset($values['shrink_vertically_auto']) && $values['shrink_vertically_auto'] == 1, '', array('id' => 'form-shrink_vertically_auto')) ?>
<p class="form-help">
<?= t('When enabled, the collapsed column height is measured live on the board to fit the screen, so the right-side vertical scrollbar is not needed. The pixel offset above is then ignored (shown dimmed).') ?>
</p>
</fieldset> </fieldset>
<fieldset> <fieldset>
@@ -32,3 +37,5 @@
<button type="submit" class="btn btn-blue"><?= t('Save') ?></button> <button type="submit" class="btn btn-blue"><?= t('Save') ?></button>
</div> </div>
</form> </form>
<?php /* The "Auto adjust" checkbox dims/disables the offset input via Asset/js/shrink-vertically.js
(loaded globally). An inline <script> here would be blocked by Kanboard's CSP. */ ?>

View File

@@ -1 +1 @@
ShrinkVertically v1.5.2 ShrinkVertically v1.6.4