SettingsList¶
SettingsList is a list of rows on rounded cards, like the Settings app on iOS. Each row has an icon and a title. It can also have a chevron or a control at the end.
Usage¶
Call Components.SettingsList with a scope and a table of properties:
C.SettingsList(scope, {
Header = "Account",
Items = {
{ Title = "Profile", Icon = "user", ShowChevron = true, OnClick = openProfile },
{ Title = "Notifications", Icon = "bell", Trailing = C.Switch(scope, {}) },
},
})
Properties¶
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
Theme |
ThemeRef |
 |
The contextual theme | Theme to use for this component instead of the one from Theme.Provide. |
LayoutOrder |
UsedAs<number> |
|
0 |
Position in a parent UIListLayout or UIGridLayout. |
Size |
UsedAs<UDim2> |
|
- | Size of the component. |
Visible |
UsedAs<boolean> |
|
true |
Whether the component is shown. |
ZIndex |
UsedAs<number> |
|
- | Z index of the component. |
Items |
{ any } |
|
- | The rows. Each row needs a Title. It can also have a Subtitle, an Icon, a Trailing instance, ShowChevron, OnClick and Disabled. |
Header |
UsedAs<string> |
|
- | Heading above the card. |
Footer |
UsedAs<string> |
|
- | Small print under the card. |
Children |
any |
|
- | Extra content to add under the rows. |
InsetGrouped |
boolean |
|
true |
Draw the rows on a rounded card with space around it. Set it to false for rows that run from edge to edge. |