InputWidget

When to Use

Use InputWidget when you need a short, single-line text field: a search box, a filename prompt, a command palette filter, etc. For multi-line editing, use EditorWidget instead.

Basic Usage

1
2
3
4
5

use Symfony\Component\Tui\Widget\InputWidget;

$input = new InputWidget();
$tui->add($input);
$tui->setFocus($input);

Set an initial value or read the current value:

1
2

$input->setValue('initial text');
$value = $input->getValue();

Prompt

The prompt string is displayed before the cursor. Change it with setPrompt():

1

$input->setPrompt('Search: ');

The default prompt is > .

Events

InputWidget dispatches three events:

• SubmitEvent: Fired when the user presses Enter. The event carries the current text value:

  1
  2
  3
  4
  5
  6

  use Symfony\Component\Tui\Event\SubmitEvent;
  
  $input->onSubmit(function (SubmitEvent $event) {
      $value = $event->getValue();
      // process the submitted text
  });

• CancelEvent: Fired when the user presses Escape or Ctrl+C:

  1
  2
  3

  $input->onCancel(function () {
      // close the input or revert changes
  });

• ChangeEvent: Fired on every text modification (typing, deleting, pasting):

  1
  2
  3
  4
  5

  use Symfony\Component\Tui\Event\ChangeEvent;
  
  $input->onChange(function (ChangeEvent $event) {
      $currentText = $event->getValue();
  });

You can check after the fact whether the input was submitted or cancelled with wasSubmitted().

Default Keybindings

Custom Keybindings

Pass a Keybindings instance to the constructor to override any of the default bindings:

1
2
3
4
5

use Symfony\Component\Tui\Input\Keybindings;

$input = new InputWidget(keybindings: new Keybindings([
    'submit' => ['ctrl+s'],
]));