Skip to content

Commit

Permalink
tpl/tplimpl: Add details shortcode
Browse files Browse the repository at this point in the history
- Add new shortcode to render details HTML element.
- Implement integration tests to check: default state, custom summary, open state,  attribute sanitization, allowed attributes, and localization of default summary text.
- Update docs to include details shortcode.

Closes # 13090
  • Loading branch information
racehd authored and bep committed Dec 13, 2024
1 parent 8390a4a commit f29f19a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
34 changes: 34 additions & 0 deletions content/en/content-management/shortcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,40 @@ Example usage:

Although you can call this shortcode using the `{{</* */>}}` notation, computationally it is more efficient to call it using the `{{%/* */%}}` notation as shown above.

### details

{{< new-in 0.140.0 >}}

{{% note %}}
To override Hugo's embedded `details` shortcode, copy the [source code] to a file with the same name in the layouts/shortcodes directory.

This may be useful if you are wanting access to more global HTML attributes.

[source code]: {{% eturl details %}}
{{% /note %}}

Use the `details` shortcode to generate a collapsible details HTML element. For example:

```text
{{</* details summary="Custom Summary Text" */>}}
Showing custom `summary` text.
{{</* /details */>}}
```

Additional examples can be found in the source code. The `details` shortcode can use the following named arguments:

summary
: (`string`) Optional. Specifies the content of the child summary element. Default is "Details"

open
: (`bool`) Optional. Whether to initially display the contents of the details element. Default is `false`.

name
: (`string`) Optional. The value of the element's name attribute.

class
: (`string`) Optional. The value of the element's class attribute.

### figure

{{% note %}}
Expand Down
1 change: 1 addition & 0 deletions data/embedded_template_urls.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

# Shortcodes
'comment' = 'shortcodes/comment.html'
'details' = 'shortcodes/details.html'
'figure' = 'shortcodes/figure.html'
'gist' = 'shortcodes/gist.html'
'highlight' = 'shortcodes/highlight.html'
Expand Down

0 comments on commit f29f19a

Please sign in to comment.