Skip to content

docs-bug(button): Missing documentation for MatButtonHarness with() static function #20270

@chivesrs

Description

@chivesrs

Documentation Feedback

https://material.angular.io/components/button/api#MatButtonHarness

There is a static with() function that lets you find the right instance of mat-button on the page, yet this documentation doesn't support it.

https://material.angular.io/guide/using-component-harnesses states

You can also use the static with method implemented on all Angular Material component harnesses. This method creates a HarnessPredicate, an object that filters loaded harnesses based on the provided constraints. The particular constraint options vary depending on the harness class, but all harnesses support at least:

The docs for the with() function should exist on the Harness docs page as well, and not on this random guide.

Here is the function I am talking about:
https://github.com/angular/components/blob/master/src/material/button/testing/button-harness.ts#L34

Metadata

Metadata

Assignees

Labels

P2The issue is important to a large percentage of users, with a workaroundarea: dgeniIssue related to API docs extractiondocsThis issue is related to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions