Ga naar hoofdinhoud

CnRowActions

Per-row action menu for tables and cards. Renders as a ⋯ button that opens a dropdown with the configured actions. Automatically marks destructive actions (e.g., Delete) with a danger style.

Wraps: NcActions, NcActionButton, NcActionLink

Try it​

Loading CnRowActions playground…

CnRowActions dropdown showing View, Edit, Copy, and Delete options for the focused row

Anatomy​

                      +----------------+
| 👁 View | ← navigate to detail
| ✏ Edit | ← open edit form
[ ⋯ ] ──opens──▶ | ⊕ Copy | ← duplicate the object
| ───────────── | ← divider before destructive actions
| 🗑 Delete | ← destructive: shown in red
+----------------+
↑
trigger button (last cell of every row)
RegionDescription
Trigger button⋯ icon button placed in the last column of the row; always visible on hover
Action itemsEach action renders with an optional icon and label
DividerAutomatically inserted before the first action marked destructive: true
Destructive actionsShown in the Nextcloud danger color to signal irreversible operations

Usage​

<CnRowActions
:actions="[
{ label: 'View', icon: EyeIcon, handler: (row) => openDetail(row) },
{ label: 'Edit', icon: PencilIcon, handler: (row) => openEditDialog(row) },
{ label: 'Copy', icon: ContentCopyIcon, handler: (row) => copyRow(row) },
{ label: 'Delete', icon: DeleteIcon, handler: (row) => confirmDelete(row), destructive: true },
]"
:row="row"
@action="onAction" />

The action event can be used as an alternative to handler functions:

function onAction({ action, row }) {
// action is the label string of the clicked action
if (action === 'Edit') openEditDialog(row)
if (action === 'Delete') confirmDelete(row)
}

Props​

PropTypeDefaultDescription
actionsArray[]Array of action definition objects (see Action definition below)
rowObjectnullThe row data object — passed as-is in the action event payload so handlers can access it
primaryBooleanfalseWhether to use primary styling for the action menu trigger
menuNameStringnullLabel shown on the action menu trigger button
inlineNumber0How many of the visible actions show as buttons beside the menu (0: all in the menu). The first is a tonal pill; an action with iconOnly: true is its icon, named by its label. The menu holds the rest and is left out when nothing is left.

Action definition​

FieldTypeRequiredDescription
labelString✓Display text for the action item. Also used as the action key in the emitted action event, and slugified into the entry's data-testid (cn-action-item-<slug>) and render key.
idString—The action's id, passed as id in the action event payload.
builtinBoolean—Set by CnIndexPage on its built-in View / Edit / Copy / Delete (ids view, edit, copy, delete). A built-in's data-testid is cn-action-item-<id> in every locale, its render key builtin:<id>, and its action payload carries builtin: true, so an app action with the same id stays a separate entry. Not for app actions.
iconObject|String—The icon to render. A component (e.g. a vue-material-design-icons component) is rendered directly. A string is treated as a CnIcon registry name (PascalCase, e.g. "Eye") and resolved via registerIcons(), falling back to the help-circle when unregistered — this lets manifest (JSON) actions declare icons by name.
handlerFunction—Called with the row value when the action is clicked: (row) => void
disabledBoolean|Function—When true, or when a function returning true for the given row, the item is not clickable
visibleBoolean|Function—Controls whether the item appears in the menu at all. Omit for "always shown". Pass false or a function returning false for the row to hide it. Useful for state-dependent actions (e.g. show Publish only when the row is unpublished).
visibleWhenObject—The JSON form of the same question, for a manifest, which cannot hold a function: { field, op, value } against the row, or an all / any composition of those. Evaluated synchronously, so only LOCAL conditions decide anything — one naming an endpoint or a source cannot be answered here and leaves the action shown rather than silently dropping it. Applied alongside visible; both must pass.
titleString|Function—Native tooltip shown on hover. Accepts a string or a function (row) => string. Useful for explaining why a disabled entry is disabled.
destructiveBoolean—When true, renders the action in danger color
hrefString|Function—Renders the entry as a real link to this URL (NcActionLink). Accepts a string or a function (row) => string.
toString|Object|Function—Renders the entry as a real link to this vue-router location (a path or { name, params }, or a function (row) => location). The href is resolved through the router; a plain click routes in place, a middle/ctrl click opens a new tab. When the router cannot resolve it, the entry stays a button.
linkTargetString—The link's target, e.g. _blank.

An action whose only job is to navigate should be a link, so the user can middle-click it, open it in a new tab or copy its address. Give it to (in-app) or href (URL) instead of a navigating handler:

<CnRowActions
:actions="[
{ label: 'View', icon: 'Eye', to: (row) => ({ name: 'LeadDetail', params: { id: row.id } }) },
{ label: 'Website', icon: 'Web', href: (row) => row.url, linkTarget: '_blank' },
{ label: 'Delete', icon: 'Delete', handler: deleteRow, destructive: true },
]"
:row="row" />

A link entry still emits action, so a host listening to it keeps working, but its handler is not called: the link does the navigating. A ctrl/cmd/shift click on a link opens a new tab and emits nothing, so a host's side effects never run in the tab the user is leaving. A disabled entry always renders as a button. CnIndexPage fills to / href in automatically for manifest actions with type: "navigate", type: "open-page" or handler: "navigate".

Conditional visibility example​

<CnRowActions
:actions="[
{ label: 'Publish', icon: PublishIcon, handler: publishRow, visible: (row) => !row.published },
{ label: 'Depublish', icon: PublishOffIcon, handler: depublishRow, visible: (row) => row.published },
{ label: 'Delete', icon: DeleteIcon, handler: deleteRow, destructive: true },
]"
:row="row" />

Events​

EventPayloadDescription
action{ action, row, id?, builtin? }Emitted when an action item is clicked. action is the label, row the value of the row prop, id the action's id when it has one, and builtin: true marks a CnIndexPage built-in.

The visibility rule (visible and a local visibleWhen), the testid, the render key and the payload are shared with CnContextMenu, so a CnIndexPage row's actions menu and its right-click menu always list the same entries.

Reference (auto-generated)​

The tables below are generated from the SFC source via vue-docgen-cli. They reflect what's actually in CnRowActions.vue and update automatically whenever the component changes.

OpenRegister reliance​

light: this component touches OpenRegister lightly. 0 direct references, 3 files reached through imports.

See the reliance overview for the filterable list.

Props​

NameTypeRequiredDefaultDescription
actionsArray<{label: string, id: string, builtin: boolean, icon: object &#124; string, handler: (targetItem: object) => void, disabled: boolean &#124; ((targetItem: object) => boolean), visible: boolean &#124; ((targetItem: object) => boolean), title: string &#124; ((targetItem: object) => string), destructive: boolean, href: string &#124; ((targetItem: object) => string), to: string &#124; object &#124; ((targetItem: object) => string &#124; object), linkTarget: string}>[]Action definitions. Each action supports: - label (string, required) — display text - icon (component | string) — MDI icon. A component renders directly; a string is treated as a registry name and rendered via CnIcon (PascalCase, e.g. "Eye"), falling back to the help-circle when unregistered. The string form lets manifest (JSON) actions declare icons by name. - handler (function) — called with row on click - disabled (boolean | (row) => boolean) — gray out the entry - visible (boolean | (row) => boolean) — when false, hide the entry from the menu (default: shown) - title (string | (row) => string) — native tooltip shown on hover (useful to explain why an entry is disabled) - destructive (boolean) — apply error color styling - href (string | (row) => string) — render the entry as a link to this URL - to (string | object | (row) => string | object) — render the entry as a link to this vue-router location; a plain click routes in place. Ignored when the router cannot resolve it. - linkTarget (string) — the link's target, e.g. _blank - id (string) — the action's id, passed in the action payload - builtin (boolean) — set by CnIndexPage on its built-in View / Edit / Copy / Delete; a built-in's testid is cn-action-item-&lt;id&gt; in every locale and its key builtin:&lt;id&gt; A link entry still emits action, but its handler is not called: the link is the navigation. A disabled entry, or a to without a resolvable route, stays a button.
rowobjectnullThe row/object data (passed to action handlers)
primarybooleanfalseWhether to use primary styling for the action menu trigger
rowLabelstring''The row's own name, for the board look's menu button: "Actions for <name>". Without it the button is named "Actions".
triggerLabelstring''The board look's menu button name, whole ("More actions for Sanne") and already translated. Wins over the "Actions for <rowLabel>" the button is named after otherwise.
menuNamestringundefinedLabel shown on the action menu trigger button
inlinenumber0How many of the visible actions show as buttons beside the menu (0, the default: all in the menu). The first is a tonal pill; an action with iconOnly: true is its icon, named by its label. The menu holds the rest and is left out when nothing is left.

Events​

NamePayloadDescription
action—User picked an entry. Payload: action (the label), the row, the action's id when it has one, and builtin: true for a CnIndexPage built-in. A button entry has already run its handler; a link entry navigates instead, and a modified (new-tab) click on a link emits nothing.

Board look​

Under the board look the menu is always one 34px menu button (three dots), named "Actions for <title>" from rowLabel, or by triggerLabel when the page names the whole label.