Interface: FieldDef
item.FieldDef
Field definition containing meta data for a certain field type
Properties
actions
• Optional actions: { icon: string ; label: string ; action:
(value: string) => void }[]
Defined in
icon
• icon: string
icon used for display
Defined in
mask
• mask: boolean
whether the field should be masked when displayed
Defined in
matchPattern
• matchPattern: RegExp
regular expression describing pattern of field contents (used for matching)
Defined in
multiline
• multiline: boolean
whether the field value can have multiple lines
Defined in
name
• name: string
display name
Defined in
pattern
• pattern: RegExp
regular expression describing pattern of field contents (used for validation)
Defined in
type
• type: FieldType
content type
Defined in
Methods
format
▸ Optional format(value, masked): string
display formatting
Parameters
| Name | Type |
|---|---|
value |
string |
masked |
boolean |
Returns
string
Defined in
transform
▸ Optional transform(value): Promise<string>
for values that need to be prepared before being copied / filled
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
Promise<string>