Returns a specification to start this module under a supervisor.

See Supervisor.

@spec disable_mouse_tracking() :: :ok

Disables mouse tracking.

@spec disable_raw_mode() :: :ok | {:error, term()}

Disables raw mode and restores original terminal settings.

Returns :ok on success or {:error, reason} on failure.

@spec enable_mouse_tracking(:click | :drag | :all) :: :ok

Enables mouse tracking with the specified mode.

Modes

• :click - Report button press and release only
• :drag - Also report mouse motion while button is pressed
• :all - Report all mouse motion (generates many events)

Also enables SGR extended mode for accurate coordinates.

@spec enable_raw_mode() :: {:ok, TermUI.Terminal.State.t()} | {:error, term()}

Enables raw mode on the terminal.

Calls OTP 28's shell.start_interactive({:noshell, :raw}) and configures the terminal for TUI operation.

Returns {:ok, state} on success or {:error, reason} on failure.

@spec enter_alternate_screen() :: :ok | {:error, term()}

Enters the alternate screen buffer.

The alternate screen preserves the user's shell history while the TUI runs.

@spec get_state() :: TermUI.Terminal.State.t()

Gets the current terminal state.

@spec get_terminal_size() :: {:ok, {pos_integer(), pos_integer()}} | {:error, term()}

Gets the current terminal size.

Returns {:ok, {rows, cols}} or {:error, reason}.

@spec hide_cursor() :: :ok

Hides the cursor.

@spec leave_alternate_screen() :: :ok | {:error, term()}

Leaves the alternate screen buffer and restores the original screen.

@spec raw_mode?() :: boolean()

Checks if the terminal is currently in raw mode.

@spec register_resize_callback(pid()) :: :ok

Registers a process to receive terminal resize notifications.

The registered process will receive {:terminal_resize, {rows, cols}} messages.

@spec restore() :: :ok | {:error, term()}

Performs complete terminal restoration.

This restores all terminal modifications in the correct sequence:

1. Show cursor
2. Leave alternate screen
3. Disable raw mode
4. Restore original settings

@spec show_cursor() :: :ok

Shows the cursor.

@spec start_link(keyword()) :: GenServer.on_start()

Starts the Terminal GenServer.

@spec unregister_resize_callback(pid()) :: :ok

Unregisters a process from resize notifications.