Skip to content

Checkboxes

Shawon edited this page Oct 3, 2024 · 7 revisions

Checkboxes

Checkboxes

checkboxes = {
    enable = true,

    checked = {
        --- Text to show
        ---@type string
        text = "",

        --- Highlight group for "text"
        ---@type string?
        hl = "MarkviewCheckboxChecked",

        --- Highlight group to add to the body
        --- of the list item.
        ---@type string?
        scope_hl = nil
    },

    unchecked = {
        text = "", hl = "MarkviewCheckboxUnchecked",
        scope_hl = nil
    },

    --- Custom checkboxes configuration
    custom = {
        {
            --- Text inside []
            ---@type string
            match_string = "-",

            ---@type string
            text = "",

            ---@type string?
            hl = "MarkviewCheckboxPending",

            ---@type string?
            scope_hl = nil
        }
    }
}
Clone this wiki locally