Layout props #189
Merged
Layout props #189
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
johno
reviewed
Jul 23, 2018
packages/mdx/mdx-hast-to-jsx.js
Outdated
| '\n' + | ||
| `export default ({components}) => <MDXTag name="wrapper" ${layout ? `Layout={${layout}}` : ''} components={components}>${jsxNodes | ||
| `export default (props) => <MDXTag name="wrapper" ${layout ? `Layout={${layout}} layoutProps={objectWithoutProperties(props, ['components'])}` : ''} components={props.components}>${jsxNodes |
There was a problem hiding this comment.
Since the output JSX still requires babel parsing maybe it makes sense to use destructuring?
export default ({ components, ...props }) =>There was a problem hiding this comment.
Great idea! That way I won't be breaking anything, and the change set will be cleaner.
The component exported by MDX files recognized only one prop: components. That was the only prop being passed to the custom layout component, which made MDX very hard to integrate with tools like Gatsby. This change passes all props to the custom layout component, not only "components". Fixes #187.
|
Done. I added that test to @mdx-js/runtime tests, I hope that's fine. There's also a @mdx-js/tag test which tests if |
|
I'm not sure why tests for Node 8.11.3 are failing. I tried locally with that version and it works. |
|
This is great, thanks! Looks like the failed test was a timeout blip that happens every once in a while. Just reran it and all seems good 💟 |
johno
pushed a commit
that referenced
this pull request
Jul 28, 2018
* Git-ignore Lerna's debug log file * Pass rest of the props to custom Layout component The component exported by MDX files recognized only one prop: components. That was the only prop being passed to the custom layout component, which made MDX very hard to integrate with tools like Gatsby. This change passes all props to the custom layout component, not only "components". Fixes #187.
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.
I'm sure that this solution for layout props isn't ideal, but it's a crucial piece of the puzzle for integrating MDX into some tools. The API can always be changed later. Also, this is a breaking change to anyone who decided to use the
componentsprop in their MDX file, because now that should becomeprops.components.With this change we'll be able to do stuff like this:
posts/layout-props.mdx:pages/index.js:Would resolve: