ToggleSettingRow
Extends
Section titled “Extends”SettingRowBase
Properties
Section titled “Properties”| Property | Type | Default value | Description |
|---|---|---|---|
cost? |
SettingCost |
undefined |
What the row costs to turn up, shown beside its description. |
defaultValue? |
boolean |
undefined |
The value the tab’s Reset and Reset all hand back to onChange; without one, a reset leaves the row as it is. |
description? |
string |
undefined |
What the row does, in a sentence or two, which the panel shows beside the rows while this one is under the pointer or holds the focus, and under the row on a narrow screen when it is tapped. |
image? |
string |
undefined |
The address of an image the panel shows beside the description, such as what each option looks like. |
kind |
Toggle |
undefined |
- |
label |
string |
undefined |
What the row is called in the panel, in sentence case. |
onChange |
(value) => void |
undefined |
- |
section? |
string |
undefined |
A heading the row stands under within its tab. Rows that name the same section stand together, in the order the first of them mounted, after the rows that name none. |
tab? |
SettingsTab |
SettingsTab.Game |
The tab the row shows on. |
value |
boolean |
undefined |
- |