Rockingcool/paige-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename icon name to title

Browse Source
This commit is contained in:
Will Faught
2023-09-24 18:45:02 -07:00
parent f05f002f2d
commit 4e030066f0
4 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -591,7 +591,7 @@ The `paige/icon` shortcode provides a web font icon.
``` ```
{{< paige/icon {{< paige/icon
class="" class=""
name="" title=""
url="" >}} url="" >}}
``` ```
@@ -602,8 +602,8 @@ Parameters:
<dl> <dl>
<dt><code>class</code></dt> <dt><code>class</code></dt>
<dd>Required. Position 0. String. <code>&lt;i&gt;</code> class. Example is <code>bi bi-github</code>.</dd> <dd>Required. Position 0. String. <code>&lt;i&gt;</code> class. Example is <code>bi bi-github</code>.</dd>
<dt><code>name</code></dt> <dt><code>title</code></dt>
<dd>Optional. String. The screen reader description. Example is <code>GitHub</code>.</dd> <dd>Optional. String. The screen reader description and anchor title. Example is <code>GitHub</code>.</dd>
<dt><code>url</code></dt> <dt><code>url</code></dt>
<dd>Optional. String. URL. Example is <code>https://github.com/willfaught/paige</code>. E-mails in URLs with a <code>mailto:</code> scheme are protected from web crawlers.</dd> <dd>Optional. String. URL. Example is <code>https://github.com/willfaught/paige</code>. E-mails in URLs with a <code>mailto:</code> scheme are protected from web crawlers.</dd>
</dl> </dl>

2
exampleSite/content/_index.md
View File

@@ -32,5 +32,5 @@ title: "Paige"
</p> </p>
<div class="column-gap-3 d-flex display-6 justify-content-center mb-3"> <div class="column-gap-3 d-flex display-6 justify-content-center mb-3">
{{< paige/icon class="bi bi-github" name="GitHub" url="https://github.com/willfaught/paige" >}} {{< paige/icon class="bi bi-github" title="GitHub" url="https://github.com/willfaught/paige" >}}
</div> </div>

6
exampleSite/content/shortcodes/icon.md
View File

@@ -23,17 +23,17 @@ Result:
<p class="display-1">Icon: {{< paige/icon class="bi bi-github" >}}</p> <p class="display-1">Icon: {{< paige/icon class="bi bi-github" >}}</p>
## Name parameter ## Title parameter
Code: Code:
```go-html-template ```go-html-template
<p class="display-1">Icon: {{</* paige/icon class="bi bi-github" name="GitHub" */>}}</p> <p class="display-1">Icon: {{</* paige/icon class="bi bi-github" title="GitHub" */>}}</p>
``` ```
Result: Result:
<p class="display-1">Icon: {{< paige/icon class="bi bi-github" name="GitHub" >}}</p> <p class="display-1">Icon: {{< paige/icon class="bi bi-github" title="GitHub" >}}</p>
## Url parameter ## Url parameter

6
layouts/shortcodes/paige/icon.html
View File

@@ -1,5 +1,5 @@
{{ $class := .Get 0 | default (.Get "class") }} {{ $class := .Get 0 | default (.Get "class") }}
{{ $name := .Get "name" }} {{ $title := .Get "title" }}
{{ $url := .Get "url" }} {{ $url := .Get "url" }}
{{ if not $class }} {{ if not $class }}
@@ -8,10 +8,10 @@
<span class="paige-icon"> <span class="paige-icon">
{{ with $url }} {{ with $url }}
<a href="{{ . }}" {{ with $name }} title="{{ . }}" {{ end }}> <a href="{{ . }}" {{ with $title }} title="{{ . }}" {{ end }}>
{{ end }} {{ end }}
<i class="{{ $class }}">{{ with $name }}<span class="visually-hidden">{{ . }}</span>{{ end }}</i> <i class="{{ $class }}">{{ with $title }}<span class="visually-hidden">{{ . }}</span>{{ end }}</i>
{{ if $url }} {{ if $url }}
</a> </a>