https://github.com/kripod/react-polymorphic-types

Zero-runtime polymorphic component definitions for React
https://github.com/kripod/react-polymorphic-types

as-prop polymorphism react typescript

Last synced: 19 days ago
JSON representation

Zero-runtime polymorphic component definitions for React

• Host: GitHub
• URL: https://github.com/kripod/react-polymorphic-types
• Owner: kripod
• License: mit
• Created: 2020-12-27T17:29:12.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T10:27:32.000Z (7 months ago)
• Last Synced: 2024-09-19T00:52:27.032Z (about 2 months ago)
• Topics: as-prop, polymorphism, react, typescript
• Homepage:
• Size: 26.4 KB
• Stars: 194
• Watchers: 6
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# react-polymorphic-types

Zero-runtime polymorphic component definitions for React

[![npm](https://img.shields.io/npm/v/react-polymorphic-types)](https://www.npmjs.com/package/react-polymorphic-types)

## Motivation

Being a successor to [react-polymorphic-box](https://github.com/kripod/react-polymorphic-box), this project offers more accurate typings with less overhead.

## Features

- Automatic code completion, based on the value of the `as` prop

- Static type checking against the associated component’s inferred props

- HTML element name validation

## Usage

A `Heading` component can demonstrate the effectiveness of polymorphism:

```tsx

Heading

Subheading

```

Custom components like the previous one may utilize the package as shown below.

```tsx

import type { PolymorphicPropsWithoutRef } from "react-polymorphic-types";

// An HTML tag or a different React component can be rendered by default

export const HeadingDefaultElement = "h2";

// Component-specific props should be specified separately

export type HeadingOwnProps = {

  color?: string;

};

// Extend own props with others inherited from the underlying element type

// Own props take precedence over the inherited ones

export type HeadingProps<

  T extends React.ElementType = typeof HeadingDefaultElement

> = PolymorphicPropsWithoutRef;

export function Heading<

  T extends React.ElementType = typeof HeadingDefaultElement

>({ as, color, style, ...restProps }: HeadingProps) {

  const Element: React.ElementType = as || HeadingDefaultElement;

  return ;

}

```

---

⚠️ All the additional typings below will be deprecated as soon as [microsoft/TypeScript#30134](https://github.com/microsoft/TypeScript/issues/30134) is resolved.

### With [`React.forwardRef`](https://reactjs.org/docs/react-api.html#reactforwardref)

```tsx

import * as React from "react";

import type {

  PolymorphicForwardRefExoticComponent,

  PolymorphicPropsWithoutRef,

  PolymorphicPropsWithRef

} from "react-polymorphic-types";

import { HeadingDefaultElement, HeadingOwnProps } from "./Heading";

export type HeadingProps<

  T extends React.ElementType = typeof HeadingDefaultElement

> = PolymorphicPropsWithRef;

export const Heading: PolymorphicForwardRefExoticComponent<

  HeadingOwnProps,

  typeof HeadingDefaultElement

> = React.forwardRef(function Heading<

  T extends React.ElementType = typeof HeadingDefaultElement

>(

  {

    as,

    color,

    style,

    ...restProps

  }: PolymorphicPropsWithoutRef,

  ref: React.ForwardedRef

) {

  const Element: React.ElementType = as || HeadingDefaultElement;

  return ;

});

```

### With [`React.memo`](https://reactjs.org/docs/react-api.html#reactmemo)

```tsx

import * as React from "react";

import type { PolymorphicMemoExoticComponent } from "react-polymorphic-types";

import { Heading, HeadingDefaultElement, HeadingOwnProps } from "./Heading";

export const MemoizedHeading: PolymorphicMemoExoticComponent<

  HeadingOwnProps,

  typeof HeadingDefaultElement

> = React.memo(Heading);

```

### With [`React.lazy`](https://reactjs.org/docs/react-api.html#reactlazy)

```tsx

import * as React from "react";

import type { PolymorphicLazyExoticComponent } from "react-polymorphic-types";

import type { HeadingDefaultElement, HeadingOwnProps } from "./Heading";

export const LazyHeading: PolymorphicLazyExoticComponent<

  HeadingOwnProps,

  typeof HeadingDefaultElement

> = React.lazy(async () => {

  const { Heading } = await import("./Heading");

  return { default: Heading };

});

```