PropsWithChildren

Since 1.2.0

Add children prop to a props type.

Signature

type PropsWithChildren<P = unknown> = P & { children?: ReactNode }

Parameters

Parameter	Description
P	The base props type

Examples

Basic Usage

import type { PropsWithChildren } from 'uni-types'

interface CardProps {
  title: string
}

type CardWithChildren = PropsWithChildren<CardProps>
// { title: string; children?: ReactNode }

Component Definition

type Props = PropsWithChildren<{ className?: string }>

const Container = ({ children, className }: Props) => {
  return <div className={className}>{children}</div>
}

Default Props

type DefaultProps = PropsWithChildren
// { children?: ReactNode }

Related

• PropsWithoutChildren - Remove children prop
• ComponentProps - Extract component props