Skip to content

Todo Items

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

Todo Items

Module for implementing todo lists.

Overview

Some available keybinds - todo.task_done - todo.task_undone - todo.task_pending - todo.task_on_hold - todo.task_cancelled - todo.task_recurring - todo.task_important - todo.task_cycle

Usage

How to Apply

  • This module is already present in the core.defaults metamodule. You can load the module with:
    ["core.defaults"] = {},
    In your Neorg setup.
  • To manually load the module, place this code in your Neorg setup:
    ["core.norg.qol.todo_items"] = {
       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.norg.qol.todo_items to your liking.

Configuration

order : The order of cycling between todo items

Default Value:

Developer Usage

Public API

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

  • update_parent
  • get_todo_item_type
  • make_all
  • get_list_item_from_cursor

Examples

None Provided

Extra Info

Version

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

Imports

This module does not import any other files.

Requires

Required by

This module isn't required by any other module.