CnActionsBar

Toolbar that combines an item count display, a primary Add button, a view-mode toggle (Cards / Table), and an overflow actions menu containing Refresh, Import, Export, Copy-selected, and Delete-selected. All built-in mass actions are individually toggle-able.

Wraps: NcButton, NcActions, NcCheckboxRadioSwitch

Try it

Loading CnActionsBar playground…

Usage

<CnActionsBar
  :pagination="pagination"
  :object-count="items.length"
  :selected-ids="selectedIds"
  add-label="Add Client"
  add-icon="AccountGroup"
  @add="createNew"
  @refresh="reload"
  @show-import="openImport"
  @show-export="openExport"
  @show-copy="openMassCopy"
  @show-delete="openMassDelete"
  @view-mode-change="viewMode = $event" />

Custom action items can be injected into the overflow menu:

<CnActionsBar ...>
  <template #action-items>
    <NcActionButton @click="openReport">
      <template #icon><ChartBar :size="20" /></template>
      Export report
    </NcActionButton>
  </template>
</CnActionsBar>

Props

Prop	Type	Default	Description
pagination	Object	null	Pagination state { total, page, pages, limit } — used to render "Showing X of Y"
objectCount	Number	0	Number of currently visible items
selectable	Boolean	true	Whether rows/cards can be selected
selectedIds	Array	[]	Currently selected item IDs — controls disabled state of mass actions
addLabel	String	'Add'	Label for the primary Add button
addIcon	String	''	MDI icon name for the Add button (falls back to Plus)
showAdd	Boolean	true	Whether to show the Add button
addDisabled	Boolean	false	Whether the Add button is disabled
viewMode	String	'table'	Current view mode: 'table' or 'cards'
showViewToggle	Boolean	true	Whether to show the Cards/Table toggle
refreshing	Boolean	false	Whether a refresh is currently in progress
refreshDisabled	Boolean	false	Whether the Refresh action is disabled
showMassImport	Boolean	true	Whether to show the Import action
showMassExport	Boolean	true	Whether to show the Export action
showMassCopy	Boolean	true	Whether to show the Copy selected action
showMassDelete	Boolean	true	Whether to show the Delete selected action
inlineActionCount	Number	2	How many actions to show inline (rest go in overflow)
showRequestFeature	Boolean	false	Show a built-in "Request a feature" entry in the overflow (after Refresh + headerActions). Emits @request-feature; the host opens the CnSuggestFeatureModal

Events

Event	Payload	Description
add	—	Add button clicked
refresh	—	Refresh action triggered
request-feature	—	Built-in "Request a feature" overflow item clicked (only when showRequestFeature)
view-mode-change	'table' | 'cards'	View toggle changed
show-import	—	Import action triggered
show-export	—	Export action triggered
show-copy	—	Copy selected action triggered
show-delete	—	Delete selected action triggered

Slots

Slot	Scope	Description
header-actions	—	Extra buttons placed after the Add button, before the overflow menu
action-items	—	Extra NcActionButton items injected into the overflow menu
mass-actions	{ count, selectedIds }	Extra mass-action items at the bottom of the overflow menu

Documentation link

Set documentationUrl to add a Documentation entry to the overflow menu (just before Request a feature). It renders as a link that opens the URL in a new tab (target="_blank", rel="noopener noreferrer"); customise the wording with documentationLabel. Empty (the default) hides it. This mirrors the widget Actions menu's Documentation entry. CnIndexPage forwards its own documentationUrl / documentationLabel props here.

Reference (auto-generated)

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

Props

Name	Type	Required	Default	Description
pagination	object		null	Pagination state: { total, page, pages, limit }
objectCount	number		0	Number of currently visible objects (for "Showing X of Y")
selectable	boolean		true	Whether rows/cards can be selected
selectedIds	array		[]	Currently selected IDs
addLabel	string		() => t('nextcloud-vue', 'Add')	Label for the Add button
addIcon	string		''	MDI icon name for the Add button (e.g. 'AccountGroup'). Falls back to Plus icon.
inlineActionCount	number		0	How many action buttons to show inline (rest go in overflow dropdown)
showMassImport	boolean		true	Whether to show the built-in mass Import action
showMassExport	boolean		true	Whether to show the built-in mass Export action
showMassCopy	boolean		true	Whether to show the built-in mass Copy action
showMassDelete	boolean		true	Whether to show the built-in mass Delete action
viewMode	string		'table'	Current view mode: 'table' or 'cards'
showViewToggle	boolean		true	Whether to show the Cards/Table view toggle
refreshing	boolean		false	Whether the refresh action is currently in progress
refreshDisabled	boolean		false	Whether the refresh action is disabled (e.g. when required selections are missing)
addDisabled	boolean		false	Whether the Add button is disabled (e.g. when required selections are missing)
showAdd	boolean		true	Whether to show the Add button

Events

Name	Payload	Description
view-mode-change	—
add	—
refresh	—
show-import	—
show-export	—
show-copy	—
show-delete	—

Slots

Name	Bindings	Description
actions	—
action-items	—
mass-actions	count, selected-ids