aboutsummaryrefslogtreecommitdiffstats
path: root/src/configuration.rs
diff options
context:
space:
mode:
authorLibravatar cel 🌸 <cel@blos.sm>2023-08-15 15:59:52 +0100
committerLibravatar cel 🌸 <cel@blos.sm>2023-08-15 15:59:52 +0100
commit94fca8874c720ebdd5d18494094cf3048d575394 (patch)
tree7bce6dd06290aab97aa52dfb1e6b95becf8d7642 /src/configuration.rs
parent56cd834cf88a58d3429b4b75489f161d57b28eaa (diff)
downloadmarkdown-rs-94fca8874c720ebdd5d18494094cf3048d575394.tar.gz
markdown-rs-94fca8874c720ebdd5d18494094cf3048d575394.tar.bz2
markdown-rs-94fca8874c720ebdd5d18494094cf3048d575394.zip
Add ability to enable or disable html checkbox checkability
Diffstat (limited to '')
-rw-r--r--src/configuration.rs32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/configuration.rs b/src/configuration.rs
index fe5698b..e995c09 100644
--- a/src/configuration.rs
+++ b/src/configuration.rs
@@ -831,6 +831,38 @@ pub struct CompileOptions {
/// ```
pub gfm_footnote_clobber_prefix: Option<String>,
+ /// Whether or not GFM task list html `<input>` items are enabled.
+ ///
+ /// This determines whether or not the user of the browser is able
+ /// to click and toggle generated checkbox items. The default is false.
+ ///
+ /// ## Examples
+ ///
+ /// ```
+ /// use markdown::{to_html_with_options, CompileOptions, Options, ParseOptions};
+ /// # fn main() -> Result<(), String> {
+ ///
+ /// // With `gfm_task_list_item_checkable`, generated `<input type="checkbox" />`
+ /// // tags do not contain the attribute `disabled=""` and are thus toggleable by
+ /// // browser users.
+ /// assert_eq!(
+ /// to_html_with_options(
+ /// "* [x] y.",
+ /// &Options {
+ /// parse: ParseOptions::gfm(),
+ /// compile: CompileOptions {
+ /// gfm_task_list_item_checkable: true,
+ /// ..CompileOptions::gfm()
+ /// }
+ /// }
+ /// )?,
+ /// "<ul>\n<li><input type=\"checkbox\" checked=\"\" /> y.</li>\n</ul>"
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub gfm_task_list_item_checkable: bool,
+
/// Whether to support the GFM tagfilter.
///
/// This option does nothing if `allow_dangerous_html` is not turned on.