Function When

  • When(props, deprecatedLegacyContext?): ReactNode

  • A shorthand for

    <If condition={...}>
        <Then>
            { ... }
        </Then>
    </If>

    The same rules apply to the child elements as with using the <Then /> block.

    Parameters

    Returns ReactNode

Properties

contextTypes? defaultProps? displayName? propTypes?

Properties

Optional contextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

Optional defaultProps

defaultProps?: Partial<ComponentWithConditionPropsWithFunctionChildren>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

Optional propTypes

propTypes?: WeakValidationMap<ComponentWithConditionPropsWithFunctionChildren>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

Settings

Member Visibility

Theme

On This Page

contextTypesdefaultPropsdisplayNamepropTypes