Skip to content
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.

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

feat: add tooltips to cards #446

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 14 additions & 12 deletions exampleSite/content/docs/guide/shortcodes/cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ linkTitle: Cards

{{< cards >}}
{{< card link="../callout" title="Callout" icon="warning" >}}
{{< card link="../callout" title="Card with tag" icon="tag" tag="custom tag">}}
{{< card link="/" title="No Icon" >}}
{{< card link="../callout" title="Card with tag" icon="tag" tag="A custom tag with Tooltip" tagtooltip="Tooltip for Tag">}}
{{< card link="/" title="No Icon, but with Tooltip" linktooltip="Tooltip for Link" >}}
{{< /cards >}}

{{< cards >}}
Expand All @@ -22,8 +22,8 @@ linkTitle: Cards
```
{{</* cards */>}}
{{</* card link="../callout" title="Callout" icon="warning" */>}}
{{</* card link="../callout" title="Card with tag" icon="warning" tag= "A custom tag" */>}}
{{</* card link="/" title="No Icon" */>}}
{{</* card link="../callout" title="Card with tag" tag="A custom tag with Tooltip" tagtooltip="Tooltip for Tag" */>}}
{{</* card link="/" title="No Icon, but with Tooltip" linktooltip="Tooltip for Link" */>}}
{{</* /cards */>}}
```

Expand All @@ -37,14 +37,16 @@ linkTitle: Cards

## Card Parameters

| Parameter | Description |
|----------- |-----------------------------------------------------------------|
| `link` | URL (internal or external). |
| `title` | Title heading for the card. |
| `subtitle` | Subtitle heading (supports Markdown). |
| `icon` | Name of the icon. |
| `tag` | Text in tag. |
| `tagColor` | Color of the tag: `gray` (default), `yellow`, `red` and `blue`. |
| Parameter | Description |
|---------------|-----------------------------------------------------------------------|
| `link` | URL (internal or external). |
| `title` | Title heading for the card. |
| `linktooltip` | Tooltip (title-attribut) for the link. |
| `subtitle` | Subtitle heading (supports Markdown). |
| `icon` | Name of the icon. |
| `tag` | Text in tag. |
| `tagType` | Type of the tag: `info` (blue), `warning` (yellow) and `error` (red). |
| `tagtooltip` | Tooltip (title-attribut) for the Tag. |

## Image Card

Expand Down
5 changes: 4 additions & 1 deletion layouts/partials/shortcodes/card.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{{- $page := .page -}}
{{- $link := .link -}}
{{- $title := .title -}}
{{- $linktooltip := .linktooltip -}}
{{- $icon := .icon -}}
{{- $subtitle := .subtitle -}}
{{- $image := .image -}}
Expand All @@ -9,6 +10,7 @@
{{- $imageStyle := .imageStyle -}}
{{- $tag := .tag -}}
{{- $tagType := .tagType -}}
{{- $tagtooltip := .tagtooltip -}}

{{ $linkClass := "hover:hx-border-gray-300 hx-bg-transparent hx-shadow-sm dark:hx-border-neutral-800 hover:hx-bg-slate-50 hover:hx-shadow-md dark:hover:hx-border-neutral-700 dark:hover:hx-bg-neutral-900" }}
{{- with $image -}}
Expand All @@ -25,6 +27,7 @@
href="{{ $href }}"
{{ with $external }}target="_blank" rel="noreferrer"{{ end -}}
{{- end -}}
{{- with $linktooltip }}title="{{- . -}}"{{ end -}}
>
{{- with $image -}}
<img
Expand Down Expand Up @@ -61,7 +64,7 @@

{{ $tagClass := cond (eq $tagType "info") $infoClass (cond (eq $tagType "warning") $warningClass (cond (eq $tagType "error") $errorClass $defaultClass)) }}
<div class="hextra-card-tag">
<span class="hx-inline-block hx-rounded-full hx-px-2.5 hx-leading-6 {{ $tagClass }}">{{ $tag }}</span>
<span class="hx-inline-block hx-rounded-full hx-px-2.5 hx-leading-6 {{ $tagClass }}" {{- with $tagtooltip }}title="{{- . -}}"{{ end -}} >{{ $tag }}</span>
</div>
{{- end -}}
</a>
Expand Down
4 changes: 4 additions & 0 deletions layouts/shortcodes/card.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{{- $context := . -}}
{{- $link := .Get "link" -}}
{{- $title := .Get "title" -}}
{{- $linktooltip := .Get "linktooltip" -}}
{{- $icon := .Get "icon" -}}
{{- $subtitle := .Get "subtitle" -}}
{{- $image := .Get "image" -}}
Expand All @@ -9,6 +10,7 @@
{{- $imageStyle := .Get "imageStyle" -}}
{{- $tag := .Get "tag" -}}
{{- $tagType := .Get "tagType" -}}
{{- $tagtooltip := .Get "tagtooltip" -}}

{{/* Image processing options */}}
{{- $method := .Get "method" | default "Resize" | humanize -}}
Expand Down Expand Up @@ -44,6 +46,7 @@
"page" .Page
"link" $link
"title" $title
"linktooltip" $linktooltip
"icon" $icon
"subtitle" $subtitle
"image" $image
Expand All @@ -52,5 +55,6 @@
"imageStyle" $imageStyle
"tag" $tag
"tagType" $tagType
"tagtooltip" $tagtooltip
)
-}}