-
Notifications
You must be signed in to change notification settings - Fork 2
feat(dom): DOM - ttoHaveClass , toHaveAllClasses and toHaveAnyClass #134
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
base: main
Are you sure you want to change the base?
Conversation
6827334
to
18f9d98
Compare
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.
Looks great @fonsiher. Thank you!
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.
Looks good so far, but I think we can improve things if we create 3 assertions instead of one 🙂
* - `exact` (boolean): When true, checks for an exact match of all classes. | ||
* @returns the assertion instance. | ||
*/ | ||
public toHaveClass(classNames: string | string[], options: { exact?: boolean; } = {}): this { |
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.
What do you think about making more than one assertion instead of adding the options param? To me, it'll provide more readability if we have the following:
expect(elem).toHaveClass("w-full"); // single arg
expect(elem).toHaveAnyClass("w-full", "flex"); // variadic args
expect(elem).toHaveAllClasses("w-full", "flex", "gap-8"); // variadic args
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.
Thanks @JoseLion this is actually a great idea to improve readability. I just added these new matches.
2f3d0b5
to
6e6062d
Compare
6e6062d
to
a831c90
Compare
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.
Can we rename the PR to contain all the toHaveClass , toHaveAllClasses, toHaveAnyClass 👀 please?
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.
Looking good! I left some comments and suggestions. Let me know if you have any questions 🙂
/** | ||
* Asserts that the element has the specified class. | ||
* | ||
* @param className - The class name to check. |
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.
No need to add the hyphen. IDEs add it for us:
* @param className - The class name to check. | |
* @param className The class name to check. |
it("returns the assertion instance", async () => { | ||
const { findByTestId } = render(<HaveClassTestComponent />); | ||
const divTest = await findByTestId("classTest"); | ||
divTest.classList.add("foo", "bar"); |
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.
Maybe we can pass a className
prop to the <HaveClassTestComponent />
component to avoid using classList.add(..)
, wdyt?
export function HaveClassTestComponent(): ReactElement { | ||
return ( | ||
<div data-testid="classTest"> | ||
{"Test text inside a div"} | ||
</div> | ||
); | ||
} |
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.
export function HaveClassTestComponent(): ReactElement { | |
return ( | |
<div data-testid="classTest"> | |
{"Test text inside a div"} | |
</div> | |
); | |
} | |
export function HaveClassTestComponent(): ReactElement { | |
return ( | |
<div data-testid="classTest"> | |
{"Test text inside a div"} | |
</div> | |
); | |
} |
|
||
export function HaveClassTestComponent(): ReactElement { | ||
return ( | ||
<div data-testid="classTest"> |
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.
Do we really need the data-testid
? The getByTestID(..)
query should be our last resort when finding elements. For instance, this element can be found with the query below instead:
getByText("Test text inside a div")
Added the toHaveClass matcher.