Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
david-szabo97 committed Nov 17, 2020
1 parent c166c21 commit 96ff63a
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion packages/components/src/navigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,19 @@ The parent menu slug; used by nested menus to indicate their parent menu.

When `hasSearch` is active and `onSearch` is provided, this controls the value of the search input. Required when the `onSearch` prop is provided.

### `isEmpty`

- Type: `boolean`
- Required: No

Indicates whether the menu is empty or not. Used together with the `hideIfTargetMenuEmpty` prop of Navigation Item.

### `title`

- Type: `string`
- Required: No

The menu title. It's also the field used by the menu search function.
The menu title. It's also the field used by the menu search function.

## Navigation Group Props

Expand Down Expand Up @@ -201,6 +208,13 @@ The unique identifier of the item.

The child menu slug. If provided, clicking on the item will navigate to the target menu.

### `hideIfTargetMenuEmpty`

- Type: `boolean`
- Required: No

Indicates whether this item should be hidden if the menu specified in `navigateToMenu` is marked as empty in the `isEmpty` prop. Used together with the `isEmpty` prop of Navigation Menu.

### `onClick`

- Type: `function`
Expand Down

0 comments on commit 96ff63a

Please sign in to comment.