@serenity-is/corelib / BooleanFormatter

Class: BooleanFormatter

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

Implements

• Formatter

Constructors

Constructor

new BooleanFormatter(props): BooleanFormatter

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

Parameters

props

falseIcon?

IconClassName

falseText?

string

nullIcon?

IconClassName

nullText?

string

showHint?

boolean

showText?

boolean

trueIcon?

IconClassName

trueText?

string

Returns

BooleanFormatter

Properties

props

readonly props: object = {}

Defined in: src/ui/formatters/booleanformatter.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/booleanformatter.tsx:6

Accessors

falseText

Get Signature

get falseText(): string

Defined in: src/ui/formatters/booleanformatter.tsx:48

Returns

string

Set Signature

set falseText(value): void

Defined in: src/ui/formatters/booleanformatter.tsx:49

Parameters

value

string

Returns

void

---

trueText

Get Signature

get trueText(): string

Defined in: src/ui/formatters/booleanformatter.tsx:51

Returns

string

Set Signature

set trueText(value): void

Defined in: src/ui/formatters/booleanformatter.tsx:52

Parameters

value

string

Returns

void

Methods

format()

format(ctx): FormatterResult

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

Parameters

ctx

FormatterContext

Returns

FormatterResult

Implementation of

Formatter.format