Module Bonsai_tui_ncdu.Make

Parameters

module Key : Key
module Size : Size

Signature

module Tree_node : sig ... end
val component : app_title:string -> tree_name:string -> dimensions:Bonsai_term.Dimensions.t Bonsai_term.Bonsai.t -> ?separator:string -> total_size:Size.t -> nodes:Tree_node.t Key.Map.t -> Bonsai_term.Bonsai.graph @ local -> view: Bonsai_term.View.t Bonsai_term.Bonsai.t * handler: (Bonsai_term.Event.t -> unit Bonsai_term.Effect.t) Bonsai_term.Bonsai.t

component will produce a component you can use to visualize an interactive weighted tree.

app_title is the title that is shown in the top bar. (e.g. the name of your app/tool).

tree_name is the name that is shown in the bottom bar. (e.g. if your app tool runs on a specific file the name of the file).

dimensions is the amount of terminal dimensions that the component will use.

separator ( defaults to " -> " ). There is a bottom bar with the "current path in the tree". (e.g. "a -> b -> c -> d"), if you pass "/", then the path will get rendered as "a/b/c/d".

total_size is the weight of the "entire tree" shown in the bottom bar.

nodes represents the data in your tree.