Skip to content

Commit

Permalink
Update Readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewserong committed Sep 1, 2023
1 parent e78599a commit 94b4025
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions packages/components/src/dropdown-menu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,20 @@ A class name to apply to the dropdown menu's toggle element wrapper.

- Required: No

### `isOpen`: `boolean`

Control whether the dropdown is open or not.

- Required: No

### `onToggle`: `( willOpen: boolean ) => void`

A callback invoked when the state of the popover changes from open to closed and vice versa.

The callback receives a boolean as a parameter. If `true`, the popover will open. If `false`, the popover will close.

- Required: No

#### `popoverProps`: `DropdownProps[ 'popoverProps' ]`

Properties of `popoverProps` object will be passed as props to the nested `Popover` component.
Expand Down
6 changes: 6 additions & 0 deletions packages/components/src/dropdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ Set this to customize the text that is shown in the dropdown's header when it is

- Required: No

### `isOpen`: `boolean`

Control whether the dropdown is open or not.

- Required: No

### `onClose`: `() => void`

A callback invoked when the popover should be closed.
Expand Down

0 comments on commit 94b4025

Please sign in to comment.