uji.ui

uji.ui.open_win(opts)

Opens a window and returns its id. The default config opens three.

uji.ui.open_win({ view = "messages", split = "top", size = "fill", wrap = true })
uji.ui.open_win({ view = "input", split = "bottom", size = "auto", border = "horizontal" })
uji.ui.open_win({ view = "modal", split = "bottom", size = "auto" })

Raises an error for an unknown view, split, border or size.

uji.ui.set_lines(id, lines)

Replaces a window’s content. Each line is a list of spans. A span is a string, or a table with text and any of color, bg, bold, italic and underline. A line may also be a single span.

local panel = uji.ui.open_win({ split = "bottom", size = 2 })
uji.ui.set_lines(panel, {
  { { text = "build", bold = true }, " passing" },
  { text = "3 files changed", color = "gray" },
})

uji.ui.clear(id)

Empties a window.

local panel = uji.ui.open_win({ split = "bottom", size = 1 })
uji.ui.clear(panel)

uji.ui.set_size(id, size)

Changes a window’s size to rows or columns, "fill" or "auto".

local panel = uji.ui.open_win({ split = "bottom", size = 0 })
uji.ui.set_size(panel, 3)

uji.ui.set_title(id, title)

Sets the title in a window’s border, or removes it when title is nil.

local panel = uji.ui.open_win({ split = "right", size = 30, border = "plain" })
uji.ui.set_title(panel, "todo")

uji.ui.close_win(id)

Closes a window and returns true if it was open.

local panel = uji.ui.open_win({ split = "bottom", size = 1 })
uji.ui.close_win(panel)

uji.ui.select(opts, on_done)

Shows a list to choose from. opts.title is the title and opts.items is a list of strings. on_done receives the chosen item, or nil if you cancel. Without on_done, the call waits and returns the chosen item.

uji.ui.select({ title = "Branch", items = { "main", "dev" } }, function(choice)
  if choice then
    uji.notify("picked " .. choice)
  end
end)

uji.ui.pick(opts, on_done)

Shows a fuzzy finder with a preview pane. on_done receives the chosen item, or nil if you cancel. Without on_done, the call waits and returns the chosen item.

uji.ui.pick({
  title = "Search",
  on_query = function(query, show)
    local hits = {}
    uji.job.start({
      cmd = { "rg", "--line-number", "--no-heading", query },
      on_stdout = function(line)
        hits[#hits + 1] = line
      end,
      on_exit = function()
        show(hits)
      end,
    })
  end,
}, function(choice)
  if choice then
    uji.notify(choice)
  end
end)

uji.ui.prompt(opts, on_done)

Asks for a line of text. opts.title is the question, opts.value fills the line, and opts.hidden = true masks the input. on_done receives the text, or nil if you cancel. Without on_done, the call waits and returns the text.

uji.ui.prompt({ title = "Commit message" }, function(message)
  if message and message ~= "" then
    uji.session.submit("Commit the staged changes with the message: " .. message)
  end
end)

uji.ui.exec(cmd)

Hides uji, runs a program in the terminal, and comes back when it exits. cmd is a string, run through sh -c, or a list of the program and its arguments.

uji.ui.exec("git log --oneline | less")

uji.ui.configure(opts)

Sets colours and screen behaviour. Each call changes only the keys it names. Raises an error for an unknown key or an invalid colour.

uji.ui.configure({
  theme = { accent = "#c65036", user_bg = "#2b2b2b" },
  input = { cursor_blink = false },
  waiting = { loader = { frames = { "-", "\\", "|", "/" }, interval = 0.1 } },
  confirm = { title = "Run this?", yes = "Run", no = "Skip" },
})

Colours

A colour is #rrggbb or one of black, red, green, yellow, blue, magenta, cyan, white, gray, dark_gray, light_red, light_green, light_yellow, light_blue, light_magenta and light_cyan. grey and dark_grey also work.