acme.textui.ACMEFieldOriginator.ACMEInputField

class documentation

class ACMEInputField(Container):

Known subclasses: acme.textui.ACMEFieldOriginator.ACMEFieldOriginator

Constructor: ACMEInputField(label, value, suggestions, placeholder, ...)

A generic input field for the ACME text UI.

Class	`Submitted`	The message that is sent when the input field is submitted.
Method	`__init__`	Initialize the input field.
Method	`compose`	Compose the input field.
Method	`setLabel`	Set the label of the field.
Method	`setSuggestions`	Set the suggestions for the input field.
Method	`show_validation_feedback`	Show the validation feedback.
Async Method	`submit`	Submit the input field.
Method	`value.setter`	Set the value of the input field.
Property	`inputField`	Return the input field.
Property	`msgField`	Return the message field.
Property	`value`	Return the value of the input field.
Instance Variable	`_fieldInput`	The input view of the input field.
Instance Variable	`_fieldLabel`	The label view of the input field.
Instance Variable	`_fieldMessage`	The message view of the input field.
Instance Variable	`_labelText`	The label text of the input field.
Instance Variable	`_placeholder`	The placeholder text of the input field.
Instance Variable	`_suggestions`	The suggestions for the input field.
Instance Variable	`_validators`	The validators of the input field.
Instance Variable	`_value`	The value of the input field.

def __init__(self, label: str = 'a label', value: str = '', suggestions: list[str] = [], placeholder: str = '', validators: Function = None, id: str = None): ¶

overridden in acme.textui.ACMEFieldOriginator.ACMEFieldOriginator

Initialize the input field.

Parameters
label:`str`	The label of the input field.
value:`str`	The value of the input field.
suggestions:`list[str]`	A list of suggestions for the input field.
placeholder:`str`	The placeholder for the input field.
validators:`Function`	The validators for the input field.
id:`str`	The ID of the input field.

def compose(self) -> ComposeResult: ¶

Compose the input field.

Yields
The input field view.

def setLabel(self, label: str): ¶

Set the label of the field.

Parameters
label:`str`	The label to set.

def setSuggestions(self, suggestions: list[str]): ¶

Set the suggestions for the input field.

Parameters
suggestions:`list[str]`	The suggestions to set.

@on(Input.Changed)

def show_validation_feedback(self, event: Input.Changed): ¶

Show the validation feedback.

Parameters
event:`Input.Changed`	The Input.Changed event that triggered the validation feedback.

@on(Input.Submitted, '#field-input')

async def submit(self, event: Input.Submitted): ¶

Submit the input field.

Parameters
event:`Input.Submitted`	The Input.Submitted event that triggered the submission.

@value.setter

def value(self, value: str): ¶

Set the value of the input field.

Parameters
value:`str`	The value to set.

@property

inputField: Input = ¶

Return the input field.

Returns
The input field.

@property

msgField: Label = ¶

Return the message field.

Returns
The message field.

@property

value: str = ¶

overridden in acme.textui.ACMEFieldOriginator.ACMEFieldOriginator

Return the value of the input field.

Returns
The value of the input field.

_fieldInput = ¶

The input view of the input field.

_fieldLabel = ¶

The label view of the input field.

_fieldMessage = ¶

The message view of the input field.

_labelText = ¶

The label text of the input field.

_placeholder = ¶

The placeholder text of the input field.

_suggestions = ¶

The suggestions for the input field.

_validators = ¶

The validators of the input field.

_value = ¶

The value of the input field.