Compare commits
29 Commits
418d71da3c
...
v1.4.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 045bae1e4c | |||
| 8ae373b4e7 | |||
| 174b6ad31a | |||
| 4ab761c03e | |||
| b8308782f8 | |||
| 5cccbef7d7 | |||
| 9b78882835 | |||
| 51eba0ad5e | |||
| 54b9fa93fb | |||
| 65b4771e51 | |||
| dbfe98b3c7 | |||
| 3beaa88fe9 | |||
| dcb672777d | |||
| 5712d055d3 | |||
| 5fcf1ffeb1 | |||
| fc961be3c1 | |||
| fa23d7a64c | |||
| e6479c9ed9 | |||
| 4597c6c61c | |||
| 31caec25d0 | |||
| 7385f52b95 | |||
| 9541ea83e3 | |||
| 7a90d15e82 | |||
| e9681201c0 | |||
| 8b97480e2e | |||
| f7227eaef1 | |||
| 79b4a9a8f6 | |||
| e46a124bad | |||
| 248cfe201b |
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
PLAN-*
|
||||
|
||||
79
Asset/css/shrink-vertically.css
Normal file
79
Asset/css/shrink-vertically.css
Normal file
@@ -0,0 +1,79 @@
|
||||
/*
|
||||
* 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 max-height can win.
|
||||
*
|
||||
* We override it to a small NON-ZERO value, not 0: Kanboard relies on that same inline
|
||||
* min-height to keep EMPTY columns tall enough to be a drop target, so zeroing it makes
|
||||
* you unable to drop a card into an empty collapsed column. 100px clears Kanboard's 70px
|
||||
* drag placeholder (.draggable-placeholder) with margin, and stays well below max-height
|
||||
* so tall columns still shrink; non-empty columns are unaffected (their content is taller).
|
||||
*/
|
||||
#board td .board-task-list.board-task-list-compact {
|
||||
max-height: calc(100vh - var(--sv-shrink-offset, 240px)) !important;
|
||||
min-height: 100px !important;
|
||||
}
|
||||
|
||||
/*
|
||||
* Optional custom top horizontal scrollbar (built by Asset/js/top-scrollbar.js when the
|
||||
* "Add a top horizontal scrollbar" setting is enabled). It is a track + draggable thumb,
|
||||
* not a native scrollbar, so it renders and can be sized identically in every browser
|
||||
* (Chrome, Firefox, Safari) and on touch. Thickness follows the --sv-bar-size variable
|
||||
* (Settings -> Shrink Vertically), injected in the page head; falls back to 25px.
|
||||
* touch-action: none lets a finger drag the thumb without scrolling the page.
|
||||
*/
|
||||
.sv-top-scroll {
|
||||
position: relative;
|
||||
width: 100%;
|
||||
height: var(--sv-bar-size, 25px);
|
||||
background: rgba(0, 0, 0, 0.06);
|
||||
border-radius: 4px;
|
||||
overflow: hidden;
|
||||
touch-action: none;
|
||||
}
|
||||
|
||||
.sv-top-scroll-thumb {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
width: 0;
|
||||
height: 100%;
|
||||
background: rgba(0, 0, 0, 0.35);
|
||||
border-radius: 4px;
|
||||
cursor: grab;
|
||||
touch-action: none;
|
||||
}
|
||||
|
||||
.sv-top-scroll.sv-dragging .sv-top-scroll-thumb {
|
||||
cursor: grabbing;
|
||||
background: rgba(0, 0, 0, 0.5);
|
||||
}
|
||||
|
||||
.sv-dragging {
|
||||
user-select: none;
|
||||
}
|
||||
1
Asset/css/skeleton.css
vendored
1
Asset/css/skeleton.css
vendored
@@ -1 +0,0 @@
|
||||
/* Skeleton plugin styles -- add CSS here. Loaded via template:layout:css. */
|
||||
34
Asset/js/shrink-vertically.js
Normal file
34
Asset/js/shrink-vertically.js
Normal file
@@ -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();
|
||||
}
|
||||
})();
|
||||
@@ -1 +0,0 @@
|
||||
// Skeleton plugin script -- add JS here. Loaded via template:layout:js.
|
||||
154
Asset/js/top-scrollbar.js
Normal file
154
Asset/js/top-scrollbar.js
Normal file
@@ -0,0 +1,154 @@
|
||||
/*
|
||||
* ShrinkVertically -- optional custom horizontal scrollbar above the board.
|
||||
*
|
||||
* Kanboard's board scrolls horizontally inside #board-container (overflow-x: auto), so the
|
||||
* only native 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 scrollbar just above
|
||||
* the columns and keeps it in sync with the board.
|
||||
*
|
||||
* Unlike a native scrollbar (whose thickness cannot be sized in Firefox), this is a custom
|
||||
* track + thumb widget: it renders and behaves the same in every browser (Chrome, Firefox,
|
||||
* Safari) and on touch, and its thickness follows the --sv-bar-size setting.
|
||||
*
|
||||
* Loaded only when the "Add a top horizontal scrollbar" setting is enabled.
|
||||
*/
|
||||
(function () {
|
||||
"use strict";
|
||||
|
||||
// Keep the thumb wide enough to grab, even on a very wide board.
|
||||
var MIN_THUMB = 24;
|
||||
|
||||
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 track = document.createElement("div");
|
||||
track.className = "sv-top-scroll";
|
||||
|
||||
var thumb = document.createElement("div");
|
||||
thumb.className = "sv-top-scroll-thumb";
|
||||
track.appendChild(thumb);
|
||||
|
||||
container.parentNode.insertBefore(track, container);
|
||||
|
||||
var dragging = false;
|
||||
var dragStartX = 0;
|
||||
var dragStartScrollLeft = 0;
|
||||
|
||||
function metrics() {
|
||||
return {
|
||||
viewport: container.clientWidth,
|
||||
content: container.scrollWidth,
|
||||
trackW: track.clientWidth
|
||||
};
|
||||
}
|
||||
|
||||
function positionThumb(m, thumbW) {
|
||||
var maxScroll = m.content - m.viewport;
|
||||
var maxThumb = m.trackW - thumbW;
|
||||
var left = maxScroll > 0 ? (container.scrollLeft / maxScroll) * maxThumb : 0;
|
||||
thumb.style.transform = "translateX(" + Math.round(left) + "px)";
|
||||
}
|
||||
|
||||
// Recompute thumb width/position; hide the whole bar when nothing to scroll.
|
||||
function layout() {
|
||||
var m = metrics();
|
||||
|
||||
if (m.content <= m.viewport || m.trackW <= 0) {
|
||||
track.style.display = "none";
|
||||
return;
|
||||
}
|
||||
|
||||
track.style.display = "";
|
||||
|
||||
var thumbW = Math.round(m.trackW * m.viewport / m.content);
|
||||
if (thumbW < MIN_THUMB) { thumbW = MIN_THUMB; }
|
||||
if (thumbW > m.trackW) { thumbW = m.trackW; }
|
||||
|
||||
thumb.style.width = thumbW + "px";
|
||||
positionThumb(m, thumbW);
|
||||
}
|
||||
|
||||
// Board scrolled by any other means -> keep the thumb in sync.
|
||||
container.addEventListener("scroll", function () {
|
||||
if (dragging) { return; }
|
||||
var m = metrics();
|
||||
if (m.content <= m.viewport) { return; }
|
||||
positionThumb(m, thumb.offsetWidth);
|
||||
});
|
||||
|
||||
// Drag the thumb (mouse + touch via Pointer Events).
|
||||
thumb.addEventListener("pointerdown", function (e) {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
dragging = true;
|
||||
dragStartX = e.clientX;
|
||||
dragStartScrollLeft = container.scrollLeft;
|
||||
track.classList.add("sv-dragging");
|
||||
if (thumb.setPointerCapture) {
|
||||
thumb.setPointerCapture(e.pointerId);
|
||||
}
|
||||
});
|
||||
|
||||
thumb.addEventListener("pointermove", function (e) {
|
||||
if (!dragging) { return; }
|
||||
var m = metrics();
|
||||
var maxThumb = m.trackW - thumb.offsetWidth;
|
||||
var maxScroll = m.content - m.viewport;
|
||||
if (maxThumb <= 0) { return; }
|
||||
container.scrollLeft = dragStartScrollLeft + (e.clientX - dragStartX) * (maxScroll / maxThumb);
|
||||
positionThumb(m, thumb.offsetWidth);
|
||||
});
|
||||
|
||||
function endDrag(e) {
|
||||
if (!dragging) { return; }
|
||||
dragging = false;
|
||||
track.classList.remove("sv-dragging");
|
||||
if (thumb.releasePointerCapture && e && e.pointerId != null) {
|
||||
try { thumb.releasePointerCapture(e.pointerId); } catch (err) { /* ignore */ }
|
||||
}
|
||||
}
|
||||
|
||||
thumb.addEventListener("pointerup", endDrag);
|
||||
thumb.addEventListener("pointercancel", endDrag);
|
||||
|
||||
// Click on the empty track -> jump so the thumb centers under the pointer.
|
||||
track.addEventListener("pointerdown", function (e) {
|
||||
if (e.target === thumb || dragging) { return; }
|
||||
var m = metrics();
|
||||
if (m.content <= m.viewport) { return; }
|
||||
|
||||
var thumbW = thumb.offsetWidth;
|
||||
var maxThumb = m.trackW - thumbW;
|
||||
var maxScroll = m.content - m.viewport;
|
||||
if (maxThumb <= 0) { return; }
|
||||
|
||||
var clickX = e.clientX - track.getBoundingClientRect().left;
|
||||
var targetLeft = clickX - thumbW / 2;
|
||||
if (targetLeft < 0) { targetLeft = 0; }
|
||||
if (targetLeft > maxThumb) { targetLeft = maxThumb; }
|
||||
|
||||
container.scrollLeft = (targetLeft / maxThumb) * maxScroll;
|
||||
positionThumb(m, thumbW);
|
||||
});
|
||||
|
||||
window.addEventListener("resize", layout);
|
||||
|
||||
// The board can be redrawn by AJAX polling / drag-and-drop; keep sizes current.
|
||||
if (window.MutationObserver) {
|
||||
new MutationObserver(layout).observe(container, { childList: true, subtree: true });
|
||||
}
|
||||
|
||||
layout();
|
||||
}
|
||||
|
||||
if (document.readyState === "loading") {
|
||||
document.addEventListener("DOMContentLoaded", init);
|
||||
} else {
|
||||
init();
|
||||
}
|
||||
})();
|
||||
62
Controller/ConfigController.php
Normal file
62
Controller/ConfigController.php
Normal file
@@ -0,0 +1,62 @@
|
||||
<?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;
|
||||
|
||||
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);
|
||||
$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(),
|
||||
)));
|
||||
}
|
||||
|
||||
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));
|
||||
|
||||
$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.'));
|
||||
} else {
|
||||
$this->flash->failure(t('Unable to save your settings.'));
|
||||
}
|
||||
|
||||
$this->response->redirect($this->helper->url->to('ConfigController', 'show', array('plugin' => 'ShrinkVertically')));
|
||||
}
|
||||
}
|
||||
36
Plugin.php
36
Plugin.php
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
|
||||
namespace Kanboard\Plugin\Skeleton;
|
||||
namespace Kanboard\Plugin\ShrinkVertically;
|
||||
|
||||
use Kanboard\Core\Plugin\Base;
|
||||
|
||||
@@ -8,28 +8,40 @@ 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', 1) === 1) {
|
||||
$this->hook->on('template:layout:js', array(
|
||||
'template' => 'plugins/ShrinkVertically/Asset/js/top-scrollbar.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 +51,12 @@ class Plugin extends Base
|
||||
|
||||
public function getPluginVersion()
|
||||
{
|
||||
return '0.1.0';
|
||||
return '1.4.1';
|
||||
}
|
||||
|
||||
public function getPluginHomepage()
|
||||
{
|
||||
return 'https://code.beco.cc/beco/kanboard-plugin-skeleton';
|
||||
return 'https://code.beco.cc/beco/shrink-vertically';
|
||||
}
|
||||
|
||||
public function getCompatibleVersion()
|
||||
|
||||
122
README.md
122
README.md
@@ -1,19 +1,58 @@
|
||||
# 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 the vertically-collapsed board view. It fixes the
|
||||
collapse so the bottom horizontal scrollbar stays on screen, and can optionally add a
|
||||
second mirrored scrollbar above the columns. Configurable under
|
||||
"Settings -> Shrink Vertically".
|
||||
|
||||
## What it demonstrates
|
||||
Board drag/touch and column-gap options that used to live here have moved to the separate
|
||||
`TweakDrag` plugin.
|
||||
|
||||
- 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.
|
||||
## The problem
|
||||
|
||||
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 +60,36 @@ 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 scrollbar just above the columns.
|
||||
|
||||
## Directory layout
|
||||
It is a custom track + draggable thumb (`Asset/js/top-scrollbar.js`, loaded only when the
|
||||
option is on), not a native scrollbar, so it renders and can be sized the same in every
|
||||
browser (Chrome, Firefox, Safari) and on touch. Drag the thumb or click the track to move
|
||||
the board; the thumb tracks the board when you scroll it by other means. Its thickness
|
||||
follows the "Top Horizontal Scrollbar thickness" setting.
|
||||
|
||||
```
|
||||
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.
|
||||
```
|
||||
## Settings
|
||||
|
||||
## How to fork this into a new plugin
|
||||
These settings are global (per Kanboard instance) and admin-only. Go to
|
||||
"Settings -> Shrink Vertically":
|
||||
|
||||
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.
|
||||
- **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.
|
||||
- **Top Horizontal Scrollbar thickness in pixels** -- thickness of the custom top
|
||||
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
|
||||
described above. Default: on.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
34
Template/config/show.php
Normal file
34
Template/config/show.php
Normal file
@@ -0,0 +1,34 @@
|
||||
<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->label(t('Top Horizontal 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. 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">
|
||||
<?= 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>
|
||||
|
||||
<div class="form-actions">
|
||||
<button type="submit" class="btn btn-blue"><?= t('Save') ?></button>
|
||||
</div>
|
||||
</form>
|
||||
3
Template/config/sidebar.php
Normal file
3
Template/config/sidebar.php
Normal file
@@ -0,0 +1,3 @@
|
||||
<li <?= $this->app->checkMenuSelection('ConfigController', 'show', 'ShrinkVertically') ?>>
|
||||
<?= $this->url->link(t('Shrink Vertically'), 'ConfigController', 'show', array('plugin' => 'ShrinkVertically')) ?>
|
||||
</li>
|
||||
@@ -1 +0,0 @@
|
||||
<div class="skeleton-plugin-marker">Skeleton</div>
|
||||
6
Template/layout/variable.php
Normal file
6
Template/layout/variable.php
Normal file
@@ -0,0 +1,6 @@
|
||||
<style type="text/css">
|
||||
: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;
|
||||
}
|
||||
</style>
|
||||
Reference in New Issue
Block a user