Skip to content

Commit

Permalink
feat: add support for icon in badge shortcode (#525)
Browse files Browse the repository at this point in the history
* feat: add icon support to badge shortcodes

- Introduced an optional icon parameter to both badge.html files.
- Updated the badge rendering to include the icon alongside the content.
- Enhanced the layout for better alignment of icon and text.

* feat: add new feature shortcode

* docs: update badge doc
  • Loading branch information
imfing authored Dec 28, 2024
1 parent 26a298d commit 79bb450
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 5 deletions.
7 changes: 3 additions & 4 deletions exampleSite/content/docs/guide/shortcodes/others.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ Result:
{{< badge content="warning" type="warning" >}} &nbsp;
{{< badge content="error" type="error" >}}

With link:
With link and icon:

```
{{</* badge content="Releases" link="https://github.com/imfing/hextra/releases" */>}}
{{</* badge content="Releases" link="https://github.com/imfing/hextra/releases" icon="github" */>}}
```

Result:

{{< badge content="Releases" link="https://github.com/imfing/hextra/releases" >}}

{{< badge content="Releases" link="https://github.com/imfing/hextra/releases" icon="github" >}}

## YouTube

Expand Down
11 changes: 11 additions & 0 deletions exampleSite/layouts/shortcodes/new-feature.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{- $version := .Get "version" | default "" -}}
{{- $icon := .Get "icon" | default "" -}}
{{- $defaultLink := cond (eq $version "") "https://github.com/imfing/hextra/tree/main" (printf "https://github.com/imfing/hextra/releases/tag/%s" $version) -}}
{{- $link := .Get "link" | default $defaultLink -}}
{{- $content := cond (eq $version "") "New in main branch" (printf "New in %s" $version) -}}

<div style="margin-top: 1rem; display: inline-flex;">
<a href="{{ $link }}" title="{{ $link | plainify }}" target="_blank">
{{- partial "shortcodes/badge" (dict "content" $content "border" true "icon" $icon) -}}
</a>
</div>
6 changes: 5 additions & 1 deletion layouts/partials/shortcodes/badge.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
{{- $type := .type -}}
{{- $class := .class | default "" -}}
{{- $border := .border | default false -}}
{{- $icon := .icon | default "" -}}

{{- $defaultClass := "hx-text-gray-600 hx-bg-gray-100 dark:hx-bg-neutral-800 dark:hx-text-neutral-200 hx-border-gray-200 dark:hx-border-neutral-700" -}}
{{- $warningClass := "hx-border-yellow-100 hx-bg-yellow-50 hx-text-yellow-900 dark:hx-border-yellow-200/30 dark:hx-bg-yellow-700/30 dark:hx-text-yellow-200" -}}
Expand All @@ -11,6 +12,9 @@
{{- $borderClass := cond (eq $border true) "hx-border" "" -}}
{{- $badgeClass := cond (eq $type "info") $infoClass (cond (eq $type "warning") $warningClass (cond (eq $type "error") $errorClass $defaultClass)) -}}
<div class="hextra-badge {{ $class }}">
<div class="hx-inline-flex hx-items-center hx-rounded-full hx-px-2.5 hx-leading-6 hx-text-[.65rem] {{ $borderClass }} {{ $badgeClass }}">{{- $content -}}</div>
<div class="hx-inline-flex hx-gap-1 hx-items-center hx-rounded-full hx-px-2.5 hx-leading-6 hx-text-[.65rem] {{ $borderClass }} {{ $badgeClass }}">
{{- with $icon -}}{{- partial "utils/icon" (dict "name" . "attributes" "height=12") -}}{{- end -}}
{{- $content -}}
</div>
</div>
{{- /* Strip trailing newline. */ -}}
3 changes: 3 additions & 0 deletions layouts/shortcodes/badge.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{{- $type := .Get "type" | default "" -}}
{{- $class := .Get "class" | default "" -}}
{{- $link := .Get "link" | default "" -}}
{{- $icon := .Get "icon" | default "" -}}

{{- if $link -}}
<a href="{{ $link }}" title="{{ $content | plainify }}" target="_blank">
Expand All @@ -11,6 +12,7 @@
"type" $type
"class" $class
"border" true
"icon" $icon
)
-}}
</a>
Expand All @@ -20,6 +22,7 @@
"type" $type
"class" $class
"border" true
"icon" $icon
)
-}}
{{- end -}}
Expand Down

0 comments on commit 79bb450

Please sign in to comment.