Interface ModConfigSection

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

Since

D2RMM v1.6.0

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

Hierarchy

  • ModConfigBase
    • ModConfigSection

Properties

allowToggleAll? children? defaultExpanded? defaultValue? description? id name overrideValue? type visible?

Properties

Optional allowToggleAll

allowToggleAll?: Binding<boolean>

Whether the "toggle all" button can appear in this section. Note that this button will only appear if all the children of this section are checkboxes.

Since

D2RMM v1.8.0

Optional children

children?: readonly ModConfigFieldOrSection[]

The fields or sections that are contained within this section.

Since

D2RMM v1.6.0

Optional defaultExpanded

defaultExpanded?: boolean

Whether the section should be expanded by default.

Since

D2RMM v1.6.0

Optional defaultValue

defaultValue?: null | boolean

If this value is anything other than null, the section will have a checkbox on the left hand side that will set this section's value the same way as it would work for a checkbox field.

Since

D2RMM v1.8.0

Optional description

description?: string

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

Since

D2RMM v1.8.0

id

id: string

The unique identifier of the configuration element.

name

name: string

The name of the section.

Since

D2RMM v1.6.0

Optional overrideValue

overrideValue?: Binding<null | boolean>

The override value of the section field. If this value is anything other than null, it will override the current value. If the value is overridden, it will also be read only. This needs to be used in unison with defaultValue.

Since

D2RMM v1.8.0

type

type: "section"

The type of the configuration element.

Since

D2RMM v1.6.0

Optional visible

visible?: Binding<boolean>

Determines if the section is visible or not.

Since

D2RMM v1.8.0

Settings

Member Visibility

Theme

On This Page

allowToggleAllchildrendefaultExpandeddefaultValuedescriptionidnameoverrideValuetypevisible