Liking cljdoc? Tell your friends :D

me.pmatiello.tui.core

Functions for terminal user interfaces.

Functions for terminal user interfaces.
raw docstring

printclj

(print & page)

Prints a page to stdout.

Arguments:

  • page [me.pmatiello.tui.internal.specs/page, variadic]

Examples:

  • (print "plain text")
  • (print "plain" "text")
  • (print {:style [:bold :fg-blue] :body "!styled!"} "text")
Prints a page to stdout.

Arguments:
- page [me.pmatiello.tui.internal.specs/page, variadic]

Examples:
- (print "plain text")
- (print "plain" "text")
- (print {:style [:bold :fg-blue] :body "!styled!"} "text")
sourceraw docstring

printlnclj

(println & page)

Prints a page to stdout. Add a new line at the end.

Arguments:

  • page [me.pmatiello.tui.internal.specs/page, variadic]

Examples:

  • (println "plain text")
  • (println "plain" "text")
  • (println {:style [:bold :fg-blue] :body "!styled!"} "text")
Prints a page to stdout. Add a new line at the end.

Arguments:
- page [me.pmatiello.tui.internal.specs/page, variadic]

Examples:
- (println "plain text")
- (println "plain" "text")
- (println {:style [:bold :fg-blue] :body "!styled!"} "text")
sourceraw docstring

read-lineclj

(read-line)

Reads a single line from in.

Reads a single line from *in*.
sourceraw docstring

read-linesclj

(read-lines)

Reads lines from in until EOF.

Reads lines from *in* until EOF.
sourceraw docstring

renderclj

(render page)
(render page {:keys [separator]})

Renders a page (as a string).

Arguments:

  • page [me.pmatiello.tui.internal.specs/page]
  • opts [:me.pmatiello.tui.internal.specs/render-opts, optional]

Examples:

  • (render ["plain text"])
  • (render ["plain", " ", "text"])
  • (render [{:style [:bold :fg-blue] :body "!styled!"} "text"])
  • (render ["plain", "text"] {:separator " "})
  • (render ["plain", "text"] {:separator {:style [:bold] :body "-"}})
Renders a page (as a string).

Arguments:
- page [me.pmatiello.tui.internal.specs/page]
- opts [:me.pmatiello.tui.internal.specs/render-opts, optional]

Examples:
- (render ["plain text"])
- (render ["plain", " ", "text"])
- (render [{:style [:bold :fg-blue] :body "!styled!"} "text"])
- (render ["plain", "text"] {:separator " "})
- (render ["plain", "text"] {:separator {:style [:bold] :body "-"}})
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close