Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ResourceDefinition

Complete configuration for an interface resource.

Import

import type { ResourceDefinition } from "@dartwic/interface-sdk";

Declaration

export interface ResourceDefinition {
    name: string;
    /** Stable runtime, storage, link, tab, and collaboration identity. */
    resourceName?: string;
    label?: string;
    icon?: any;
    type: ResourceType;
    component?: any;
    show_in_resource_tabs?: boolean;
    file_extension?: string;
    file_extensions?: string[];
    excluded_file_names?: string[];
    excluded_paths?: string[];
    show_file_extensions?: boolean;
    enable_directory_resource_groups?: boolean;
    resource_on_create_file_data?: string;
    resource_on_create_file_dialog?: any;
    resource_on_delete_function?: any;
    get_tree_file_icon_src?: any;
    tree_file_icon?: any;
    tree_directory_icon?: any;
    file_icons?: Record<string, any>;
    context_label?: string;
    context_config?: any;
    context_default_content?: any;
}

Members

NameTypeRequirementDescription
namestringRequired
resourceNamestringOptionalStable runtime, storage, link, tab, and collaboration identity.
labelstringOptional
iconanyOptional
typeResourceTypeRequired
componentanyOptional
show_in_resource_tabsbooleanOptional
file_extensionstringOptional
file_extensionsstring[]Optional
excluded_file_namesstring[]Optional
excluded_pathsstring[]Optional
show_file_extensionsbooleanOptional
enable_directory_resource_groupsbooleanOptional
resource_on_create_file_datastringOptional
resource_on_create_file_dialoganyOptional
resource_on_delete_functionanyOptional
get_tree_file_icon_srcanyOptional
tree_file_iconanyOptional
tree_directory_iconanyOptional
file_iconsRecord<string, any>Optional
context_labelstringOptional
context_configanyOptional
context_default_contentanyOptional