EditorWidget

When to Use

Use EditorWidget when you need multi-line text editing: a message composer, a code snippet editor, a configuration file viewer, etc. For single-line input, use InputWidget instead.

Basic Usage

1
2
3
4
5

use Symfony\Component\Tui\Widget\EditorWidget;

$editor = new EditorWidget();
$tui->add($editor);
$tui->setFocus($editor);

Set or read the editor content:

1
2

$editor->setText("Line one\nLine two");
$content = $editor->getText();

Sizing

Control the visible height of the editor with minimum and maximum line counts:

1
2

$editor->setMinVisibleLines(5);
$editor->setMaxVisibleLines(20);

To make the editor fill all remaining vertical space, call:

1

$editor->expandVertically(true);

Events

EditorWidget dispatches three events:

• SubmitEvent: Fired when the user presses Enter (the default submit binding). Use Shift+Enter to insert a newline instead:

  1
  2
  3
  4
  5

  use Symfony\Component\Tui\Event\SubmitEvent;
  
  $editor->onSubmit(function (SubmitEvent $event) {
      $text = $event->getValue();
  });

• CancelEvent: Fired when the user presses Escape:

  1
  2
  3

  $editor->onCancel(function () {
      // discard changes or close the editor
  });

• ChangeEvent: Fired on every text modification:

  1
  2
  3
  4
  5

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

Default Keybindings