Module "component-wrapper/makeDynamic"

Const makeDynamic

• makeDynamic<Props, PropNamesToMap, Value>(Component: React.ElementType<Props>, propMap: MakeDynamicPropMap<Pick<Props, PropNamesToMap>>, valueChangeAdapter: MakeDynamicValueChangeAdapter<Value>): FunctionComponent<Subtract<Props, Pick<Props, PropNamesToMap>> & DynamicComponentControlledProps<Value>>

• A Higher Order Component (HOC) for mapping DynamicComponentControlledProps to a component's props without the hassle of creating a wrapper component.

  You will need to provide the type parameters to have this function correctly.

  typeparam

  The type of the React component wrapped by this HOC.

  Type parameters

  • Props: {}

    The proptypes for Component.

  • PropNamesToMap: string

    A union of the names of the props in Props that need to be mapped to DynamicComponentControlledProps via propMap.

    type PropNamesToMap = "inputValue" | "onInputValueChange" | "inputDisabled";

    Do not use string or all props will be removed from the PropTypes!

  • Value

    The type of the DynamicComponentControlledProps.value to be used by Component.

  Parameters

  • Component: React.ElementType<Props>

    The React component to wrap.

  • propMap: MakeDynamicPropMap<Pick<Props, PropNamesToMap>>

    The map of DynamicComponentControlledProps keys to PropNamesToMap.

  • valueChangeAdapter: MakeDynamicValueChangeAdapter<Value>

  Returns FunctionComponent<Subtract<Props, Pick<Props, PropNamesToMap>> & DynamicComponentControlledProps<Value>>

  A React component, ready to be used in a DynamicComponent, with its DynamicComponentControlledProps mapped to the Component as specified by the propMap.