Add minimal support for the components prop #396
Merged
Conversation
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 defines the `_components` variable in `_createMdxContent`. This variable contains all components injected through the `components` prop, a reference to `props`, and all local variables. All MDX JSX tags are prefixed with `_components.` in the virtual code. As a result, components declared in the `components` prop are allowed. Components from both the `components` prop and local variables are displayed in the autocomplete. A downside of this approach is that documentation is lost for local components. To mitigate this, only unknown JSX tags are prefixed. Only MDX JSX tags are handled yet. JSX from estree not yet. Refs #260
remcohaszing
added
🦋 type/enhancement
🦋 Changeset detectedLatest commit: e2eea02 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Merged
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.
Initial checklist
Description of changes
This defines the
_componentsvariable in_createMdxContent. This variable contains all components injected through thecomponentsprop, a reference toprops, and all local variables. All MDX JSX tags are prefixed with_components.in the virtual code.As a result, components declared in the
componentsprop are allowed. Components from both thecomponentsprop and local variables are displayed in the autocomplete.A downside of this approach is that documentation is lost for local components. To mitigate this, only unknown JSX tags are prefixed.
Only MDX JSX tags are handled yet. JSX from estree not yet.
Refs #260