Skip to content

Interface: ColorField<Nullable> ​

Defined in: config/types.ts:26

A color field in the format #rrggbb. A nullable color field also accepts null for the theme color.

Extends ​

  • FieldBase<"color", Nullable extends true ? string | null : string>

Type Parameters ​

Type ParameterDefault type
Nullable extends booleanboolean

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
defaultreadonlyNullable extends true ? string | null : string-FieldBase.defaultconfig/types.ts:11
descriptionreadonlystringOne sentence that tells what the field changes.FieldBase.descriptionconfig/types.ts:6
kindreadonly"color"-FieldBase.kindconfig/types.ts:10
labelreadonlystringThe short name of the field.FieldBase.labelconfig/types.ts:4
nullablereadonlyNullableTrue if the field accepts null.-config/types.ts:29

Methods ​

parse() ​

ts
parse(input): Nullable extends true ? string | null : string | undefined;

Defined in: config/types.ts:12

Parameters ​

ParameterType
inputunknown

Returns ​

Nullable extends true ? string | null : string | undefined

Inherited from ​

ts
FieldBase.parse