cypress-documentation icon indicating copy to clipboard operation
cypress-documentation copied to clipboard

Component testing: API links

Open marktnoonan opened this issue 2 years ago • 1 comments

Subject

Component Testing

Description

Currently each "framework" page has a specific API section. A new page to summarize the underlying ideas within Cypress component testing APIs would be helpful. Suggested topics:

  • Mount APIs and how mount commands work (eg, they are imported, you will quite often make some custom wrappers around the bare mount commands Cypress provides, they yield a certain kind of thing)
  • Accessing the component instance
  • Mounting again clears the previously mounted component
  • How this applies to community framework definitions

And then link to the specific API and types within each section. A top-level "Component Testing > API" page will help users curious about component testing understand how it works more quickly, without requiring them to click a framework and find the nested API docs.

marktnoonan avatar Apr 11 '23 13:04 marktnoonan

How does this differ from what the example pages already do?

elylucas avatar Apr 11 '23 17:04 elylucas