@serenity-is/corelib / CheckboxFormatter

Class: CheckboxFormatter

Defined in: src/ui/formatters/checkboxformatter.tsx:5

Implements

• Formatter

Constructors

Constructor

new CheckboxFormatter(props): CheckboxFormatter

Defined in: src/ui/formatters/checkboxformatter.tsx:8

Parameters

props

falseIcon?

IconClassName

falseText?

string

nullIcon?

IconClassName

nullText?

string

showHint?

boolean

showText?

boolean

trueIcon?

IconClassName

trueText?

string

Returns

CheckboxFormatter

Properties

props

readonly props: object = {}

Defined in: src/ui/formatters/checkboxformatter.tsx:8

falseIcon?

optional falseIcon: IconClassName

falseText?

optional falseText: string

nullIcon?

optional nullIcon: IconClassName

nullText?

optional nullText: string

showHint?

optional showHint: boolean

showText?

optional showText: boolean

trueIcon?

optional trueIcon: IconClassName

trueText?

optional trueText: string

---

[typeInfo]

static [typeInfo]: FormatterTypeInfo<"Serenity.">

Defined in: src/ui/formatters/checkboxformatter.tsx:6

Methods

format()

format(ctx): FormatterResult

Defined in: src/ui/formatters/checkboxformatter.tsx:21

Parameters

ctx

FormatterContext

Returns

FormatterResult

Implementation of

Formatter.format