docs(core): add readme for core API #382
Closed
Conversation
This file contains hidden or 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
mcous
commented
Jun 22, 2024
| - options: [Options](#options) | ||
| - renderOptions: [RenderOptions](#renderoptions) | ||
| - Returns | ||
| - [TargetAndBaseElements](#renderelements) |
There was a problem hiding this comment.
Suggested change
| - [TargetAndBaseElements](#renderelements) | |
| - [TargetAndBaseElements](#targetandbaseelements) |
|
|
||
| #### `TargetAndBaseElements.target` | ||
|
|
||
| An [HTMLElement][]the component should be mounted into, usually a `<div>` in |
There was a problem hiding this comment.
Suggested change
| An [HTMLElement][]the component should be mounted into, usually a `<div>` in | |
| An [HTMLElement][] the component should be mounted into, usually a `<div>` in |
mcous
force-pushed
the
readme-links-cleanup
branch
from
34357ad to
533475d
Compare
|
Closing in favor of #391 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In order to support the new threlte/test-renderer, exposing the low-level rendering and cleanup core of
@testing-library/sveltewill allow the two projects to share a bunch of common logic, and provide a better experience for users writing tests for Svelte applications with Threlte.This PR adds the proposed documentation for this core as a little form of README-driven-development. I've taken a look at the Threlte test-renderer source code, and I think these methods would allow a lot of good functionality re-use while remaining flexible to both projects' needs
Rendered output