CnActionsMenu

CnActionsMenu is the shared … overflow Actions menu that renders the canonical built-in action trio used across every Conduction surface:

1. Refresh
2. Documentation (only when a documentationUrl is supplied)
3. Request a feature

It also auto-mounts the CnSuggestFeatureModal for the Request-a-feature default. It's used internally by CnWidgetWrapper (per-widget menu) and by the page-level headers of CnDetailPage and CnDashboardPage, so widgets and pages stay in lockstep. CnActionsBar (list pages) mirrors the same items inline.

Most apps never instantiate CnActionsMenu directly — they configure it through the host component's props (documentation-url, show-refresh, show-request-feature, …). Reach for it directly only when building a new surface that needs the same trio.

Behaviour

• Refresh — emits @refresh with { widgetId, title }. Unless a host listener calls event.preventDefault() on the second handler argument, it then emits on the @nextcloud/event-bus channel named by refreshChannel (cn:widget:refresh for widgets, cn:page:refresh for pages).
• Documentation — rendered as an NcActionLink only when documentationUrl is non-empty. Opens the link in a new tab (target="_blank" + rel="noopener noreferrer"); there is no JS handler.
• Request a feature — emits @request-feature with { widgetId, title }, then (unless suppressed) opens CnSuggestFeatureModal with app + page + surface context auto-filled from the cnAppId / cnFeatureRequestRepo injects provided by CnAppRoot. Without a resolvable repo it logs a one-line console.warn and skips opening.

The overflow trigger hides itself entirely when no built-in item is visible and no #action-items slot content is supplied.

The data-testids are derived from testidBase: <base>-actions (container), <base>-action-refresh, <base>-action-documentation, <base>-action-request-feature. Each host passes its own base (e.g. cn-widget-wrapper, cn-detail-page).

Usage

<CnActionsMenu
  :widget-id="resolvedId"
  :title="title"
  :surface="`detail:${resolvedId}`"
  :documentation-url="documentationUrl"
  refresh-channel="cn:page:refresh"
  testid-base="cn-detail-page"
  @refresh="onRefresh"
  @request-feature="onRequestFeature">
  <template #action-items>
    <NcActionButton @click="…">Custom action</NcActionButton>
  </template>
</CnActionsMenu>

Slots

Slot	Description
action-items	Additional NcActionButton-family items appended inside the overflow menu, after the built-in Refresh / Documentation / Request-a-feature group.

Labels & state props

Prop	Default	Description
documentationLabel	t('Documentation')	Pre-translated label for the Documentation item.
refreshLabel	t('Refresh')	Pre-translated label for the Refresh item.
requestFeatureLabel	t('Request a feature')	Pre-translated label for the Request-a-feature item.
actionsMenuLabel	t('Actions')	Pre-translated aria-label / tooltip for the overflow trigger.
refreshing	false	While true, the Refresh item is disabled and shows a loading spinner — for exactly as long as this stays true, so it reflects the real refresh time.
specRef	''	Forwarded to the auto-mounted CnSuggestFeatureModal.

Reference (auto-generated)

The table below is generated from the SFC source via vue-docgen-cli and updates automatically whenever the component changes.

Props

Name	Type	Required	Default	Description
showRefresh	boolean		true	Whether the Refresh item renders. The parent surface is responsible for any opt-out aliasing (e.g. CnWidgetWrapper's hideRefresh) and passes the resolved boolean here.
showRequestFeature	boolean		true	Whether the Request-a-feature item renders.
documentationUrl	string		''	Explicit documentation link target, opened in a new tab. Wins over the cnDocumentationBaseUrl + docsAnchor pair. Leave empty (the default) to let the menu build the per-widget deep-link itself.
docsAnchor	string		''	This surface's own section in the app's documentation, appended to the app-wide cnDocumentationBaseUrl. A bare slug (open-cases) becomes a #fragment; a value starting with / is resolved as a path; a full scheme:// URL is used as written. Supplying it is what makes the Documentation item land on THIS widget's section rather than the docs homepage.
showDocumentation	boolean		true	Whether the Documentation item renders. Defaults to true — the canonical trio is meant to be present on every surface; set false only where a docs link genuinely cannot exist.
showReportBug	boolean		true	Whether the "Report a bug" item renders.
reportBugUrl	string		''	Explicit "Report a bug" target. Empty (the default) builds a new-issue deep-link on the app's forge from the injected cnFeatureRequestRepo + cnFeatureRequestForge, pre-filled with the surface's title.
reportBugLabel	string		() => t('nextcloud-vue', 'Report a bug')	Pre-translated label for the Report-a-bug action.
documentationLabel	string		() => t('nextcloud-vue', 'Documentation')	Pre-translated label for the Documentation item. Defaults to the lib's translation of "Documentation".
widgetId	string		''	Stable id forwarded on the @refresh / @request-feature payloads (as widgetId) and on the cn:widget:refresh event-bus payload. The parent resolves it (explicit id or slugified title).
title	string		''	Human-readable title carried on action payloads.
surface	string		''	Full surface string forwarded to the auto-mounted CnSuggestFeatureModal so the resulting GitHub issue records where the request originated (e.g. widget:<id>, detail:<id>, dashboard:<id>).
specRef	string		''	Optional specRef forwarded to the auto-mounted CnSuggestFeatureModal so the issue links to the spec capability this surface belongs to.
refreshing	boolean		false	Whether a refresh is currently in flight. While true, the Refresh item is disabled and shows a loading spinner for exactly as long as this stays true — so the spinner reflects the real refresh time.
refreshChannel	string		'cn:widget:refresh'	Event-bus channel the default Refresh handler emits on when no host listener suppresses it. Widgets use cn:widget:refresh; page surfaces pass cn:page:refresh.
refreshLabel	string		() => t('nextcloud-vue', 'Refresh')	Pre-translated label for the Refresh action.
requestFeatureLabel	string		() => t('nextcloud-vue', 'Request a feature')	Pre-translated label for the Request-a-feature action.
actionsMenuLabel	string		() => t('nextcloud-vue', 'Actions')	Pre-translated aria-label / tooltip for the overflow trigger.
testidBase	string		'cn-actions-menu'	Prefix for the data-testids emitted on the menu container and its items: <base>-actions (container), <base>-action-refresh, <base>-action-request-feature, <base>-action-report-bug, <base>-action-documentation. Lets each host keep its own stable testids.

Events

Name	Payload	Description
refresh	undefined	User clicked the Refresh item. Payload: { widgetId, title }. Handlers may call the second arg's preventDefault() to suppress the built-in default (event-bus emit on refreshChannel).
request-feature	undefined	User clicked the Request a feature item. Payload: { widgetId, title }. Handlers may call the second arg's preventDefault() to suppress the built-in default (auto-opening CnSuggestFeatureModal).

Slots

Name	Bindings	Description
action-items	—	action-items Additional NcActionButton-family items

The mandatory trio

Request a feature, Report a bug and Documentation render on every surface. None of them is conditional on a URL being configured: the menu resolves each target itself, so a host that passes nothing still gets all three. That is the point — the items used to be per-host markup, and OpenRegister's widget menus shipped without the Documentation entry while OpenCatalogi's were inconsistent.

Prop	Default	Description
docsAnchor	''	This surface's own section in the app's documentation, appended to the app-wide base. A bare slug (open-cases) becomes a #fragment; a value starting with / is resolved as a path; a full scheme:// URL is used as written. Supplying it per widget is what makes the docs link land on that widget's section instead of the docs homepage.
showDocumentation	true	Whether the Documentation item renders. For the rare surface that must suppress it deliberately.
showReportBug	true	Whether the Report-a-bug item renders.
reportBugUrl	''	Explicit bug-report target. Empty builds a new-issue deep-link on the app's own forge from the injected cnFeatureRequestRepo / cnFeatureRequestForge, pre-filled with the surface's title.
reportBugLabel	t('Report a bug')	Pre-translated label for the Report-a-bug item.

Where the documentation link points

The target is resolved in this order:

1. the documentationUrl prop, if set (deep-linked with docsAnchor when both are given);
2. the app-wide cnDocumentationBaseUrl provided by CnAppRoot, plus docsAnchor;
3. the app's conventional docs site derived from cnAppId — a last resort so the item is never simply missing.

An app that hosts its docs anywhere else should provide cnDocumentationBaseUrl rather than pass a URL per widget.