feat(multi-action-button, split-button): add programmatic focus support #7193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomdavies73
force-pushed
the
FE-6887
branch
4 times, most recently
from
85c434a to
8fdf78c
Compare
edleeks87
reviewed
Feb 6, 2025
| @@ -1,2 +1,3 @@ | |||
| export { default } from "./multi-action-button.component"; | |||
| export type { MultiActionButtonHandle } from "./multi-action-button.component"; | |||
There was a problem hiding this comment.
Suggested change
| export type { MultiActionButtonHandle } from "./multi-action-button.component"; | |
| export type { MultiActionButtonHandle, MultiActionButtonProps } from "./multi-action-button.component"; |
| const buttonRef = useRef<HTMLButtonElement>(null); | ||
| export type MultiActionButtonHandle = { | ||
| /** Programmatically focus the button */ | ||
| focusButton: () => void; |
There was a problem hiding this comment.
suggestion (non-blocking): might be worth calling this focusMainButton so it matches the same naming as used in SplitButton and it's a bit more explicit about what it does etc
| @@ -34,6 +34,17 @@ import MultiActionButton from "carbon-react/lib/components/multi-action-button"; | |||
|
|
|||
| <Canvas of={MultiActionButtonStories.DefaultStory} /> | |||
|
|
|||
| ### Focusing Programmatically | |||
There was a problem hiding this comment.
non-blocking
Suggested change
| ### Focusing Programmatically | |
| ### Focusing Main Button Programmatically |
| ``` | ||
|
|
||
| The `MultiActionButtonHandle` type provides an imperative handle for programmatic control over `MultiActionButton`. | ||
| Using a `ref`, you can access its `focusButton()` method to set focus on the button as needed. |
There was a problem hiding this comment.
non-blocking
Suggested change
| Using a `ref`, you can access its `focusButton()` method to set focus on the button as needed. | |
| Using a `ref`, you can access its `focusButton()` method to set focus on the main button as needed. |
| @@ -37,6 +37,17 @@ import SplitButton from "carbon-react/lib/components/split-button"; | |||
|
|
|||
| <Canvas of={SplitButtonStories.Default} /> | |||
|
|
|||
| ### Focusing Programmatically | |||
There was a problem hiding this comment.
non-blocking
Suggested change
| ### Focusing Programmatically | |
| ### Focusing Main and Toggle Buttons Programmatically |
| @@ -92,6 +110,30 @@ test("renders child buttons when toggle button is clicked", async () => { | |||
| ).toBeVisible(); | |||
| }); | |||
|
|
|||
| test("should focus the SplitButton's main button via focus method on the ref handle when invoked", async () => { | |||
There was a problem hiding this comment.
non-blocking
Suggested change
| test("should focus the SplitButton's main button via focus method on the ref handle when invoked", async () => { | |
| test("should focus the main button when the focusMainButton on the ref handle is invoked", async () => { |
| expect(screen.getByRole("button", { name: "Main Button" })).toHaveFocus(); | ||
| }); | ||
|
|
||
| test("should focus the SplitButton's toggle button via focus method on the ref handle when invoked", async () => { |
There was a problem hiding this comment.
non-blocking
Suggested change
| test("should focus the SplitButton's toggle button via focus method on the ref handle when invoked", async () => { | |
| test("should focus the toggle button when the focusToggleButton on the ref handle is invoked", async () => { |
DipperTheDan
reviewed
Feb 7, 2025
There was a problem hiding this comment.
Nothing more to add from me. Just address the comments left by @edleeks87 please 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed behaviour
Both
MultiActionButtonandSplitButtonnow useforwardRefand support focusing their respective buttons usinguseImperativeHandle. Each component exports a handle type that can be used for programmatic focus via this handle.Current behaviour
None of the components have programmatic focus support.
Checklist
d.tsfile added or updated if requiredQA
Additional context
Testing instructions