Skip to content

Add support for SpecialComponents to be any ComponentType #640

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 21, 2021
+20 −26
Merged

Add support for SpecialComponents to be any ComponentType #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 19 additions & 26 deletions lib/ast-to-react.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @template T
* @typedef {import('react').ComponentType<T>} ComponentType<T>
*/

/**
* @typedef {import('react').ReactNode} ReactNode
* @typedef {import('unist').Position} Position
Expand Down Expand Up @@ -44,33 +49,21 @@
*
* To do: is `data-sourcepos` typeable?
*
* @callback CodeComponent
* @param {JSX.IntrinsicElements['code'] & ReactMarkdownProps & {inline?: boolean}} props
* @returns {ReactNode}
*
* @callback HeadingComponent
* @param {JSX.IntrinsicElements['h1'] & ReactMarkdownProps & {level: number}} props
* @returns {ReactNode}
*
* @callback LiComponent
* @param {JSX.IntrinsicElements['li'] & ReactMarkdownProps & {checked: boolean|null, index: number, ordered: boolean}} props
* @returns {ReactNode}
*
* @callback OrderedListComponent
* @param {JSX.IntrinsicElements['ol'] & ReactMarkdownProps & {depth: number, ordered: true}} props
* @returns {ReactNode}
*
* @callback TableCellComponent
* @param {JSX.IntrinsicElements['table'] & ReactMarkdownProps & {style?: Object.<string, unknown>, isHeader: boolean}} props
* @returns {ReactNode}
*
* @callback TableRowComponent
* @param {JSX.IntrinsicElements['tr'] & ReactMarkdownProps & {isHeader: boolean}} props
* @returns {ReactNode}
* @typedef {JSX.IntrinsicElements['code'] & ReactMarkdownProps & {inline?: boolean}} CodeProps
* @typedef {JSX.IntrinsicElements['h1'] & ReactMarkdownProps & {level: number}} HeadingProps
* @typedef {JSX.IntrinsicElements['li'] & ReactMarkdownProps & {checked: boolean|null, index: number, ordered: boolean}} LiProps
* @typedef {JSX.IntrinsicElements['ol'] & ReactMarkdownProps & {depth: number, ordered: true}} OrderedListProps
* @typedef {JSX.IntrinsicElements['table'] & ReactMarkdownProps & {style?: Object.<string, unknown>, isHeader: boolean}} TableCellProps
* @typedef {JSX.IntrinsicElements['tr'] & ReactMarkdownProps & {isHeader: boolean}} TableRowProps
* @typedef {JSX.IntrinsicElements['ul'] & ReactMarkdownProps & {depth: number, ordered: false}} UnorderedListProps
*
* @callback UnorderedListComponent
* @param {JSX.IntrinsicElements['ul'] & ReactMarkdownProps & {depth: number, ordered: false}} props
* @returns {ReactNode}
* @typedef {ComponentType<CodeProps>} CodeComponent
* @typedef {ComponentType<HeadingProps>} HeadingComponent
* @typedef {ComponentType<LiProps>} LiComponent
* @typedef {ComponentType<OrderedListProps>} OrderedListComponent
* @typedef {ComponentType<TableCellProps>} TableCellComponent
* @typedef {ComponentType<TableRowProps>} TableRowComponent
* @typedef {ComponentType<UnorderedListProps>} UnorderedListComponent
*
* @typedef SpecialComponents
* @property {CodeComponent|ReactMarkdownNames} code
Expand Down
1 change: 1 addition & 0 deletions test/test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1195,6 +1195,7 @@ test('should pass `node` as prop to all non-tag/non-fragment components', () =>
<Markdown
children={input}
components={{
// @ts-expect-error JSX types currently only handle element returns not string returns
h1(props) {
let text = ''
visit(props.node, 'text', (child) => {
Expand Down