Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MDXComponents type to useMDXComponents #45737

Merged
merged 2 commits into from
Feb 15, 2023

Conversation

michaeloliverx
Copy link

@michaeloliverx michaeloliverx commented Feb 9, 2023

MDX publishes types which includes a proper MDXComponents type, provides nicer autocomplete for users and also includes the wrapper option:

image

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have a helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • e2e tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have a helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes by running pnpm build && pnpm lint
  • The "examples guidelines" are followed from our contributing doc

@ijjk ijjk added the examples Issue was opened via the examples template. label Feb 9, 2023
@michaeloliverx michaeloliverx marked this pull request as ready for review February 9, 2023 11:18
@ijjk ijjk merged commit 8af2881 into vercel:canary Feb 15, 2023
@michaeloliverx michaeloliverx deleted the app-dir-mdx-types branch February 15, 2023 09:43
kodiakhq bot pushed a commit that referenced this pull request Mar 2, 2023
The `app-dir-mdx` is missing `@types/mdx` thus causing an error: `Cannot find module 'mdx/types' or its corresponding type...`

[Related PR](#45737) previously added types but was missing the line in `package.json`

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue was opened via the examples template.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants