Skip to content

Tasklist support for markdown widget (disabled checkboxes) #3022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Tasklist support for markdown widget (disabled checkboxes) #3022

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61df8bb
feat: add support for *non-interactive* checkmarks in `markdown`
pml68 Jul 24, 2025
c9602b0
fix: Rust 1.88 lints
pml68 Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 79 additions & 18 deletions widget/src/markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ use crate::core::theme;
use crate::core::{
self, Color, Element, Length, Padding, Pixels, Theme, color,
};
use crate::{column, container, rich_text, row, rule, scrollable, span, text};
use crate::{
checkbox, column, container, rich_text, row, rule, scrollable, span, text,
};

use std::borrow::BorrowMut;
use std::cell::{Cell, RefCell};
Expand Down Expand Up @@ -204,7 +206,7 @@ pub enum Item {
/// The first number of the list, if it is ordered.
start: Option<u64>,
/// The items of the list.
items: Vec<Vec<Item>>,
items: Vec<ListItem>,
},
/// An image.
Image {
Expand Down Expand Up @@ -346,6 +348,19 @@ impl Span {
}
}

/// The item of a list.
#[derive(Debug, Clone)]
pub struct ListItem {
checked: Option<bool>,
items: Vec<Item>,
}

impl ListItem {
fn push(&mut self, item: Item) {
self.items.push(item);
}
}

/// Parse the given Markdown content.
///
/// # Example
Expand Down Expand Up @@ -499,7 +514,7 @@ fn parse_with<'a>(

struct List {
start: Option<u64>,
items: Vec<Vec<Item>>,
items: Vec<ListItem>,
}

let broken_links = Rc::new(RefCell::new(HashSet::new()));
Expand All @@ -525,7 +540,8 @@ fn parse_with<'a>(
pulldown_cmark::Options::ENABLE_YAML_STYLE_METADATA_BLOCKS
| pulldown_cmark::Options::ENABLE_PLUSES_DELIMITED_METADATA_BLOCKS
| pulldown_cmark::Options::ENABLE_TABLES
| pulldown_cmark::Options::ENABLE_STRIKETHROUGH,
| pulldown_cmark::Options::ENABLE_STRIKETHROUGH
| pulldown_cmark::Options::ENABLE_TASKLISTS,
{
let references = state.borrow().references.clone();
let broken_links = broken_links.clone();
Expand Down Expand Up @@ -644,7 +660,10 @@ fn parse_with<'a>(
}
pulldown_cmark::Tag::Item => {
if let Some(Scope::List(list)) = stack.last_mut() {
list.items.push(Vec::new());
list.items.push(ListItem {
checked: None,
items: Vec::new(),
});
}

None
Expand Down Expand Up @@ -977,6 +996,15 @@ fn parse_with<'a>(
pulldown_cmark::Event::Rule => {
produce(state.borrow_mut(), &mut stack, Item::Rule, source)
}
pulldown_cmark::Event::TaskListMarker(checked) => {
if let Some(Scope::List(list)) = stack.last_mut()
&& let Some(item) = list.items.last_mut()
{
item.checked = Some(checked);
}

None
}
_ => None,
})
}
Expand Down Expand Up @@ -1278,18 +1306,32 @@ where
pub fn unordered_list<'a, Message, Theme, Renderer>(
viewer: &impl Viewer<'a, Message, Theme, Renderer>,
settings: Settings,
items: &'a [Vec<Item>],
items: &'a [ListItem],
) -> Element<'a, Message, Theme, Renderer>
where
Message: 'a,
Theme: Catalog + 'a,
Renderer: core::text::Renderer<Font = Font> + 'a,
{
column(items.iter().map(|items| {
column(items.iter().map(|list_item| {
row![
text("•").size(settings.text_size),
list_item
.checked
.map(|is_checked| {
Element::from(
checkbox("", is_checked)
.spacing(0)
.text_size(settings.text_size),
)
})
.unwrap_or(Element::from(
text("•")
.width(settings.text_size)
.center()
.size(settings.text_size)
)),
view_with(
items,
&list_item.items,
Settings {
spacing: settings.spacing * 0.6,
..settings
Expand All @@ -1311,7 +1353,7 @@ pub fn ordered_list<'a, Message, Theme, Renderer>(
viewer: &impl Viewer<'a, Message, Theme, Renderer>,
settings: Settings,
start: u64,
items: &'a [Vec<Item>],
items: &'a [ListItem],
) -> Element<'a, Message, Theme, Renderer>
where
Message: 'a,
Expand All @@ -1320,14 +1362,32 @@ where
{
let digits = ((start + items.len() as u64).max(1) as f32).log10().ceil();

column(items.iter().enumerate().map(|(i, items)| {
column(items.iter().enumerate().map(|(i, list_item)| {
row![
text!("{}.", i as u64 + start)
.size(settings.text_size)
.align_x(alignment::Horizontal::Right)
.width(settings.text_size * ((digits / 2.0).ceil() + 1.0)),
list_item
.checked
.map(|is_checked| {
Element::from(
container(
checkbox("", is_checked)
.spacing(0)
.text_size(settings.text_size),
)
.align_right(
settings.text_size * ((digits / 2.0).ceil() + 1.0),
),
)
})
.unwrap_or(Element::from(
text!("{}.", i as u64 + start)
.size(settings.text_size)
.align_x(alignment::Horizontal::Right)
.width(
settings.text_size * ((digits / 2.0).ceil() + 1.0)
),
)),
view_with(
items,
&list_item.items,
Settings {
spacing: settings.spacing * 0.6,
..settings
Expand Down Expand Up @@ -1566,7 +1626,7 @@ where
fn unordered_list(
&self,
settings: Settings,
items: &'a [Vec<Item>],
items: &'a [ListItem],
) -> Element<'a, Message, Theme, Renderer> {
unordered_list(self, settings, items)
}
Expand All @@ -1578,7 +1638,7 @@ where
&self,
settings: Settings,
start: u64,
items: &'a [Vec<Item>],
items: &'a [ListItem],
) -> Element<'a, Message, Theme, Renderer> {
ordered_list(self, settings, start, items)
}
Expand Down Expand Up @@ -1636,6 +1696,7 @@ pub trait Catalog:
+ scrollable::Catalog
+ text::Catalog
+ crate::rule::Catalog
+ checkbox::Catalog
+ crate::table::Catalog
{
/// The styling class of a Markdown code block.
Expand Down
Loading