Email class
📖 Description
The Email class defines an email input control for the Tripetto builder. It is derived from the Text class.
📺 Preview
🆕 constructor
Creates a new Email instance.
Signature
constructor(value?: string | Binding, style?: ITextStyle): Email
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
value | string | Binding | Yes | Specifies the initially value or a data binding created with bind. |
style | ITextStyle | Yes | Specifies the input style (when omitted the default global style will be used). |
Return value
Returns a reference to the new Email instance.
📌 Statics
🏷️ style
Contains the global default style for the input control.
Type
🔧 bind
Binds an object property to the control allowing its value to update automatically when the value of the control changes. If the control is disabled or invisible, the supplied valueWhenInactive is automatically set as the property value. When a control is enabled and visible, the supplied defaultWhenActive is set automatically if the property value is currently not defined.
Signature
bind<Target, P extends keyof Target>(
target: Target,
property: P,
valueWhenInactive: string,
defaultWhenActive?: string,
modifier?: (value?: string) => string
): Binding;
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
target | Target | No | Reference to the target object which contains the property. |
property | P | No | Specifies the name of the property. |
valueWhenInactive | string | No | Specifies the value which is set to the property when the control is inactive (disabled or invisible). |
defaultWhenActive | string | Yes | Specifies the default (initial) value that will be used when the control is active (enabled and visible). |
modifier | (value?: string) => string | Yes | Specifies a modifier function for the data. |
Return value
Returns a Binding instance that can be used in the controls constructor to bind a value to a control.
Example
import { Forms } from "@tripetto/builder";
const example = {
emailAddress: ""
};
const emailAddress = new Forms.Email(Forms.Email.bind(example, "emailAddress", ""));
🗃️ Fields
🏷️ hasFocus
Retrieves if the control has input focus.
Type
boolean
🏷️ isDisabled
Sets or retrieves if the control is disabled.
Type
boolean
🏷️ isLocked
Sets or retrieves if the control is locked (readonly).
Type
boolean
🏷️ isObservable
Retrieves if the control is observable.
Type
boolean
🏷️ isRequired
Sets or retrieves if the control is required.
Type
boolean
🏷️ isVisible
Sets or retrieves the visibility of the control.
Type
boolean
🏷️ style
Contains the email control style.
Type
🏷️ value
Sets or retrieves the input value.
Type
string
▶️ Methods
🔧 blur
Blurs the focus of the control.
Signature
blur(): void
🔧 align
Sets the alignment of the control.
Signature
align(align: "left" | "center" | "right"): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
align | "left" | "center" | "right" | No | Specifies the alignment. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 autoSelect
Specifies if the text needs to be selected automatically.
Signature
autoSelect(select?: "no" | "focus" | "auto-focus"): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
select | "no" | "focus" | "auto-focus" | Yes | Specifies if the text needs to be selected. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 autoValidate
Enables automatic control validation.
Signature
autoValidate(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 copyToClipboard
Copies the contents of the input control to the clipboard.
Signature
copyToClipboard(): void
🔧 disable
Disables the control.
Signature
disable(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 disabled
Specifies the state of the control.
Signature
disabled(disabled?: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
disabled | boolean | Yes | Specifies if the control is disabled (default is true). |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 enable
Enables the control.
Signature
enable(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 enter
Specifies the function which is invoked when the user presses the enter key.
Signature
enter(fn: (email: Email) => boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
fn | (email: Email) => boolean | No | Specifies the function to invoke. To cancel the normal behavior return true within the function. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 escape
Specifies the function which is invoked when the user presses the escape key.
Signature
escape<T extends Text>(fn: (email: Email) => boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
fn | (email: Email) => boolean | No | Specifies the function to invoke. To cancel the normal behavior return true within the function. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 focus
Sets the focus to the control.
Signature
focus(): boolean
Return value
Returns true if the focus is set.
🔧 hide
Hides the control.
Signature
hide(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 indent
Enables control indentation. This can only be set during construction.
Signature
indent(size: number): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
size | number | No | Specifies the indent size in pixels. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 label
Sets the label for the control.
Signature
label(label: string): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
label | string | No | Specifies the control label. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 lock
Locks the control.
Signature
lock(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 locked
Specifies if the control is locked (readonly).
Signature
locked(locked?: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
locked | boolean | Yes | Specifies if the control is locked/readonly (default is true). |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 markdown
Specifies if the label should support markdown formatting.
Signature
markdown(options?: IMarkdownOptions): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
options | IMarkdownOptions | Yes | Specifies the markdown options. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 on
Specifies the function which is invoked when the input value changes.
Signature
on(fn: (email: Email) => void): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
fn | (email: Email) => void | No | Specifies the change function. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 placeholder
Sets a placeholder for the email control.
Signature
placeholder(placeholder: string): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
placeholder | string | No | Specifies the placeholder text. |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 readonly
Makes the control readonly.
Signature
readonly(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 require
Makes the control required.
Signature
require(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 required
Specifies if the control is required.
Signature
required(required?: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
required | boolean | Yes | Specifies if the control is required (default is true). |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 select
Selects the text.
Signature
select(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 show
Shows the control.
Signature
show(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 unlock
Unlocks the control.
Signature
unlock(): this
Return value
Returns a reference to the Email instance to allow chaining.
🔧 visible
Specifies the visibility of the control.
Signature
visible(visible?: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
visible | boolean | Yes | Specifies if the control is visible (default is true). |
Return value
Returns a reference to the Email instance to allow chaining.
🔧 width
Sets the width of the control.
Signature
width(width: number): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
width | number | No | Specifies the control width in pixels. |
Return value
Returns a reference to the Email instance to allow chaining.