RED.sidebar

侧边栏允许节点和插件添加自定义标签页。

RED.sidebar API

RED.sidebar.addTab( tab )

向侧边栏添加一个新标签页。

tab 定义是一个具有以下属性的对象

属性 描述
id 此标签页的唯一ID。
label 在侧边栏标签页上显示的文本。不应过长。
name 在侧边栏菜单中显示的标签页名称。
iconClass 要使用的图标的 FontAwesome 4 类。例如,"fa fa-database"
content 包含侧边栏内容的 DOM 元素。
toolbar (可选)当此标签页处于活动状态时,在侧边栏工具栏中显示的 DOM 元素。
enableOnEdit (可选)如果设置为 true,则在编辑对话框打开时,此标签页将可访问。默认值:false
action (可选)用于显示此标签页的已注册操作的名称。这允许用户分配键盘快捷键来切换到该标签页。

// The sidebar content
const content = $("<div>").css({"position":"relative","height":"100%"});

// (optional) A toolbar header for the sidebar
const header = $("<div>", {class:"red-ui-sidebar-header"}).appendTo(content);


RED.actions.add("my-custom-tab:show-custom-tab",function() {
    RED.sidebar.show("my-custom-tab");
});

RED.sidebar.addTab({
    id: "my-custom-tab",
    label: "custom",
    name: "My Custom Tab",
    iconClass: "fa fa-database",
    content: content,
    action: "my-custom-tab:show-custom-tab"
});

RED.sidebar.removeTab( id )

如果标签页存在,则将其删除。

如果一个节点在其 onpaletteadd 函数中添加了一个标签页,则它必须确保在其 onpaletteremove 函数中调用此 API 来将其删除。

RED.sidebar.removeTab("my-custom-tab");

RED.sidebar.show( id )

如果标签页存在,则在侧边栏中显示给定的标签页。

RED.sidebar.show("my-custom-tab")

RED.sidebar.containsTab( id )

如果标签页在侧边栏中存在,则返回 true

let debugExists = RED.sidebar.containsTab('my-custom-tab');