Skip to content

[Docs] Fix documentation of onclick to make it clear 1) the data is not HTML escaped 2) there is also a href option alternative #117

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
mousetail wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Docs] Fix documentation of onclick to make it clear 1) the data is not HTML escaped 2) there is also a href option alternative #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions docs/src/components/toast.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,9 @@ toc:
<dt><code>label</code> <span class="badge-secondary">Optional</span></dt>
<dd>The label of the cancel button. If not provided, the default label is "Dismiss".</dd>
<dt><code>onclick</code> <span class="badge-secondary">Optional</span></dt>
<dd>The onclick of the cancel button.</dd>
<dd>(string) The onclick of the action. Inserted literally into the HTML so you probably want to escape it yourself.</dd>
<dt><code>href</code> <span class="badge-secondary">Optional</span></dt>
<dd>(string) The href of the action. If present, the onclick will be a <code>&lt;a&gt;</code> element. Inserted literally into the HTML so you probably want to escape it yourself. Overrides <code>conclick</code></dd>
</dl>
</dd>
<dt><code>cancel</code> <span class="badge-secondary">Optional</span></dt>
Expand All @@ -219,7 +221,7 @@ toc:
<dt><code>label</code> <span class="badge-secondary">Optional</span></dt>
<dd>The label of the cancel button. If not provided, the default label is "Dismiss".</dd>
<dt><code>onclick</code> <span class="badge-secondary">Optional</span></dt>
<dd>The onclick of the cancel button.</dd>
<dd>The onclick of the cancel button. Inserted literally into the HTML so you probably want to escape it yourself.</dd>
</dl>
</dd>
</dl>
Expand Down Expand Up @@ -276,4 +278,4 @@ toc:
{ tab: "toaster()", panel: code_block(raw_code_toaster, "jinja", class="") },
{ tab: "toast()", panel: code_block(raw_code_toast, "jinja", class="") }
] %}
{{ tabs(id="macros", tabsets=tabsets) }}
{{ tabs(id="macros", tabsets=tabsets) }}