package box

All checked builds pass
  1. Overview
  2. Docs
Render boxes in the terminal

Install

dune-project
 Dependency

Authors

Maintainers

Sources

1.2.0.tar.gz
md5=cbf16dadfbcf990070366e255e4708a7
sha512=44d791a884f1712c43aab312a0b2edf390bea473347d373c5c54c2c9110bc846aecf3e3b5d914b5967d4860f1a96456eafca55ea570092764937c9bf05d8ddd3

Description

Render boxes in the terminal, can configure the padding, margin and the border of the box.

Added to opam-repository:

README

ocaml-box

    ╭─────────────────────────────────────────────────╮
    │                                                 │
    │   Render those kinds of boxes in the terminal   │
    │                                                 │
    ╰─────────────────────────────────────────────────╯

Render boxes in the terminal with OCaml or Reason. Port of sindresorhus/boxen.

Features

  • Available on all major platform (Windows, Linux and Windows)
  • Render boxes with margin, padding and different borders
  • Alignment
  • Floating
  • No dependencies

Missing Features

  • ascii support
  • Border Color (and dimming)

Install with opam

opam pin https://github.com/davesnx/ocaml-box # Since isn't available on opam, you can install it pinning

Install with esy

esy add @opam/box
# Since isn't available yet you can install it from the repo `esy add https://github.com/davesnx/ocaml-box or adding a resolution commit`

Documentation

Documentation

Contributing

Take a look at our Contributing Guide.

Status

Actions Status

Dependencies (3)

  1. reason build
  2. dune >= "2.7"
  3. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. odoc with-doc

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building box with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
1.2.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure