Skip to content

Commit 2bc1608

Browse files
committed
Document new options in header items
1 parent 8e23dc1 commit 2bc1608

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

versioned_docs/version-7.x/native-stack-navigator.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1463,7 +1463,7 @@ Common properties:
14631463
- `fontFamily`
14641464
- `fontSize`
14651465
- `fontWeight`
1466-
- `color`
1466+
- `color` (of type `ColorValue`)
14671467
- `icon`: Optional icon to show instead of the label.
14681468

14691469
The icon can be an image:
@@ -1472,6 +1472,7 @@ Common properties:
14721472
{
14731473
type: 'image',
14741474
source: require('./path/to/image.png'),
1475+
tinted: true, // Whether to apply tint color to the icon. Defaults to true.
14751476
}
14761477
```
14771478

@@ -1487,12 +1488,12 @@ Common properties:
14871488
- `variant`: Visual variant of the button. Supported values:
14881489
- `plain` (default)
14891490
- `done`
1490-
- `prominent`
1491+
- `prominent` (iOS 26+)
14911492
- `tintColor`: Tint color to apply to the item.
14921493
- `disabled`: Whether the item is disabled.
14931494
- `width`: Width of the item.
1494-
- `hidesSharedBackground` (iOS 26+): Whether the background this item may share with other items should be hidden. Setting this to `true` hides the liquid glass background.
1495-
- `sharesBackground` (iOS 26+): Whether this item can share a background with other items.
1495+
- `hidesSharedBackground` (iOS 26+): Whether the background this item may share with other items in the bar should be hidden. Setting this to `true` hides the liquid glass background.
1496+
- `sharesBackground` (iOS 26+): Whether this item can share a background with other items. Defaults to `true`.
14961497
- `identifier` (iOS 26+) - An identifier used to match items across transitions.
14971498
- `badge` (iOS 26+): An optional badge to display alongside the item. Supported properties:
14981499
- `value`: The value to display in the badge. It can be a string or a number.
@@ -1501,6 +1502,7 @@ Common properties:
15011502
- `fontSize`
15021503
- `fontWeight`
15031504
- `color`
1505+
- `backgroundColor`
15041506
- `accessibilityLabel`: Accessibility label for the item.
15051507
- `accessibilityHint`: Accessibility hint for the item.
15061508

@@ -1532,10 +1534,15 @@ Supported properties when `type` is `menu`:
15321534
- `changesSelectionAsPrimaryAction`: Whether the menu is a selection menu. Tapping an item in a selection menu will add a checkmark to the selected item. Defaults to `false`.
15331535
- `menu`: An object containing the menu items. It contains the following properties:
15341536
- `title`: Optional title to show on top of the menu.
1537+
- `multiselectable`: Whether multiple items in the menu can be selected (i.e. in "on" state). Defaults to `false`.
1538+
- `layout`: How the menu items are displayed. Supported values:
1539+
- `default` (default): menu items are displayed normally.
1540+
- `palette`: menu items are displayed in a horizontal row.
15351541
- `items`: An array of menu items. A menu item can be either an `action` or a `submenu`.
15361542
- `action`: An object with the following properties:
15371543
- `type`: Must be `action`.
15381544
- `label`: Label of the menu item.
1545+
- `description`: The secondary text displayed alongside the label of the menu item.
15391546
- `icon`: Optional icon to show alongside the label. The icon can be a [SF Symbols](https://developer.apple.com/sf-symbols/) name:
15401547

15411548
```js
@@ -1554,7 +1561,7 @@ Supported properties when `type` is `menu`:
15541561
- `destructive`: Whether the menu item is styled as destructive.
15551562
- `hidden`: Whether the menu item is hidden.
15561563
- `keepsMenuPresented`: Whether to keep the menu open after selecting this item. Defaults to `false`.
1557-
- `discoverabilityLabel`: An elaborated title that explains the purpose of the action.
1564+
- `discoverabilityLabel`: An elaborated title that explains the purpose of the action. On iOS, the system displays this title in the discoverability heads-up display (HUD). If this is not set, the HUD displays the label property.
15581565

15591566
- `submenu`: An object with the following properties:
15601567
- `type`: Must be `submenu`.
@@ -1568,6 +1575,12 @@ Supported properties when `type` is `menu`:
15681575
}
15691576
```
15701577

1578+
- `inline`: Whether the menu is displayed inline with the parent menu. By default, submenus are displayed after expanding the parent menu item. Inline menus are displayed as part of the parent menu as a section. Defaults to `false`.
1579+
- `layout`: How the submenu items are displayed. Supported values:
1580+
- `default` (default): menu items are displayed normally.
1581+
- `palette`: menu items are displayed in a horizontal row.
1582+
- `destructive`: Whether the submenu is styled as destructive.
1583+
- `multiselectable`: Whether multiple items in the submenu can be selected (i.e. in "on" state). Defaults to `false`.
15711584
- `items`: An array of menu items (can be either `action` or `submenu`).
15721585

15731586
Example:

0 commit comments

Comments
 (0)