Interface ModConfigSection

A section in the configuration UI that can contain other fields or sections.

interface ModConfigSection {
    children?: readonly ModConfigFieldOrSection[];
    defaultExpanded?: boolean;
    description?: string;
    id: string;
    name: string;
    type: "section";
    visible?: Binding<boolean>;
}

Hierarchy

  • ModConfigBase
    • ModConfigSection

Properties

children? defaultExpanded? description? id name type visible?

Properties

Optional children

children?: readonly ModConfigFieldOrSection[]

The fields or sections that are contained within this section.

Optional defaultExpanded

defaultExpanded?: boolean

Whether the section should be expanded by default.

Optional description

description?: string

The description for the section that appears in a help tooltip.

id

id: string

The unique identifier of the configuration element.

name

name: string

The name of the section.

type

type: "section"

The type of the configuration element.

Optional visible

visible?: Binding<boolean>

Determines if the section is visible or not.

Settings

Member Visibility

Theme

On This Page

childrendefaultExpandeddescriptionidnametypevisible