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 (可选)用于显示该选项卡的已注册操作的名称。这允许用户分配一个键盘快捷键来切换到该选项卡。

// 侧边栏内容
const content = $("<div>").css({"position":"relative","height":"100%"});

// (可选)侧边栏的工具栏标题
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: "我的自定义选项卡",
    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’);