Skip to content

docs(UserMenu): add code examples for opening the menu #7375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions packages/main/src/webComponents/UserMenu/UserMenu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,67 @@ import * as ComponentStories from './UserMenu.stories';

<ControlsWithNote of={ComponentStories.Default} />

## Open UserMenu

The `UserMenu` requires an `opener` so it knows where to anchor itself when opened.
To provide this, you can either:

- Assign an `id` to the element rendered in the `profile` slot.
- Use the `targetRef` provided in the `detail` of the `onProfileClick` event properties.

### Via `targetRef`

```tsx
function RefOpener() {
const [open, setOpen] = useState(false);
const userMenuRef = useRef<UserMenuDomRef>(null);
return (
<>
<ShellBar
onProfileClick={(e) => {
const { targetRef } = e.detail;
userMenuRef.current.opener = targetRef;
setOpen(true);
}}
profile={<Avatar initials="JD" />}
/>
<UserMenu
ref={userMenuRef}
open={open}
onClose={() => {
setOpen(false);
}}
/>
</>
);
}
```

### Via `id`

```tsx
function IdOpener() {
const [open, setOpen] = useState(false);
return (
<>
<ShellBar
onProfileClick={(e) => {
setOpen(true);
}}
profile={<Avatar initials="JD" id="userMenuOpener" />}
/>
<UserMenu
open={open}
opener="userMenuOpener"
onClose={() => {
setOpen(false);
}}
/>
</>
);
}
```

<Markdown>{SubcomponentsSection}</Markdown>

## UserMenuAccount
Expand Down
Loading