Skip to content

feat: Add findItemById test-util to FlashbarWrapper #4367

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.

Sign up for GitHub

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

Open
johannes-weber wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Add findItemById test-util to FlashbarWrapper #4367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 38 additions & 0 deletions src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37439,6 +37439,25 @@ wrapper.selectOptionByValue('option_1');
},
{
"methods": [
{
"description": "Returns a flash item by its id.

The id is matched against the \`id\` property of each item passed to the \`items\` property of the Flashbar component.",
"name": "findItemById",
"parameters": [
{
"flags": {
"isOptional": false,
},
"name": "id",
"typeName": "string",
},
],
"returnType": {
"isNullable": true,
"name": "FlashWrapper",
},
},
{
"description": "Returns the individual flashes of this flashbar.

Expand Down Expand Up @@ -47270,6 +47289,25 @@ The mode selector is only rendered as a Select on narrow viewports. On wide view
},
{
"methods": [
{
"description": "Returns a flash item by its id.

The id is matched against the \`id\` property of each item passed to the \`items\` property of the Flashbar component.",
"name": "findItemById",
"parameters": [
{
"flags": {
"isOptional": false,
},
"name": "id",
"typeName": "string",
},
],
"returnType": {
"isNullable": true,
"name": "FlashWrapper",
},
},
{
"description": "Returns the individual flashes of this flashbar.

Expand Down
19 changes: 19 additions & 0 deletions src/flashbar/__tests__/collapsible.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,25 @@ describe('Collapsible Flashbar', () => {
disableMotion(true);
testFlashDismissal({ stackItems: true });
});

test('findItemById', () => {
const wrapper = createFlashbarWrapper(
<Flashbar
stackItems={true}
items={[
{ content: 'Flash 1', id: 'flash-1', type: 'success' },
{ content: 'Flash 2', id: 'flash-2', type: 'error' },
]}
/>
);
expect(wrapper.findItemById('flash-1')).not.toBeNull();
expect(wrapper.findItemById('flash-2')).toBeNull();

findNotificationBar(wrapper)!.click();

expect(wrapper.findItemById('flash-1')).not.toBeNull();
expect(wrapper.findItemById('flash-2')).not.toBeNull();
});
});

// Entire interactive element including the counter and the actual <button/> element
Expand Down
15 changes: 15 additions & 0 deletions src/flashbar/__tests__/flashbar.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,21 @@ describe('Flashbar component', () => {
testFlashDismissal({ stackItems: false });
});

test('findItemById', () => {
const wrapper = createFlashbarWrapper(
<Flashbar
items={[
{ content: 'Flash 1', id: 'flash-1', type: 'success' },
{ content: 'Flash 2', id: 'flash-2', type: 'error' },
{ content: 'Flash 3', type: 'warning' },
]}
/>
);
expect(wrapper.findItemById('flash-1')!.findContent()!.getElement()).toHaveTextContent('Flash 1');
expect(wrapper.findItemById('flash-2')!.findContent()!.getElement()).toHaveTextContent('Flash 2');
expect(wrapper.findItemById('flash-3')).toBeNull();
});

describe('rapid item replacement with animations', () => {
beforeEach(() => {
jest.useFakeTimers();
Expand Down
10 changes: 10 additions & 0 deletions src/test-utils/dom/flashbar/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ export default class FlashbarWrapper extends ComponentWrapper {
return this.findAllByClassName(styles['flash-list-item']).map(item => new FlashWrapper(item.getElement()));
}

/**
* Returns a flash item by its id.
*
* The id is matched against the `id` property of each item passed to the `items` property of the Flashbar component.
*/
findItemById(id: string): FlashWrapper | null {
const element = this.find(`[data-itemid="${CSS.escape(id)}"]`);
return element ? new FlashWrapper(element.getElement()) : null;
}

/**
* Returns the individual flashes of this flashbar given the item type.
*
Expand Down
Loading