@conduction/nextcloud-vue 2.84.0 → 2.85.0

package/src/components/CnBoardView/CnBoardView.vue

@@ -5,7 +5,7 @@
 <template>
 	<div
 		class="cn-board-view"
-		:class="{ 'cn-board-view--board': isBoardLook }"
+		:class="{ 'cn-board-view--board': isBoardLook, 'cn-board-view--wrap': wrapColumns, 'cn-board-view--selecting': selectedKeys.length > 0 }"
 		data-testid="cn-board-view">
 		<p v-if="!usable" class="cn-board-view__unusable" data-testid="cn-board-unusable">
 			{{ unusableText }}
@@ -36,9 +36,11 @@
 					v-for="column in lane.columns"
 					:key="`col-${lane.key}-${column.key}`"
 					class="cn-board-view__column"
+					:class="{ 'cn-board-view__column--unreachable': isUnreachable(column) }"
 					role="listitem"
 					data-testid="cn-board-column"
 					:data-column="column.key"
+					:data-unreachable="isUnreachable(column) ? 'true' : null"
 					@dragover.prevent
 					@drop="onDrop(column, $event)">
 					<!-- Board look: a dot, the label and a white count badge, with an
@@ -116,11 +118,21 @@
 							:data-card-id="cardKey(card)"
 							:draggable="canMove"
 							@dragstart="onDragStart(card, column, $event)"
+							@dragend="onDragEnd"
 							@keydown="onCardKeydown(card, column, lane, $event)">
 							<!-- Board look: title link, sub line, pill, footer, and a
 							     menu button instead of the Move to select. -->
 							<template v-if="isBoardLook">
 								<div class="cn-board-view__card-head">
+									<input
+										v-if="selectable"
+										type="checkbox"
+										class="cn-board-view__select"
+										data-testid="cn-board-card-select"
+										:data-card-id="cardKey(card)"
+										:checked="isSelected(card)"
+										:aria-label="selectLabel(card)"
+										@change="toggleSelected(card)">
 									<a
 										href="#"
 										class="cn-board-view__card-title"
@@ -164,8 +176,14 @@
 													class="cn-board-view__menu-item"
 													data-testid="cn-board-menu-move"
 													:data-target="target.key"
-													@click="onMenuMove(card, column, target)">
+													:aria-disabled="isMoveAllowed(card, target) ? null : 'true'"
+													:class="{ 'cn-board-view__menu-item--blocked': !isMoveAllowed(card, target) }"
+													@click="isMoveAllowed(card, target) && onMenuMove(card, column, target)">
 													{{ target.label }}
+													<span
+														v-if="!isMoveAllowed(card, target)"
+														class="cn-board-view__menu-note"
+														data-testid="cn-board-menu-blocked">{{ notAllowedLabel }}</span>
 												</button>
 											</div>
 											<button
@@ -216,6 +234,16 @@
 								</span>
 							</template>
 							<template v-else>
+								<label v-if="selectable" class="cn-board-view__select-label">
+									<input
+										type="checkbox"
+										class="cn-board-view__select"
+										data-testid="cn-board-card-select"
+										:data-card-id="cardKey(card)"
+										:checked="isSelected(card)"
+										:aria-label="selectLabel(card)"
+										@change="toggleSelected(card)">
+								</label>
 								<span
 									v-if="dueLabel(card)"
 									class="cn-board-view__due"
@@ -354,6 +382,12 @@ export default {
 		 * draws the screens' board anatomy (screens-kanban-parity).
 		 */
 		cnLook: { default: 'nextcloud' },
+		/**
+		 * The app's cell-formatter registry, provided by CnAppRoot. A card
+		 * role named in `cardRoles.formatters` shows its value through it, as
+		 * the table's cells do (screens-board-reference-columns).
+		 */
+		cnFormatters: { default: () => ({}) },
 	},
 
 	props: {
@@ -494,9 +528,72 @@ export default {
 			type: Number,
 			default: 0,
 		},
+
+		/**
+		 * The column a row belongs in, for a status whose raw value is not
+		 * the column key: a reference whose rows are merged by name
+		 * (screens-board-reference-columns). Absent, the row's `statusField`
+		 * value is the key.
+		 *
+		 * @type {((row: object) => string)|null}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-columns-can-be-the-rows-a-field-references
+		 */
+		columnKeyOf: {
+			type: Function,
+			default: null,
+		},
+
+		/**
+		 * Wrap the columns onto more rows, as many to a row as fit at 240px,
+		 * instead of one row that scrolls sideways (manifest
+		 * `config.board.wrap`). For a board with more stages than fit.
+		 *
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-a-wide-board-can-wrap-its-columns
+		 */
+		wrapColumns: {
+			type: Boolean,
+			default: false,
+		},
+
+		/**
+		 * Offer a checkbox on every card, so cards can be selected for the
+		 * list's bulk actions (the same selection the table holds).
+		 *
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-cards-can-be-selected-for-bulk-actions
+		 */
+		selectable: {
+			type: Boolean,
+			default: false,
+		},
+
+		/**
+		 * The selected cards, by row key.
+		 *
+		 * @type {Array<string|number>}
+		 */
+		selectedIds: {
+			type: Array,
+			default: () => [],
+		},
+
+		/**
+		 * The columns one card may move to, asked when its menu opens or its
+		 * drag starts: `(card) => Promise<Array<string>|null>`, column keys,
+		 * `null` for every column. A column the card cannot reach is greyed
+		 * during the drag and marked "not allowed" in the menu, and a drop on
+		 * it is refused without asking the host. Absent, every column is
+		 * offered and the host's move decides.
+		 *
+		 * @type {((card: object) => Promise<Array<string>|null>)|null}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-the-board-shows-where-a-card-can-go
+		 */
+		allowedMoves: {
+			type: Function,
+			default: null,
+		},
 	},
 
-	emits: ['card-click', 'card-aux-click', 'moved', 'refused', 'stale', 'load-more'],
+	emits: ['card-click', 'card-aux-click', 'moved', 'refused', 'stale', 'load-more', 'select'],
 
 	data() {
 		return {
@@ -512,6 +609,10 @@ export default {
 			expanded: [],
 			/** The card whose menu is open (board look), by card key. */
 			openMenuKey: null,
+			/** Column keys each card may move to (`allowedMoves`), by card key; absent = not asked yet. */
+			allowedByCard: {},
+			/** The column keys the dragged card may reach, or null for all. */
+			dragAllowed: null,
 		}
 	},
 
@@ -529,6 +630,7 @@ export default {
 				statusField: this.statusField,
 				offBoardLabel: t('nextcloud-vue', 'Elsewhere'),
 				colorField: this.colorField,
+				keyOf: this.columnKeyOf,
 			})
 		},
 
@@ -556,9 +658,20 @@ export default {
 				due: (given && given.due) || '',
 				owner: (given && given.owner) || '',
 				pillColors: (given && given.pillColors) || {},
+				formatters: (given && given.formatters && typeof given.formatters === 'object') ? given.formatters : {},
 			}
 		},
 
+		/** @return {string} The note on a menu target the card cannot reach. */
+		notAllowedLabel() {
+			return t('nextcloud-vue', 'not allowed')
+		},
+
+		/** @return {Array<string>} The selected row keys as strings. */
+		selectedKeys() {
+			return (Array.isArray(this.selectedIds) ? this.selectedIds : []).map(String)
+		},
+
 		/** @return {string} The Open in new tab menu item. */
 		openInNewTabLabel() {
 			return t('nextcloud-vue', 'Open in new tab')
@@ -617,6 +730,97 @@ export default {
 
 		preventMiddleClickAutoscroll,
 
+		/**
+		 * Whether a card is selected.
+		 *
+		 * @param {object} card The card.
+		 * @return {boolean} True when selected.
+		 */
+		isSelected(card) {
+			return this.selectedKeys.includes(this.cardKey(card))
+		},
+
+		/**
+		 * The checkbox's accessible name.
+		 *
+		 * @param {object} card The card.
+		 * @return {string} "Select <name>".
+		 */
+		selectLabel(card) {
+			const name = this.roleText(card, this.roles.title) || this.cardKey(card)
+			return t('nextcloud-vue', 'Select {name}', { name })
+		},
+
+		/**
+		 * Select a card, or unselect it.
+		 *
+		 * @param {object} card The card.
+		 * @return {void}
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-cards-can-be-selected-for-bulk-actions
+		 */
+		toggleSelected(card) {
+			const key = this.cardKey(card)
+			const next = this.isSelected(card)
+				? this.selectedIds.filter((id) => String(id) !== key)
+				: [...this.selectedIds, card?.[this.rowKey]]
+			/**
+			 * @event select Emitted when a card's checkbox changes. Payload: the selected row keys.
+			 */
+			this.$emit('select', next)
+		},
+
+		/**
+		 * Ask the host where one card may go (`allowedMoves`), once per card.
+		 *
+		 * @param {object} card The card.
+		 * @return {Promise<Array<string>|null>} The column keys, or null for all.
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-the-board-shows-where-a-card-can-go
+		 */
+		async loadAllowed(card) {
+			if (typeof this.allowedMoves !== 'function') {
+				return null
+			}
+			const key = this.cardKey(card)
+			if (Object.hasOwn(this.allowedByCard, key)) {
+				return this.allowedByCard[key]
+			}
+			let allowed
+			try {
+				const answer = await this.allowedMoves(card)
+				allowed = Array.isArray(answer) ? answer.map(String) : null
+			} catch {
+				// Unknown is not "nowhere": the host's move stays the authority.
+				allowed = null
+			}
+			this.allowedByCard = { ...this.allowedByCard, [key]: allowed }
+			return allowed
+		},
+
+		/**
+		 * Whether a card may move to a column, as far as the board knows.
+		 *
+		 * @param {object} card The card.
+		 * @param {object} target The column.
+		 * @return {boolean} False only when the host said it cannot.
+		 */
+		isMoveAllowed(card, target) {
+			const allowed = this.allowedByCard[this.cardKey(card)]
+			return !Array.isArray(allowed) || allowed.includes(String(target.key))
+		},
+
+		/**
+		 * Whether a column is out of reach for the card being dragged.
+		 *
+		 * @param {object} column The column.
+		 * @return {boolean} True while a drag is on and the card cannot go there.
+		 */
+		isUnreachable(column) {
+			return this.dragging !== null
+				&& Array.isArray(this.dragAllowed)
+				&& column.key !== this.dragging.fromKey
+				&& !this.dragAllowed.includes(String(column.key))
+		},
+
 		/**
 		 * A card's due state under `dueRule`.
 		 *
@@ -658,11 +862,35 @@ export default {
 			const fields = Array.isArray(role) ? role : [role]
 			return fields
 				.filter((field) => typeof field === 'string' && field !== '')
-				.map((field) => this.textOf(readPath(card, field)))
+				.map((field) => this.fieldText(card, field))
 				.filter((value) => value !== '')
 				.join(' \u00b7 ')
 		},
 
+		/**
+		 * One card field as text: through the formatter `cardRoles.formatters`
+		 * names for it, else the value itself.
+		 *
+		 * @param {object} card The card's row.
+		 * @param {string} field The dot-path.
+		 * @return {string} The text.
+		 * @spec openspec/changes/screens-board-reference-columns/specs/board-view/spec.md#requirement-a-card-field-can-show-through-a-formatter
+		 */
+		fieldText(card, field) {
+			const raw = readPath(card, field)
+			const id = this.roles.formatters[field]
+			const fn = id && this.cnFormatters ? this.cnFormatters[id] : null
+			if (typeof fn === 'function') {
+				try {
+					const out = fn(raw, card, null)
+					return out === null || out === undefined ? '' : String(out).trim()
+				} catch {
+					return this.textOf(raw)
+				}
+			}
+			return this.textOf(raw)
+		},
+
 		/**
 		 * A value as text: a string or number as is, an object by its label.
 		 *
@@ -687,7 +915,7 @@ export default {
 		 * @return {string} A CnStatusBadge variant.
 		 */
 		pillVariant(card) {
-			const raw = this.textOf(readPath(card, this.roles.pill))
+			const raw = this.fieldText(card, this.roles.pill)
 			const variant = this.roles.pillColors[raw] ?? this.roles.pillColors[raw.toLowerCase()]
 			return isBadgeVariant(variant) ? variant : 'default'
 		},
@@ -727,7 +955,7 @@ export default {
 		 * @return {string} The name, '' when there is none.
 		 */
 		ownerName(card) {
-			return this.roles.owner === '' ? '' : this.textOf(readPath(card, this.roles.owner))
+			return this.roles.owner === '' ? '' : this.fieldText(card, this.roles.owner)
 		},
 
 		/**
@@ -879,6 +1107,7 @@ export default {
 			const key = this.cardKey(card)
 			this.openMenuKey = this.openMenuKey === key ? null : key
 			if (this.openMenuKey !== null) {
+				this.loadAllowed(card)
 				this.focusMenuItem(card, 0)
 			}
 		},
@@ -967,6 +1196,7 @@ export default {
 				event.preventDefault()
 				if (!this.isMenuOpen(card)) {
 					this.openMenuKey = this.cardKey(card)
+					this.loadAllowed(card)
 					this.focusMenuItem(card, 0)
 				}
 			}
@@ -1113,8 +1343,27 @@ export default {
 		 */
 		onDragStart(card, column, event) {
 			this.dragging = { card, fromKey: column.key }
+			this.dragAllowed = null
 			// Firefox drops a drag that carries no data.
 			event?.dataTransfer?.setData?.('text/plain', this.cardKey(card))
+			if (typeof this.allowedMoves === 'function') {
+				this.loadAllowed(card).then((allowed) => {
+					if (this.dragging && this.dragging.card === card) {
+						this.dragAllowed = allowed
+					}
+				})
+			}
+		},
+
+		/**
+		 * The drag ended (dropped anywhere, or cancelled): no column stays
+		 * greyed. A drop on a column has already run by now.
+		 *
+		 * @return {void}
+		 */
+		onDragEnd() {
+			this.dragging = null
+			this.dragAllowed = null
 		},
 
 		/**
@@ -1129,6 +1378,13 @@ export default {
 			}
 			const { card, fromKey } = this.dragging
 			this.dragging = null
+			this.dragAllowed = null
+			if (column.key !== fromKey && !this.isMoveAllowed(card, column)) {
+				const name = this.roleText(card, this.roles.title) || this.cardKey(card)
+				this.refusal = t('nextcloud-vue', '{name} cannot move to {column}.', { name, column: column.label })
+				this.$emit('refused', { card, message: this.refusal })
+				return
+			}
 			await this.move(card, fromKey, column.key)
 		},
 

package/src/components/CnDashboardGrid/CnDashboardGrid.vue

@@ -28,12 +28,12 @@
 
 		<div class="grid-stack">
 			<div
-				v-for="(item, index) in layout"
+				v-for="item in itemsInRowOrder"
 				:key="resolveItemKey(item)"
 				class="grid-stack-item"
 				:class="{ 'cn-dashboard-grid__item--fit': sizeToContentAttr(item) !== undefined }"
 				role="group"
-				:aria-label="resolveItemLabel(item, index)"
+				:aria-label="resolveItemLabel(item, layout.indexOf(item))"
 				:aria-describedby="itemDescribedBy"
 				:tabindex="itemTabindex"
 				:gs-id="item.id"
@@ -71,6 +71,7 @@
 <script>
 import { translate as t } from '@nextcloud/l10n'
 import { GridStack } from 'gridstack'
+import { planGrowth } from '../../utils/gridStack.js'
 // `gridstack` is a peerDependency (see package.json), not bundled — this
 // component's JS and the consumer's GridStack stylesheet MUST come from the
 // exact same installed copy, because GridStack's JS writes layout state
@@ -333,6 +334,30 @@ export default {
 	},
 
 	computed: {
+		/**
+		 * The layout's items top to bottom, then left to right: the order the
+		 * items are in the page, so GridStack places them in that order.
+		 *
+		 * GridStack sizes a size-to-content cell while it adds the items, one
+		 * at a time, and an item it adds onto a cell that has already grown
+		 * moves itself below whatever it then collides with. In the layout's
+		 * own order a card declared after the lists (pipelinq's full-width
+		 * "client in focus" card) was added last, so when the banner above
+		 * it grew it skipped past the stat tiles AND the lists and landed at
+		 * the bottom. Added top to bottom, every card lands under the one
+		 * above it. It is also the order a screen reader and the Tab key
+		 * follow. An item without a row or column sorts after the items
+		 * that have one, in the layout's order.
+		 *
+		 * @spec openspec/changes/dashboard-growth-keeps-order/specs/dashboard-grid/spec.md#requirement-a-growing-cell-keeps-the-order-of-the-cards-under-it
+		 * @return {Array<object>} The items in row order.
+		 */
+		itemsInRowOrder() {
+			const items = Array.isArray(this.layout) ? [...this.layout] : []
+			const at = (value) => (Number.isFinite(value) ? value : Number.MAX_SAFE_INTEGER)
+			return items.sort((a, b) => (at(a.gridY) - at(b.gridY)) || (at(a.gridX) - at(b.gridX)))
+		},
+
 		/**
 		 * Whether the grid draws each layout row as ROW_SPLIT finer rows. A
 		 * size-to-content cell can only be a whole number of rows tall, so on
@@ -608,6 +633,13 @@ export default {
 			)
 		},
 
+		/**
+		 * Build the GridStack grid on the rendered items, install the growth
+		 * wrapper (`keepOrderOnGrowth`) and listen for its changes.
+		 *
+		 * @spec openspec/changes/dashboard-growth-keeps-order/specs/dashboard-grid/spec.md#requirement-a-growing-cell-keeps-the-order-of-the-cards-under-it
+		 * @return {void}
+		 */
 		initGrid() {
 			if (this.cellHeightCssVar && typeof document !== 'undefined' && document.documentElement) {
 				document.documentElement.style.setProperty(this.cellHeightCssVar, `${this.cellHeight}px`)
@@ -624,6 +656,7 @@ export default {
 				removable: false,
 				...(this.columnOpts ? { columnOpts: this.columnOpts } : {}),
 			}, el)
+			this.keepOrderOnGrowth()
 
 			this.grid.on('change', (_event, items) => {
 				this.handleGridChange(items)
@@ -635,6 +668,87 @@ export default {
 			this.syncInteractivity()
 		},
 
+		/**
+		 * Let a size-to-content cell that grows push the cards under it down in
+		 * their order. GridStack resolves that collision itself, but not in
+		 * order: when pipelinq's banner grew from two rows to three, the
+		 * full-width card under the stat tiles landed below the lists, also
+		 * with `float: false`. Every grow after the grid is built, whether
+		 * GridStack measures it on resize or this grid's content observer asks
+		 * for it, now first moves the cards the growth reaches down by the
+		 * growth (`planGrowth`), bottom-most first, and only then grows the
+		 * cell, so GridStack has no collision left to resolve. The wrapper is
+		 * installed after `GridStack.init` has already measured the cells on
+		 * load; the order on load comes from adding the items in row order
+		 * (`itemsInRowOrder`). A cell that shrinks is left to GridStack as
+		 * before.
+		 *
+		 * @spec openspec/changes/dashboard-growth-keeps-order/specs/dashboard-grid/spec.md#requirement-a-growing-cell-keeps-the-order-of-the-cards-under-it
+		 * @return {void}
+		 */
+		keepOrderOnGrowth() {
+			const grid = this.grid
+			if (!grid || typeof grid.resizeToContent !== 'function' || typeof grid.update !== 'function') {
+				return
+			}
+			const resize = grid.resizeToContent.bind(grid)
+			grid.resizeToContent = (el) => {
+				const node = el && el.gridstackNode
+				const nodes = grid.engine && Array.isArray(grid.engine.nodes) ? grid.engine.nodes : null
+				const rows = node && nodes ? this.contentRows(el, node) : null
+				const plan = rows ? planGrowth(nodes, node, rows) : []
+				if (plan.length === 0) {
+					resize(el)
+					return
+				}
+				// Inside a batch the moves are not packed until the cell has grown.
+				const batching = Boolean(grid.engine.batchMode)
+				if (!batching) {
+					grid.batchUpdate()
+				}
+				for (const step of plan) {
+					grid.update(step.node.el, { y: step.y })
+				}
+				resize(el)
+				if (!batching) {
+					grid.batchUpdate(false)
+				}
+			}
+		},
+
+		/**
+		 * The rows a size-to-content cell needs for its content, measured the
+		 * way GridStack's `resizeToContent` measures it (the content's first
+		 * child, plus the cell's own padding), within its size-to-content row
+		 * maximum and its minimum and maximum height.
+		 *
+		 * @spec openspec/changes/dashboard-growth-keeps-order/specs/dashboard-grid/spec.md#requirement-a-growing-cell-keeps-the-order-of-the-cards-under-it
+		 * @param {HTMLElement} el The cell.
+		 * @param {object} node Its GridStack node.
+		 * @return {number|null} The rows, or null when it cannot be measured.
+		 */
+		contentRows(el, node) {
+			const cell = this.grid.getCellHeight(true)
+			const item = el.querySelector('.grid-stack-item-content')
+			const child = item && item.firstElementChild
+			if (!el.clientHeight || !cell || !child || !Number.isFinite(node.h)) {
+				return null
+			}
+			const padding = el.clientHeight - item.clientHeight
+			const itemHeight = node.h * cell - padding
+			const wanted = child.getBoundingClientRect().height || itemHeight
+			let rows = Math.ceil((node.h * cell + wanted - itemHeight) / cell)
+			if (Number.isInteger(node.sizeToContent) && rows > node.sizeToContent) {
+				rows = node.sizeToContent
+			}
+			if (node.minH && rows < node.minH) {
+				rows = node.minH
+			} else if (node.maxH && rows > node.maxH) {
+				rows = node.maxH
+			}
+			return rows
+		},
+
 		/**
 		 * Keep both editing lanes in step with whether an edit could actually be
 		 * kept: the pointer's handles, and — through `reflowed` feeding