Overview
settings is a menu configuration object that defines the settings sidebar items available on the chatflow canvas, including actions such as viewing messages, upsert history, configuring, duplicating, importing, exporting, and deleting chatflows.
Description
This module exports a plain JavaScript object named settings structured as a menu group (type: 'group') with an id of settings. It contains nine child menu items, each with an id, title, icon (from @tabler/icons-react), and optional permission string. Unlike the agent_settings counterpart, this configuration includes a viewUpsertHistory item and uses chatflows: namespace permissions. Items without a permission property (viewMessages, viewLeads, viewUpsertHistory) are visible to all authenticated users.
Usage
Use this configuration object when rendering the settings sidebar on the chatflow canvas page. It is consumed by NavItem components operating in SETTINGS mode to display available actions for the currently open chatflow.
Code Reference
Source Location
Signature
const settings = {
id: 'settings',
title: '',
type: 'group',
children: [ ... ]
}
export default settings
Import
import settings from '@/menu-items/settings'
I/O Contract
Inputs
| Name |
Type |
Required |
Description
|
| (none) |
- |
- |
This is a static configuration object with no inputs.
|
Outputs
| Name |
Type |
Description
|
| settings |
object |
A menu group object with id, title, type, and children array containing nine menu items for chatflow canvas settings.
|
| ID |
Title |
Icon |
Permission
|
| viewMessages |
View Messages |
IconMessage |
(none)
|
| viewLeads |
View Leads |
IconUsers |
(none)
|
| viewUpsertHistory |
Upsert History |
IconDatabaseExport |
(none)
|
| chatflowConfiguration |
Configuration |
IconAdjustmentsHorizontal |
chatflows:config
|
| saveAsTemplate |
Save As Template |
IconTemplate |
templates:flowexport
|
| duplicateChatflow |
Duplicate Chatflow |
IconCopy |
chatflows:duplicate
|
| loadChatflow |
Load Chatflow |
IconFileUpload |
chatflows:import
|
| exportChatflow |
Export Chatflow |
IconFileExport |
chatflows:export
|
| deleteChatflow |
Delete Chatflow |
IconTrash |
chatflows:delete
|
Usage Examples
Basic Usage
import settings from '@/menu-items/settings'
// Render settings items in the chatflow canvas sidebar
settings.children.map((item) => (
<NavItem
key={item.id}
item={item}
level={1}
navType="SETTINGS"
onClick={handleSettingClick}
/>
))
Related Pages
Page Connections
Double-click a node to navigate. Hold to expand connections.
