-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
[core] Use describeTreeView
for icons tests
#12672
Merged
flaviendelangle
merged 5 commits into
mui:master
from
flaviendelangle:useTreeIcons-describeTreeView
Apr 8, 2024
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
92a20ee
[core] Use describeTreeView for icons tests
flaviendelangle a5a901d
Merge branch 'master' into useTreeIcons-describeTreeView
flaviendelangle 40a2783
Fix
flaviendelangle 8d8c76f
Merge branch 'master' into useTreeIcons-describeTreeView
flaviendelangle 748972f
Update packages/x-tree-view/src/internals/plugins/useTreeViewIcons/us…
flaviendelangle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -157,6 +157,10 @@ const useUtilityClasses = (ownerState: TreeItem2OwnerState) => { | |
return composeClasses(slots, getTreeItemUtilityClass, classes); | ||
}; | ||
|
||
type TreeItem2Component = (( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Forgot to have this one for consistency |
||
props: TreeItem2Props & React.RefAttributes<HTMLLIElement>, | ||
) => React.JSX.Element) & { propTypes?: any }; | ||
|
||
/** | ||
* | ||
* Demos: | ||
|
@@ -264,7 +268,7 @@ export const TreeItem2 = React.forwardRef(function TreeItem2( | |
</Root> | ||
</TreeItem2Provider> | ||
); | ||
}); | ||
}) as TreeItem2Component; | ||
|
||
TreeItem2.propTypes = { | ||
// ----------------------------- Warning -------------------------------- | ||
|
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
197 changes: 197 additions & 0 deletions
197
packages/x-tree-view/src/internals/plugins/useTreeViewIcons/useTreeViewIcons.test.tsx
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,197 @@ | ||
import * as React from 'react'; | ||
import { expect } from 'chai'; | ||
import { | ||
describeTreeView, | ||
DescribeTreeViewRendererReturnValue, | ||
} from 'test/utils/tree-view/describeTreeView'; | ||
import { | ||
UseTreeViewExpansionSignature, | ||
UseTreeViewIconsSignature, | ||
} from '@mui/x-tree-view/internals'; | ||
|
||
describeTreeView<[UseTreeViewIconsSignature, UseTreeViewExpansionSignature]>( | ||
'useTreeViewIcons plugin', | ||
({ render }) => { | ||
describe('slots (expandIcon, collapseIcon, endIcon, icon)', () => { | ||
const getIconTestId = (response: DescribeTreeViewRendererReturnValue<[]>, itemId: string) => | ||
response.getItemIconContainer(itemId).querySelector(`div`)?.dataset.testid; | ||
|
||
it('should render the expandIcon slot defined on the tree if no icon slot is defined on the item and the item is collapsed', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('treeExpandIcon'); | ||
}); | ||
|
||
it('should render the collapseIcon slot defined on the tree if no icon is defined on the item and the item is expanded', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
defaultExpandedItems: ['1'], | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('treeCollapseIcon'); | ||
}); | ||
|
||
it('should render the endIcon slot defined on the tree if no icon is defined on the item and the item has no children', () => { | ||
const response = render({ | ||
items: [{ id: '1' }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('treeEndIcon'); | ||
}); | ||
|
||
it('should render the expandIcon slot defined on the item if the item is collapsed', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
}, | ||
}, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemExpandIcon'); | ||
}); | ||
|
||
it('should render the collapseIcon slot defined on the item if the item is expanded', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
}, | ||
}, | ||
}, | ||
defaultExpandedItems: ['1'], | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemCollapseIcon'); | ||
}); | ||
|
||
it('should render the endIcon slot defined on the tree if the item has no children', () => { | ||
const response = render({ | ||
items: [{ id: '1' }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
}, | ||
}, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemEndIcon'); | ||
}); | ||
|
||
it('should render the icon slot defined on the item if the item is collapsed', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
icon: () => <div data-testid="itemIcon" />, | ||
}, | ||
}, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemIcon'); | ||
}); | ||
|
||
it('should render the icon slot defined on the item if the item is expanded', () => { | ||
const response = render({ | ||
items: [{ id: '1', children: [{ id: '1.1' }] }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
icon: () => <div data-testid="itemIcon" />, | ||
}, | ||
}, | ||
}, | ||
defaultExpandedItems: ['1'], | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemIcon'); | ||
}); | ||
|
||
it('should render the icon slot defined on the item if the item has no children', () => { | ||
const response = render({ | ||
items: [{ id: '1' }], | ||
slots: { | ||
expandIcon: () => <div data-testid="treeExpandIcon" />, | ||
collapseIcon: () => <div data-testid="treeCollapseIcon" />, | ||
endIcon: () => <div data-testid="treeEndIcon" />, | ||
}, | ||
slotProps: { | ||
item: { | ||
slots: { | ||
expandIcon: () => <div data-testid="itemExpandIcon" />, | ||
collapseIcon: () => <div data-testid="itemCollapseIcon" />, | ||
endIcon: () => <div data-testid="itemEndIcon" />, | ||
icon: () => <div data-testid="itemIcon" />, | ||
}, | ||
}, | ||
}, | ||
}); | ||
|
||
expect(getIconTestId(response, '1')).to.equal('itemIcon'); | ||
}); | ||
}); | ||
}, | ||
); |
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
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.
I had some typing issues while writing those tests so I improved the typing of this slot.
SlotComponentPropsFromProps
allows us to skip thetypeof TreeItem
which can be expensive.I also added
TreeItem2Props
which was completely missing