Skip to content
github-actions[bot] edited this page Jun 25, 2022 · 317 revisions

GTD UI module

Nicely displays GTD related information.

Overview

This module is like a sub-module for core.gtd.base, exposing public functions to display nicely aggregated stuff like tasks and projects.

Usage

How to Apply

  • To manually load the module, place this code in your Neorg setup:
    ["core.gtd.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.gtd.ui to your liking.

Configuration

This module exposes no customization options.

Developer Usage

Public API

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

  • display_unclarified
  • display_messages
  • display_someday
  • show_capture_popup
  • display_weekly_summary
  • display_today_tasks
  • edit_task_at_cursor
  • percent_string
  • show_views_popup
  • display_waiting_for
  • display_projects
  • edit_task
  • get_data_for_views
  • get_callback
  • percent
  • display_contexts

Examples

None Provided

Extra Info

Version

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

Imports

Requires

  • core.ui - A set of public functions to help developers create and manage UI (selection popups, prompts...) in their modules.
  • core.keybinds - Module for managing keybindings with Neorg mode support.
  • core.norg.dirman - This module is be responsible for managing directories full of .norg files.
  • core.gtd.queries - Gets tasks, projects and useful information for the GTD system.
  • core.gtd.helpers - Nice helpers for GTD modules.
  • core.integrations.treesitter - A module designed to integrate TreeSitter into Neorg.
  • core.mode - Modes are a way of isolating different parts of Neorg based on the current mode.
  • core.queries.native - TS wrapper in order to fetch nodes using a custom table.
  • core.autocommands - Handles the creation and management of Neovim's autocommands.

Required by

  • core.gtd.base - Manages your tasks with Neorg using the Getting Things Done methodology.