Interface Converted<T, C>

Type Parameters

  • T

  • C

Hierarchy

Constructors

constructor

Properties

category? converted defaultValue description? fieldLabels? help? hideIf? isEssential? isHidden? isOptional? label? legend? shortLabel? twoColumns? type

Methods

fromValue toValue

Constructors

constructor

constructor

Properties

Optional category

category?: string

converted

converted: <internal>.Any

defaultValue

defaultValue: T

Optional description

description?: string

Optional fieldLabels

fieldLabels?: { [name: string]: string }

Type declaration

  • [name: string]: string

Optional help

help?: ((value: any) => { description?: string; legend?: Legend })

Type declaration

    • (value: any): { description?: string; legend?: Legend }

    • Parameters

      • value: any

      Returns { description?: string; legend?: Legend }

      • Optional description?: string
      • Optional legend?: Legend

Optional hideIf

hideIf?: ((currentGroup: any) => boolean)

Type declaration

    • (currentGroup: any): boolean

    • Parameters

      • currentGroup: any

      Returns boolean

Optional isEssential

isEssential?: boolean

Optional isHidden

isHidden?: boolean

Optional isOptional

isOptional?: boolean

Optional label

label?: string

Optional legend

legend?: Legend

Optional shortLabel

shortLabel?: boolean

Optional twoColumns

twoColumns?: boolean

type

type: "converted"

Methods

fromValue

  • converts from prop value to display value

    Parameters

    • v: T

    Returns C

toValue

  • converts from display value to prop value

    Parameters

    • v: C

    Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc