feat: Support for toggle buttons in button group #2909
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
|
There was a problem hiding this comment. I reworked button group unit tests. Now all tests are split across multiple files focusing on specific categories of tests. The tests ensure full coverage for all button group item types. In the dev tests we validate dev warnings, fallbacks, and callbacks. |
||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| import { warnOnce } from '@cloudscape-design/component-toolkit/internal'; | ||
|
|
||
| import { ButtonGroupProps } from '../../../lib/components/button-group'; | ||
| import { renderButtonGroup } from './common'; | ||
|
|
||
| import buttonStyles from '../../../lib/components/button/styles.css.js'; | ||
|
|
||
| jest.mock('@cloudscape-design/component-toolkit/internal', () => ({ | ||
| ...jest.requireActual('@cloudscape-design/component-toolkit/internal'), | ||
| warnOnce: jest.fn(), | ||
| })); | ||
|
|
||
| afterEach(() => { | ||
| (warnOnce as jest.Mock).mockReset(); | ||
| }); | ||
|
|
||
| const emptyGroup: ButtonGroupProps.ItemOrGroup[] = [ | ||
| { | ||
| type: 'group', | ||
| text: 'Feedback', | ||
| items: [], | ||
| }, | ||
| ]; | ||
|
|
||
| test('warns and renders some icon when no icon specified for icon button', () => { | ||
| const { wrapper } = renderButtonGroup({ items: [{ type: 'icon-button', id: 'search', text: 'Search' }] }); | ||
|
|
||
| expect(warnOnce).toHaveBeenCalledTimes(1); | ||
| expect(warnOnce).toHaveBeenCalledWith('ButtonGroup', 'Missing icon for item with id: search'); | ||
| expect(wrapper.findMenuById('search')!.findAll(`.${buttonStyles.icon}`)).toHaveLength(1); | ||
| }); | ||
|
|
||
| test.each([{ pressed: false }, { pressed: true }])( | ||
| 'warns and renders some icon when no icon specified for icon toggle button, pressed=$pressed', | ||
| ({ pressed }) => { | ||
| const { wrapper } = renderButtonGroup({ | ||
| items: [{ type: 'icon-toggle-button', id: 'like', pressed, text: 'Like', pressedText: 'Liked' }], | ||
| }); | ||
|
|
||
| expect(warnOnce).toHaveBeenCalledTimes(2); | ||
| expect(warnOnce).toHaveBeenCalledWith('ButtonGroup', 'Missing icon for item with id: like'); | ||
| expect(warnOnce).toHaveBeenCalledWith('ButtonGroup', 'Missing pressed icon for item with id: like'); | ||
| expect(wrapper.findMenuById('like')!.findAll(`.${buttonStyles.icon}`)).toHaveLength(1); | ||
| } | ||
| ); | ||
|
|
||
| test('warns if empty group is provided', () => { | ||
| renderButtonGroup({ items: emptyGroup }); | ||
|
|
||
| expect(warnOnce).toHaveBeenCalledTimes(1); | ||
| expect(warnOnce).toHaveBeenCalledWith('ButtonGroup', 'Empty group detected. Empty groups are not allowed.'); | ||
| }); | ||
|
|
||
| test('uses non-pressed popover feedback if pressed is not provided', () => { | ||
| const { wrapper } = renderButtonGroup({ | ||
| items: [ | ||
| { | ||
| type: 'icon-toggle-button', | ||
| id: 'like', | ||
| pressed: true, | ||
| text: 'Like', | ||
| pressedText: 'Liked', | ||
| popoverFeedback: 'You like it!', | ||
| }, | ||
| ], | ||
| }); | ||
|
|
||
| wrapper.findToggleButtonById('like')!.click(); | ||
| expect(wrapper.findTooltip()!.getElement()).toHaveTextContent('You like it!'); | ||
| }); | ||
|
|
||
| test('handles item click', () => { | ||
| const onItemClick = jest.fn(); | ||
| const { wrapper } = renderButtonGroup({ | ||
| items: [{ type: 'icon-button', id: 'search', text: 'Search' }], | ||
| onItemClick, | ||
| }); | ||
|
|
||
| wrapper.findButtonById('search')!.click(); | ||
|
|
||
| expect(onItemClick).toHaveBeenCalledWith(expect.objectContaining({ detail: { id: 'search' } })); | ||
| }); | ||
|
|
||
| test('handles toggle item click', () => { | ||
| const onItemClick = jest.fn(); | ||
| const { wrapper } = renderButtonGroup({ | ||
| items: [ | ||
| { | ||
| type: 'icon-toggle-button', | ||
| id: 'like', | ||
| pressed: false, | ||
| text: 'Like', | ||
| pressedText: 'Liked', | ||
| }, | ||
| { | ||
| type: 'icon-toggle-button', | ||
| id: 'dislike', | ||
| pressed: true, | ||
| text: 'Dislike', | ||
| pressedText: 'Disliked', | ||
| }, | ||
| ], | ||
| onItemClick, | ||
| }); | ||
|
|
||
| wrapper.findButtonById('like')!.click(); | ||
| wrapper.findButtonById('dislike')!.click(); | ||
|
|
||
| expect(onItemClick).toHaveBeenCalledWith(expect.objectContaining({ detail: { id: 'like', pressed: true } })); | ||
| expect(onItemClick).toHaveBeenCalledWith(expect.objectContaining({ detail: { id: 'dislike', pressed: false } })); | ||
| }); | ||
|
|
||
| test('handles menu click', () => { | ||
| const onItemClick = jest.fn(); | ||
| const { wrapper } = renderButtonGroup({ | ||
| items: [ | ||
| { | ||
| type: 'menu-dropdown', | ||
| id: 'misc', | ||
| text: 'Misc', | ||
| items: [ | ||
| { id: 'dark-mode', itemType: 'checkbox', text: 'Dark mode', checked: false }, | ||
| { id: 'compact-mode', itemType: 'checkbox', text: 'Compact mode', checked: true }, | ||
| ], | ||
| }, | ||
| ], | ||
| onItemClick, | ||
| }); | ||
|
|
||
| wrapper.findMenuById('misc')!.openDropdown(); | ||
| wrapper.findMenuById('misc')!.findItemById('dark-mode')!.click(); | ||
| expect(onItemClick).toHaveBeenCalledWith(expect.objectContaining({ detail: { id: 'dark-mode', checked: true } })); | ||
|
|
||
| wrapper.findMenuById('misc')!.openDropdown(); | ||
| wrapper.findMenuById('misc')!.findItemById('compact-mode')!.click(); | ||
| expect(onItemClick).toHaveBeenCalledWith(expect.objectContaining({ detail: { id: 'compact-mode', checked: false } })); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This property is present when a menu item of type "checkbox" is clicked.