Skip to content

Core UI

github-actions[bot] edited this page Jun 25, 2022 · 224 revisions

Module for managing and displaying UIs to the user.

A set of public functions to help developers create and manage UI (selection popups, prompts...) in their modules.

Overview

Usage

How to Apply

  • To manually load the module, place this code in your Neorg setup:
    ["core.ui"] = {
       config = { -- Note that this table is optional and doesn't need to be provided
           -- Configuration here
       }
    }
    Consult the configuration section to see how you can configure core.ui to your liking.

Configuration

This module exposes no customization options.

Developer Usage

Public API

This segment will detail all of the functions core.ui exposes. All of these functions reside in the public table.

  • apply_custom_options
  • create_norg_buffer
  • delete_window
  • apply_buffer_options
  • create_vsplit
  • create_split
  • begin_selection
  • create_display
  • get_window_size
  • create_prompt
  • invoke_key_in_selection

Examples

Create a selection popup

-- Creates the buffer

title

return self:text(text, "TSTitle")

Extra Info

Version

This module supports at least version 0.0.11. The current Neorg version is 0.0.11.

Imports

Requires

This module does not require any other modules to operate.

Required by