PLUGIN SDK / Registration options / PanelOptions

PanelOptions

A dockable panel drawn with Ui.

Kindrecord

NamespaceKroys.Plugins

Members7

SourceOptions.cs

DECLARATION

Declaration

Namespace Kroys.Plugins, assembly KroysPlugins.Sdk.dll.

Declaration

public sealed record PanelOptions(string Id, string Title)

REFERENCE

Members

Constructors

#public PanelOptions(string Id, string Title)

A dockable panel drawn with Ui.

Id: Local id; the panel id is "<plugin id>.<Id>".
Title: Window title.

constructor

Properties

#public string Id { get; init; }

Local id; the panel id is "<plugin id>.<Id>".

property

#public string Title { get; init; }

Window title.

property

#public string? Icon { get; init; }

Lucide icon name.

property

#public bool OpenByDefault { get; init; }

Opens when it is registered (and after every reload).

property

#public PanelCategory Category { get; init; }

Window menu group.

property

#public PanelSlot Slot { get; init; }

Initial dock slot.

property

Signatures

public PanelOptions(string Id, string Title)
public string Id { get; init; }
public string Title { get; init; }
public string? Icon { get; init; }
public bool OpenByDefault { get; init; }
public PanelCategory Category { get; init; }
public PanelSlot Slot { get; init; }

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.