package miaou-core

  1. Overview
  2. Docs
Miaou core/widgets (no drivers, no SDL)

Install 

dune-project
 Dependency

github.com Edit opam file Versions (1)

Authors

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Maintainers

  1. N
    Nomadic Labs <contact@nomadic-labs.com>

Sources

v0.5.2.tar.gz
md5=60a3b9f181f24572a06a9492532bfdda
sha512=fcc35a275066be2900e6201782faf47503076fa4640f08cf78067835a6f447b74613009e55b2ac799adb7ca46f1bffa261fc5971753f2cc3c6bef327511c7ef6

doc/miaou-core.core/Miaou_core/Prompt/index.html

Module Miaou_core.PromptSource

Reusable prompt helpers built on top of Modal_manager.

These helpers wrap the boilerplate of building a small modal page and pushing it onto the modal stack. They mirror the patterns seen in the existing example modal modules (textbox_modal, select_modal, password_textbox_modal) so app code can ask for a yes/no answer, a free-form text value, or a list selection in one call.

All three helpers are non-blocking: they push a modal and return immediately. The result is delivered asynchronously through on_result when the user commits or cancels.

Typical usage:

  Prompt.confirm
    ~title:"Delete file?"
    ~message:"This cannot be undone."
    ~on_result:(fun answered_yes ->
      if answered_yes then delete_file () else ())
    ()
Sourceval confirm : title:string -> message:string -> on_result:(bool -> unit) -> unit -> unit

Ask a yes / no question.

Pushes a centred modal with message as the body. The modal commits on Enter (calling on_result true) and cancels on Esc (calling on_result false).

  • parameter title

    Title shown at the top of the modal.

  • parameter message

    Message body shown to the user.

  • parameter on_result

    Callback invoked exactly once with the user's answer.

Sourceval input : ?placeholder:string -> ?initial:string -> title:string -> on_result:(string option -> unit) -> unit -> unit

Ask the user to type a free-form string.

Pushes a centred modal containing a single-line textbox. On commit (Enter) the callback receives Some text; on cancel (Esc) the callback receives None.

  • parameter placeholder

    Optional placeholder shown when the textbox is empty.

  • parameter initial

    Initial textbox content (default: empty).

  • parameter title

    Title shown at the top of the modal.

  • parameter on_result

    Callback invoked exactly once.

Sourceval select : title:string -> items:'a list -> to_string:('a -> string) -> on_result:('a option -> unit) -> unit -> unit

Ask the user to pick one item from a list.

Pushes a centred modal containing a Miaou_widgets_input.Select_widget populated from items. On commit (Enter) the callback receives Some item; on cancel (Esc) the callback receives None.

  • parameter title

    Title shown at the top of the modal.

  • parameter items

    List of items to choose from. May be empty (the user can only cancel in that case).

  • parameter to_string

    Function used to render each item as a row.

  • parameter on_result

    Callback invoked exactly once.

Pure helpers (testable without a TUI runtime)

These helpers implement the small bits of result-mapping logic used internally. They are exposed so unit tests can verify the behaviour without spinning up a modal stack.

Sourceval confirm_outcome : [ `Commit | `Cancel ] -> bool

confirm_outcome `Commit is true and confirm_outcome `Cancel is false.

Sourceval input_result : [ `Commit | `Cancel ] -> text:string -> string option

Pure result mapping for input.

input_result outcome ~text:

  • `Commit yields Some text.
  • `Cancel yields None.
Sourceval select_result : [ `Commit | `Cancel ] -> selected:'a option -> 'a option

Pure result mapping for select.

select_result outcome ~selected:

  • `Commit yields selected (which is Some _ when a row was selected, None when the list was empty).
  • `Cancel yields None regardless.