Interface ISettingsUiBuilder
Interfaces for building settings pages, and adding
fields to said pages.
Assembly: SociallyDistant.Framework.dll
Syntax
public interface ISettingsUiBuilder
Methods
AddSection(string, out int)
Creates a new labeled section to categorize fields under.
Declaration
ISettingsUiBuilder AddSection(string sectionTitle, out int sectionId)
Parameters
| Type |
Name |
Description |
| string |
sectionTitle |
The name of the section as shown in the UI
|
| int |
sectionId |
A unique identifier representing the section
|
Returns
WithAction(string, string, Action, int)
Declaration
ISettingsUiBuilder WithAction(string title, string description, Action clickCallback, int sectionId)
Parameters
Returns
WithLabel(string, int)
Declaration
ISettingsUiBuilder WithLabel(string labelText, int sectionId)
Parameters
| Type |
Name |
Description |
| string |
labelText |
|
| int |
sectionId |
|
Returns
WithSlider(string, string?, int, int, int, Action<int>, int)
Declaration
ISettingsUiBuilder WithSlider(string title, string? description, int value, int minimum, int maximum, Action<int> changeCallback, int sectionId)
Parameters
Returns
WithSlider(string, string?, float, float, float, Action<float>, int)
Declaration
ISettingsUiBuilder WithSlider(string title, string? description, float value, float minimum, float maximum, Action<float> changeCallback, int sectionId)
Parameters
Returns
WithStringDropdown(string, string?, int, string[], Action<int>, int)
Declaration
ISettingsUiBuilder WithStringDropdown(string title, string? description, int currentIndex, string[] choices, Action<int> changeCallback, int sectionId)
Parameters
Returns
WithTextField(string, string?, string?, Action<string?>, int)
Declaration
ISettingsUiBuilder WithTextField(string title, string? description, string? currentValue, Action<string?> changeCallback, int sectionId)
Parameters
Returns
WithToggle(string, string?, bool, Action<bool>, int, bool, string?)
Declaration
ISettingsUiBuilder WithToggle(string title, string? description, bool value, Action<bool> changeCallback, int sectionId, bool requireConfirmation = false, string? confirmationMessage = null)
Parameters
Returns