import { innerText } from "@interactors/html";
/**
* Call this {@link InteractorConstructor} to initialize a text field {@link
* Interactor}. The text field interactor can be used to interact with text
* fields on the page and to assert on their state. A text field is any input
* tag with a text-like interface, so input fields with e.g. `email` or `number`
* types are also considered text fields, as is any input field with an unknown
* type.
*
* The text field is located by the text of its label or placeholder.
*
* ### Example
*
* ``` typescript
* await TextField('Email').fillIn('jonas@example.com');
* await TextField('Email').has({ value: 'jonas@example.com' });
* await TextField({ id: 'email-field', disabled: true }).exists();
* ```
*
* ### Filters
*
* - `title`: *string* – Filter by title
* - `id`: *string* – Filter by id
* - `visible`: *boolean* – Filter by visibility. Defaults to `true`. See {@link isVisible}.
* - `value`: *string* – Filter by the text field's current value.
* - `placeholder`: *string* – Filter by the text field's placeholder attribute.
* - `description`: *string* – Filter by the text field's description attribute.
* - `valid`: *boolean* – Filter by whether the text field is valid.
* - `required`: *boolean* – Filter by whether the text field is required.
* - `disabled`: *boolean* – Filter by whether the text field is disabled. Defaults to `false`.
* - `focused`: *boolean* – Filter by whether the text field is focused. See {@link focused}.
*
* ### Actions
*
* - `click()`: *{@link Interaction}* – Click on the text field
* - `focus()`: *{@link Interaction}* – Move focus to the text field
* - `blur()`: *{@link Interaction}* – Move focus away from the text field
* - `fillIn(value: string)`: *{@link Interaction}* – Fill in the text field with the given value. See {@link fillIn}.
*
* @category Interactor
*/
export declare const TextField: import("@interactors/html").InteractorConstructor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>, {
valid?: import("@interactors/html").MaybeMatcher | undefined;
disabled?: import("@interactors/html").MaybeMatcher | undefined;
}>, {
value?: import("@interactors/html").MaybeMatcher | undefined;
placeholder?: import("@interactors/html").MaybeMatcher | undefined;
}>, {
valid?: import("@interactors/html").MaybeMatcher | undefined;
required?: import("@interactors/html").MaybeMatcher | undefined;
description?: import("@interactors/html").MaybeMatcher | undefined;
}>, import("@interactors/html").MergeObjects string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}>>, import("@interactors/html").FilterMethods boolean;
disabled: {
apply: (element: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => boolean;
default: boolean;
};
}>>, import("@interactors/html").FilterMethods string;
placeholder: (element: HTMLInputElement | HTMLTextAreaElement) => string;
}>>, import("@interactors/html").FilterMethods boolean;
required: (element: HTMLInputElement | HTMLTextAreaElement) => boolean;
description: (element: HTMLInputElement | HTMLTextAreaElement) => string;
}>>, import("@interactors/html").MergeObjects | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject, init?: MouseEventInit | undefined) => import("@interactors/html").ActionInteraction;
focus: ({ perform }: import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject) => import("@interactors/html").ActionInteraction;
blur: ({ perform }: import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject) => import("@interactors/html").ActionInteraction;
}, import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject>>, import("@interactors/html").ActionMethods | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>, {
valid?: import("@interactors/html").MaybeMatcher | undefined;
disabled?: import("@interactors/html").MaybeMatcher | undefined;
}>, {
value?: import("@interactors/html").MaybeMatcher | undefined;
placeholder?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
placeholder: (element: HTMLInputElement | HTMLTextAreaElement) => string;
}> & Omit string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}>>, import("@interactors/html").FilterMethods boolean;
disabled: {
apply: (element: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => boolean;
default: boolean;
};
}>>, "value" | "placeholder"> & import("@interactors/html").ActionMethods | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject, init?: MouseEventInit | undefined) => import("@interactors/html").ActionInteraction;
focus: ({ perform }: import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject) => import("@interactors/html").ActionInteraction;
blur: ({ perform }: import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject) => import("@interactors/html").ActionInteraction;
}, import("@interactors/html").Interactor | undefined;
title?: import("@interactors/html").MaybeMatcher | undefined;
id?: import("@interactors/html").MaybeMatcher | undefined;
visible?: import("@interactors/html").MaybeMatcher | undefined;
className?: import("@interactors/html").MaybeMatcher | undefined;
classList?: import("@interactors/html").MaybeMatcher | undefined;
focused?: import("@interactors/html").MaybeMatcher | undefined;
}>> & import("@interactors/html").FilterMethods string;
id: (element: HTMLElement) => string;
visible: {
apply: typeof import("element-is-visible").isVisible;
default: boolean;
};
className: (element: HTMLElement) => string;
classList: (element: HTMLElement) => string[];
focused: (element: HTMLElement) => boolean;
}> & Omit & import("@interactors/html").EmptyObject> & Omit>>>;
//# sourceMappingURL=text-field.d.ts.map