@ovok/native/setting

Settings list components.

Import from @ovok/native/setting.

ComponentsCopy Anchor Link

ListHeader()Copy Anchor Link

function ListHeader(__namedParameters): Element;

Section header row for a settings list.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

SettingList()Copy Anchor Link

function SettingList(props): Element;

Settings list with section headers, rounded row groups and custom rows.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

SettingListItem()Copy Anchor Link

function SettingListItem(item): Element;

Settings row with a title, optional left icon and a trailing arrow.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

Type AliasesCopy Anchor Link

CustomSettingListItemCopy Anchor Link

type CustomSettingListItem = object;

A settings list entry rendered by a custom component instead of the standard row.

IndexableCopy Anchor Link

[key: string]: unknown

PropertiesCopy Anchor Link

borderBottomRadius?Copy Anchor Link

borderBottomRadius?: boolean;

Whether the item should round its bottom corners; set by the list.

borderTopRadius?Copy Anchor Link

borderTopRadius?: boolean;

Whether the item should round its top corners; set by the list.

componentCopy Anchor Link

component: React.ComponentType<{
  borderBottomRadius?: boolean;
  borderTopRadius?: boolean;
}>;

Component that renders the entry.

customCopy Anchor Link

custom: true;

Marks the entry as custom.

SettingListItemPropsCopy Anchor Link

type SettingListItemProps = ListItemProps & object;

Props for SettingListItem; also accepts React Native Paper List.Item props.

Type DeclarationCopy Anchor Link

SettingListPropsCopy Anchor Link

type SettingListProps = Omit<FlashListProps<
  | SettingListItemProps
  | CustomSettingListItem
| string>, "renderItem">;

Props for SettingList: FlashList props except renderItem; data mixes section header strings, setting rows and custom rows.