TerminalOutputRegion

Shows captured stdout and stderr (a LogBuffer) as a LogRegion: filterable, copyable rows that follow new output, with stderr lines styled as errors.

Import: package:fleury/fleury.dart, or package:fleury/fleury_core.dart in browser code.

Usage

// In a terminal app, runApp captures stdout and stderr into the LogBuffer
// this widget reads by default. Anywhere else, including the browser, feed
// one yourself:
final buffer = LogBuffer(capacity: 500)
  ..add(const LogLine(r'$ dart test', LogSource.stdout))
  ..add(const LogLine('warning: unused import', LogSource.stderr));

TerminalOutputRegion(buffer: buffer)

Details

By default it reads the LogBuffer from the nearest LogBufferScope, which runApp provides in a terminal app; pass buffer to show another. For a minimal tail view without filtering or copy, use OutputCaptureView.

Constructors

TerminalOutputRegion()

Parameter	Type	Default	Description
buffer:	LogBuffer?	—	Runtime output buffer to render; defaults to the ambient LogBufferScope.
controller:	LogRegionController?	—	External selection and tail-follow controller.
focusNode:	FocusNode?	—	Focus node used by the rendered log region.
autofocus:	bool	false	Whether the rendered log region should request focus when mounted.
semanticLabel:	String	'Terminal output'	Semantic label (the accessibility name; not rendered) for the output region.
showPrefix:	bool	true	Whether each row starts with an [INFO stdout] or [ERROR stderr] prefix.
maxLineLength:	int?	1000	Cuts each output line to this many characters, with no ellipsis, on screen and when copied; null never cuts. The prefix doesn’t count.
filter:	LogRegionFilterDescriptor?	—	Optional filter applied to captured output rows.
copySelection:	bool	true	Whether Ctrl+C (and the semantic copy action) copies the output line under the cursor.
copyOptions:	LogRegionCopyOptions	const LogRegionCopyOptions()	Clipboard/export options for copied output.
onCopy:	void Function(LogRegionCopyResult result)?	—	Called after a copy attempt completes.

Source

TerminalOutputRegion is defined in packages/fleury/lib/src/catalog/terminal_output_region.dart.

Category: Agent surfaces · All widgets

Live demo

terminaloutputregion_example.dart

Restart Run Expand

Example · editable Revert Format

class _TerminalOutputExampleState extends State<_TerminalOutputExample>
    with SingleTickerProviderStateMixin {
  static const _session = <(LogSource, String)>[
    (LogSource.stdout, r'$ dart compile exe bin/server.dart'),
    (LogSource.stdout, 'Generated: bin/server.exe'),
    (LogSource.stdout, r'$ dart test'),
    (LogSource.stdout, '00:01 +12: All tests passed!'),
    (LogSource.stdout, r'$ dart analyze'),
    (
      LogSource.stderr,
      "warning - lib/cache.dart:14:7 - Unused import: 'dart:io'.",
    ),
    (LogSource.stdout, '1 issue found.'),
  ];

  final LogBuffer _buffer = LogBuffer(capacity: 200);
  int _next = 0;
  Ticker? _ticker;
  Duration _last = Duration.zero;

  @override
  void initState() {
    super.initState();
    for (var i = 0; i < 3; i++) {
      _append();
    }
  }

  @override
  void didChangeDependencies() {
    super.didChangeDependencies();
    // Frames only tick inside a running app.
    if (_ticker == null && TuiBinding.maybeOf(context) != null) {
      _ticker = createTicker(_onTick)..start();
    }
  }

  void _onTick(Duration elapsed) {
    if (elapsed - _last < const Duration(milliseconds: 700)) return;
    _last = elapsed;
    _append();
  }

  // The region listens to the buffer, so appending needs no setState.
  void _append() {
    final (source, text) = _session[_next++ % _session.length];
    _buffer.add(LogLine(text, source));
  }

  @override
  void dispose() {
    _ticker?.dispose();
    super.dispose();
    _buffer.dispose();
  }

  @override
  Widget build(BuildContext context) =>
      TerminalOutputRegion(buffer: _buffer, autofocus: true);
}

Live preview

Live · interactive

click & type to interact ⓘ how this demo runs ⛶ Expand