feat: implement alternate component

Author: LeadcodeDev

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.7.0
+
+- Implement `alternative screen` component
+- Add `Table` component in public export
+
 ## 1.6.0
 
 - Add `Table` component

README.md

@@ -178,3 +178,26 @@ Future<void> main() async {
   );
 }
 ```
+
+### Alternative screen component
+A simple example of using Commander to create an alternative screen component :
+
+- ✅ Set title
+- ✅ Clear screen on start
+- ✅ Restore screen on stop
+
+```dart
+Future<void> main() async {
+  final screen = AlternateScreen(title: 'Hello World !');
+  screen.start();
+
+  print('Hello World !');
+
+  await wait();
+  screen.stop();
+}
+
+
+Future<void> wait() =>
+    Future.delayed(Duration(seconds: Random().nextInt(3) + 1));
+```

example/alternate_screen.dart

@@ -0,0 +1,16 @@
+import 'dart:math';
+
+import 'package:commander_ui/src/components/alternate_screen.dart';
+
+Future<void> main() async {
+  final screen = AlternateScreen(title: 'Hello World !');
+  screen.start();
+
+  print('Hello World !');
+
+  await wait();
+  screen.stop();
+}
+
+Future<void> wait() =>
+    Future.delayed(Duration(seconds: Random().nextInt(3) + 1));

lib/commander_ui.dart

@@ -10,6 +10,8 @@ export '../src/components/checkbox.dart';
 export '../src/components/delayed.dart';
 export '../src/components/progress.dart';
 export '../src/components/switch.dart';
+export '../src/components/table.dart';
+export '../src/components/alternate_screen.dart';
 
 export '../src/key_down_event_listener.dart';
 export '../src/result.dart';

lib/src/components/alternate_screen.dart

@@ -0,0 +1,27 @@
+import 'dart:io';
+
+import 'package:commander_ui/src/commons/cli.dart';
+import 'package:commander_ui/src/component.dart';
+import 'package:mansion/mansion.dart' as mansion;
+
+class AlternateScreen with Tools implements Component<void> {
+  String? title;
+
+  AlternateScreen({this.title});
+
+  void setTitle(String title) {
+    this.title = title;
+    stdout.writeAnsi(mansion.SetTitle(title));
+  }
+
+  void start() {
+    stdout.writeAnsi(mansion.AlternateScreen.enter);
+    if (title case String title) {
+      stdout.writeAnsi(mansion.SetTitle(title));
+    }
+  }
+
+  void stop() {
+    stdout.writeAnsi(mansion.AlternateScreen.leave);
+  }
+}

pubspec.yaml

@@ -1,6 +1,6 @@
 name: commander_ui
 description: Commander is a Dart library for creating user interfaces within the terminal.
-version: 1.6.0
+version: 1.7.0
 repository: https://github.com/LeadcodeDev/commander
 
 topics: