CnSettingsSection
Admin settings section with loading and error states. Wraps NcSettingsSection with async data fetching patterns.
Wraps: NcSettingsSection, NcLoadingIcon, NcButton, NcNoteCard
Try it
Loading CnSettingsSection playground…


Props
| Prop | Type | Default | Description |
|---|---|---|---|
name | String | (required) | Section title (passed to NcSettingsSection) |
actionsInTitle | Boolean | false | Draw the actions slot in the title row beside the heading, as the boards do, instead of floating it right above the content |
description | String | '' | Brief section description shown under the title |
detailedDescription | String | '' | Longer description rendered in a separate block below the title |
docUrl | String | '' | Documentation URL — shows an info icon link next to the title |
openedFrom | String | '' | The row this card is opened from, already translated: the card shows only while the page's hash names its id, and says "Opened from the row {row}" under its title in place of its description (DqInstellingen). Empty: the card is always shown. |
loading | Boolean | false | Loading state — shows a loading indicator instead of content |
loadingMessage | String | 'Loading...' | Message shown during loading |
error | Boolean | false | Error state — shows an error card with optional retry button |
errorMessage | String | 'An error occurred' | Message shown in error state |
onRetry | Function | null | Callback for the retry button. When null, no retry button is shown. |
retryButtonText | String | 'Retry' | Label for the retry button |
empty | Boolean | false | Empty state — shows an empty message instead of content |
emptyMessage | String | 'No data available' | Message shown when the section has no data |
footerLink | Object | null | { label, href }: a link at the end of the card to where its list is managed ("Leges beheren in shillinq"), drawn only with both and a safe href. The label is already translated. |
Slots
| Slot | Description |
|---|---|
default | Section content |
#actions | Extra action buttons |
#description | Custom description content (replaces description prop) |
#footer | Footer content rendered below the section body |
#empty | Custom empty state (replaces the default empty message) |
Usage
<CnSettingsSection
name="API Configuration"
description="Configure the external API connection"
:loading="loading"
:error="hasError"
error-message="Could not load settings"
:on-retry="fetchSettings">
<NcTextField label="API URL" v-model="apiUrl" />
<NcTextField label="API Key" v-model="apiKey" type="password" />
</CnSettingsSection>
Reference (auto-generated)
The tables below are generated from the SFC source via vue-docgen-cli. They reflect what's actually in CnSettingsSection.vue and update automatically whenever the component changes.
OpenRegister reliance
none: this component does not touch OpenRegister, directly or through anything it imports. 0 direct references, 0 files reached through imports.
See the reliance overview for the filterable list.
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
actionsInTitle | boolean | false | Draw the actions slot in the title row, beside the heading, as the boards do, instead of floating it right above the content. | |
name | string | ✓ | — | Section name/title |
description | string | '' | Brief section description (shown under title by NcSettingsSection) | |
wide | boolean | false | Span the whole row of the settings grid instead of one column. Only the board look draws a grid; elsewhere the section is full width anyway. | |
detailedDescription | string | '' | Detailed description shown in a separate block below the title | |
docUrl | string | '' | Documentation URL (shows info icon next to title) | |
loading | boolean | false | Whether the section is in a loading state | |
loadingMessage | string | () => t('nextcloud-vue', 'Loading…') | Message shown during loading | |
error | boolean | false | Whether the section is in an error state | |
errorMessage | string | () => t('nextcloud-vue', 'An error occurred') | Message shown when in error state | |
onRetry | func | null | Callback function for retry button (shown in error state). If null, no retry button is shown. | |
retryButtonText | string | () => t('nextcloud-vue', 'Retry') | Text for the retry button | |
empty | boolean | false | Whether the section has no data to show | |
emptyMessage | string | () => t('nextcloud-vue', 'No data available') | Message shown when section is empty | |
footerLink | object | null | A link at the end of the card to where its list is managed: { label, href }, the label already translated. Drawn only with both and a safe href. | |
openedFrom | string | '' | The row this card is opened from, already translated: the card shows only while the page's hash names its id (the row's settings link, #<id>), and says "Opened from the row {row}" under its title in place of its description (DqInstellingen "Kadaster (BRK) en WOZ"). Empty: the card is always shown. |
Slots
| Name | Bindings | Description |
|---|---|---|
actions | — | |
description | — | |
default | — | |
empty | — | |
footer | — |
wide
wide makes the section span the whole row of the board-look settings grid. It has no effect without the look.