-
Notifications
You must be signed in to change notification settings - Fork 677
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
feat(@theme-ui/mdx): add TypeScript support #703
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
import { jsx, IntrinsicSxElements } from '@theme-ui/core' | ||
import { css, get, Theme } from '@theme-ui/css' | ||
import { ComponentType, FC, ReactNode } from 'react' | ||
import styled, { Interpolation } from '@emotion/styled' | ||
import { | ||
MDXProvider as _MDXProvider, | ||
useMDXComponents | ||
} from '@mdx-js/react' | ||
|
||
|
||
export type MdxAliases = { | ||
[key in keyof IntrinsicSxElements]: keyof JSX.IntrinsicElements | ||
} | ||
|
||
export type MdxAliasesKeys = 'inlineCode' | 'thematicBreak' | 'root' | ||
|
||
export type MdxProviderComponents = { | ||
[key in keyof IntrinsicSxElements]: ComponentType | ||
} | ||
|
||
export type ThemedProps = { | ||
theme: Theme | ||
} | ||
|
||
export interface MdxProviderProps { | ||
components?: MdxProviderComponents | ||
children: ReactNode | ||
} | ||
|
||
// mdx components | ||
const tags: Array<keyof IntrinsicSxElements> = [ | ||
'p', | ||
'b', | ||
'i', | ||
'a', | ||
'h1', | ||
'h2', | ||
'h3', | ||
'h4', | ||
'h5', | ||
'h6', | ||
'img', | ||
'pre', | ||
'code', | ||
'ol', | ||
'ul', | ||
'li', | ||
'blockquote', | ||
'hr', | ||
'em', | ||
'table', | ||
'tr', | ||
'th', | ||
'td', | ||
'em', | ||
'strong', | ||
'del', | ||
// mdx | ||
'inlineCode', | ||
'thematicBreak', | ||
// other | ||
'div', | ||
// theme-ui | ||
'root', | ||
] | ||
|
||
const aliases: Pick<MdxAliases, MdxAliasesKeys> = { | ||
inlineCode: 'code', | ||
thematicBreak: 'hr', | ||
root: 'div', | ||
} | ||
|
||
const alias = (n: keyof IntrinsicSxElements): keyof JSX.IntrinsicElements => aliases[n] || n | ||
|
||
export const themed = (key: keyof IntrinsicSxElements) => (props: ThemedProps) => | ||
css(get(props.theme, `styles.${key}`))(props.theme) as Interpolation<ThemedProps> | ||
|
||
export const Styled = styled('div')(themed('div')) | ||
|
||
export const components = {} | ||
|
||
tags.forEach(tag => { | ||
components[tag] = styled(alias(tag))(themed(tag)) | ||
Styled[tag] = components[tag] | ||
}) | ||
|
||
const createComponents = (comps: MdxProviderComponents) => { | ||
const next = { ...components } | ||
|
||
const componentKeys = Object.keys(comps) as Array<keyof IntrinsicSxElements> | ||
|
||
componentKeys.forEach(key => { | ||
next[key] = styled(comps[key])(themed(key)) | ||
}) | ||
return next | ||
} | ||
|
||
export const MDXProvider: FC<MdxProviderProps> = ({ | ||
components, | ||
children, | ||
}) => { | ||
const outer = useMDXComponents() | ||
|
||
return jsx(_MDXProvider, { | ||
components: createComponents({ ...outer, ...components }), | ||
children, | ||
}) | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"extends": "../core/tsconfig.json", | ||
"include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.d.ts"] | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a MDX thing as isinlineCode
andthematicBreak
.https://github.com/gatsbyjs/gatsby/blob/master/docs/docs/mdx/customizing-components.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I'm just a bit confused- in v0.3 (which fixed the issue reported in #401),
delete
was renamed todel
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn’t know about #401. I’m as confused as you are or more. Sorry 😄