microsoft / microsoft/TypeScript
Props requiring casting on complex type (and defaultProps not settable)
Open
@weswigham is already working on this.
Since Dec 8, 2018.
Bug
Domain: JSX/TSX
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms:
defaultProps React.RefForwardingComponent ExoticComponent
Code
// import { cx } from "emotion";
import * as React from "react";
// import modifiers, { ModifierProps } from "../../modifiers";
interface RenderAsExoticComponent<
TOwnProps,
TDefaultComponent extends
| keyof JSX.IntrinsicElements
| React.ComponentType<any>
>
extends Pick<
React.ForwardRefExoticComponent<any>,
keyof React.ForwardRefExoticComponent<any>
> {
(
props: React.ComponentPropsWithRef<TDefaultComponent> &
TOwnProps & { renderAs?: never },
): JSX.Element | null;
<TAsComponent extends keyof JSX.IntrinsicElements | React.ComponentType<any>>(
props: React.ComponentPropsWithRef<TAsComponent> &
TOwnProps & { renderAs: TAsComponent },
): JSX.Element | null;
}
function renderAsComponent<
TOwnProps,
TDefaultElement extends React.ComponentType<any> | keyof JSX.IntrinsicElements
>(
factory: React.RefForwardingComponent<
any,
TOwnProps & {
renderAs?: React.ComponentType<any> | keyof JSX.IntrinsicElements;
className?: string;
}
>,
defaultElement: TDefaultElement,
) {
const forward = React.forwardRef(factory);
forward.defaultProps = { renderAs: defaultElement };
// todo: apparently a bug, use workaround
// forward.defaultProps = {};
// forward.defaultProps.renderAs = defaultElement;
return forward as RenderAsExoticComponent<TOwnProps, TDefaultElement>;
}
interface ModifierProps {
textColor?: "white" | "black";
pull?: "left" | "right";
}
const Element = renderAsComponent<ModifierProps, "div">(
({ className, renderAs, ...allProps }, ref) => {
const props = {
// className: cx(className, modifiers.classNames(allProps)) || undefined,
ref,
// ...modifiers.clean(allProps),
};
return React.createElement(renderAs!, props);
},
"div",
);
export default Element;
export const Example: React.SFC<{}> = () => (
<Element textColor="white" pull={"left" as "left"}>
Child
</Element>
);
Expected behavior:
defaultPropscan be set directlypropswork without casting
Actual behavior:
defaultPropscannot be set directly (see workaround in code)propsdo not work without being cast.
Playground Link:
Related Issues:
No.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.