Page:
Checkbox
Pages
Actions
Attachment
Audio recorder
Autocmds
Bookmarks
Breaking Changes
Cache
Checkbox
Commands
Completion
Daily Notes
Editing this wiki
Extensions
File
Folding
Footer
Frontmatter
Home
Images
Integrations
Keymaps
LSP Progress
LSP
Link
Navigation
Note
Open
Recipes
Resolvers
Scripting
Search
Startup Guide
Statusline
Sync
Tag
Template
Unique Note
Workspace
No results
5
Checkbox
github-actions edited this page 2026-04-05 17:44:33 +00:00
Table of contents
Create new
By default, Obsidian toggle_checkbox and smart_action works like default <C-l> keybind in obsidian app, it will add a checkbox on normal paragraphs. This behavior can be changed by setting checkbox.create_new to false.
Checkbox to list item
You can also include an empty string in checkbox.order (e.g. { " ", "x", "" }) to rotate a checkbox back into a plain list item (e.g. - [x] foo -> - foo).
Options
---@class obsidian.config.CheckboxOpts
---
---@field enabled? boolean
---
---Order of checkbox state chars, e.g. { " ", "x" }
---@field order? string[]
---
---Whether to create new checkbox on paragraphs
---@field create_new? boolean
checkbox = {
enabled = true,
create_new = true,
order = { " ", "~", "!", ">", "x" },
}
🌟 obsidian.nvim
Topics
- Actions
- Autocmds
- Commands
- Folding
- Extensions
- Images
- Integrations
- Keymaps
- Navigation
- Scripting
- Startup-Guide
- Recipes
- LSP
- LSP-Progress