Liking cljdoc? Tell your friends :D

charm.render.core

Terminal renderer using JLine's Display for efficient diffing.

Provides a high-level rendering API that efficiently updates the terminal by only redrawing changed content.

Terminal renderer using JLine's Display for efficient diffing.

Provides a high-level rendering API that efficiently updates
the terminal by only redrawing changed content.
raw docstring

clear-screen!clj

(clear-screen! renderer)

Clear the screen.

Clear the screen.
sourceraw docstring

copy-to-clipboard!clj

(copy-to-clipboard! renderer text)

Copy text to system clipboard (if terminal supports OSC 52).

Copy text to system clipboard (if terminal supports OSC 52).
sourceraw docstring

create-rendererclj

(create-renderer terminal
                 &
                 {:keys [fps alt-screen hide-cursor]
                  :or {fps 60 alt-screen false hide-cursor true}})

Create a renderer for a terminal.

Options: :fps - Target frames per second (default: 60) :alt-screen - Use alternate screen buffer (default: false) :hide-cursor - Hide cursor during rendering (default: true)

Create a renderer for a terminal.

Options:
  :fps         - Target frames per second (default: 60)
  :alt-screen  - Use alternate screen buffer (default: false)
  :hide-cursor - Hide cursor during rendering (default: true)
sourceraw docstring

disable-bracketed-paste!clj

(disable-bracketed-paste! renderer)

Disable bracketed paste mode.

Disable bracketed paste mode.
sourceraw docstring

disable-focus-reporting!clj

(disable-focus-reporting! renderer)

Disable focus reporting.

Disable focus reporting.
sourceraw docstring

disable-mouse!clj

(disable-mouse! renderer)

Disable mouse tracking.

Disable mouse tracking.
sourceraw docstring

enable-bracketed-paste!clj

(enable-bracketed-paste! renderer)

Enable bracketed paste mode.

Enable bracketed paste mode.
sourceraw docstring

enable-focus-reporting!clj

(enable-focus-reporting! renderer)

Enable focus in/out reporting.

Enable focus in/out reporting.
sourceraw docstring

enable-mouse!clj

(enable-mouse! renderer mode)

Enable mouse tracking.

Mode can be: :normal - Button events only :cell - Button and movement while pressed :all - All mouse events including motion

Enable mouse tracking.

Mode can be:
  :normal     - Button events only
  :cell       - Button and movement while pressed
  :all        - All mouse events including motion
sourceraw docstring

enter-alt-screen!clj

(enter-alt-screen! renderer)

Enter the alternate screen buffer.

Enter the alternate screen buffer.
sourceraw docstring

exit-alt-screen!clj

(exit-alt-screen! renderer)

Exit the alternate screen buffer.

Exit the alternate screen buffer.
sourceraw docstring

get-sizeclj

(get-size renderer)

Get the current terminal size [width height].

Get the current terminal size [width height].
sourceraw docstring

hide-cursor!clj

(hide-cursor! renderer)

Hide the terminal cursor.

Hide the terminal cursor.
sourceraw docstring

move-cursor!clj

(move-cursor! renderer col row)

Move cursor to position (0-indexed).

Move cursor to position (0-indexed).
sourceraw docstring

render!clj

(render! renderer content)

Render content to the terminal using JLine's Display for efficient diffing.

Content can be a string (multi-line) which will be split and rendered line by line.

Render content to the terminal using JLine's Display for efficient diffing.

Content can be a string (multi-line) which will be split
and rendered line by line.
sourceraw docstring

repaint!clj

(repaint! renderer)

Force a full repaint on next render.

Force a full repaint on next render.
sourceraw docstring

set-window-title!clj

(set-window-title! renderer title)

Set the terminal window title.

Set the terminal window title.
sourceraw docstring

show-cursor!clj

(show-cursor! renderer)

Show the terminal cursor.

Show the terminal cursor.
sourceraw docstring

start!clj

(start! renderer)

Start the renderer.

Start the renderer.
sourceraw docstring

stop!clj

(stop! renderer)

Stop the renderer and restore terminal state.

Stop the renderer and restore terminal state.
sourceraw docstring

update-size!clj

(update-size! renderer width height)

Update the renderer's size (call on window resize).

Update the renderer's size (call on window resize).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close