mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
163 lines
6.6 KiB
Markdown
163 lines
6.6 KiB
Markdown
+++
|
|
description = "Clickable buttons"
|
|
title = "Button"
|
|
+++
|
|
|
|
The `button` shortcode displays a clickable button with adjustable color, title and icon.
|
|
|
|
{{% button href="https://gohugo.io/" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="warning" icon="dragon" %}}Get Hugo{{% /button %}}
|
|
|
|
## Usage
|
|
|
|
While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.
|
|
|
|
{{< tabs groupId="shortcode-parameter">}}
|
|
{{% tab name="shortcode" %}}
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="warning" icon="dragon" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{% tab name="partial" %}}
|
|
|
|
````go
|
|
{{ partial "shortcodes/button.html" (dict
|
|
"context" .
|
|
"href" "https://gohugo.io/"
|
|
"content" "Get Hugo"
|
|
)}}
|
|
{{ partial "shortcodes/button.html" (dict
|
|
"context" .
|
|
"href" "https://gohugo.io/"
|
|
"style" "warning"
|
|
"icon" "dragon"
|
|
"content" "Get Hugo"
|
|
)}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{< /tabs >}}
|
|
|
|
Once the button is clicked, it opens another browser tab for the given URL.
|
|
|
|
### Parameter
|
|
|
|
| Name | Default | Notes |
|
|
|:----------------------|:----------------|:------------|
|
|
| **href** | _<empty>_ | The destination URL for the button. If this parameter is not set, the button will do nothing but is still displayed as clickable. |
|
|
| **style** | `transparent` | The color scheme used to paint the button.<br><br>- by severity: `info`, `note`, `tip`, `warning`<br>- by brand color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`, `transparent` |
|
|
| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: _<empty>_<br><br>If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
|
| **iconposition** | `left` | Places the icon to the `left` or `right` of the title. |
|
|
| **target** | see notes | The destination frame/window for the URL. This behaves similar to normal links. If the parameter is not given it defaults to:<br><br>- `_blank` for any address starting with `http://` or `https://`<br>- no specific value for all other links |
|
|
| _**<content>**_ | see notes | Arbitrary text for the button title. Depending on the **style** there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: _<empty>_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
|
|
|
## Examples
|
|
|
|
### Style
|
|
|
|
#### By Severity
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" style="info" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="note" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="tip" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="warning" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" style="info" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="note" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="tip" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="warning" %}}Get Hugo{{% /button %}}
|
|
|
|
|
|
#### By Brand Colors
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" style="primary" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="secondary" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" style="primary" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="secondary" %}}Get Hugo{{% /button %}}
|
|
|
|
#### By Color
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" style="blue" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="green" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="grey" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="orange" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="red" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" style="blue" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="green" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="grey" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="orange" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="red" %}}Get Hugo{{% /button %}}
|
|
|
|
#### By Special Color
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" style="default" %}}Get Hugo{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" style="transparent" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" style="default" %}}Get Hugo{{% /button %}}
|
|
{{% button href="https://gohugo.io/" style="transparent" %}}Get Hugo{{% /button %}}
|
|
|
|
### Icon
|
|
|
|
#### To the Left
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" icon="download" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" icon="download" %}}Get Hugo{{% /button %}}
|
|
|
|
#### To the Right
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" icon="download" iconposition="right" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" icon="download" iconposition="right" %}}Get Hugo{{% /button %}}
|
|
|
|
#### Override for Severity
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" icon="dragon" style="warning" %}}Get Hugo{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" icon="dragon" style="warning" %}}Get Hugo{{% /button %}}
|
|
|
|
### Target
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" target="_self" %}}Get Hugo in same window{{% /button */%}}
|
|
{{%/* button href="https://gohugo.io/" %}}Get Hugo in new Window/Frame (default){{% /button */%}}
|
|
````
|
|
{{% button href="https://gohugo.io/" target="_self" %}}Get Hugo in same Window/Frame{{% /button %}}
|
|
{{% button href="https://gohugo.io/" %}}Get Hugo in new Window/Frame (default){{% /button %}}
|
|
|
|
### Other
|
|
|
|
#### Severity Style with all Defaults
|
|
|
|
````go
|
|
{{%/* button href="https://gohugo.io/" style="tip" %}}{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="https://gohugo.io/" style="tip" %}}{{% /button %}}
|
|
|
|
#### Button to internal page
|
|
|
|
````go
|
|
{{%/* button href="/" %}}Home{{% /button */%}}
|
|
````
|
|
|
|
{{% button href="/" %}}Home{{% /button %}}
|