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 the toggle shortcode #861

Merged
merged 3 commits into from
Jan 21, 2023
Merged
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
13 changes: 12 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
{
"singleQuote": true
"goTemplateBracketSpacing": true,
"overrides": [
{
"files": [
"*.html"
],
"options": {
"parser": "go-template",
"bracketSameLine": true
}
}
]
}
7 changes: 7 additions & 0 deletions assets/main/scss/_nav.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,10 @@
--#{$prefix}nav-pills-link-active-bg: var(--#{$prefix}primary);
--#{$prefix}nav-pills-link-active-color: var(--#{$prefix}on-primary);
}

.nav-pills,
.nav-tabs {
.nav-item {
margin-bottom: 0;
}
}
76 changes: 76 additions & 0 deletions exampleSite/content/docs/shortcodes/toggle/index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
+++
# type = "docs"
title = "Toggle"
date = 2023-01-21T23:22:11+08:00
# description = "" # Used by description meta tag, summary will be used instead if not set or empty.
featured = false
draft = false
comment = true
toc = true
reward = true
pinned = false
carousel = false
categories = ["Shortcode"]
tags = ["Toggle"]
series = ["Docs"]
images = []
+++

The `toggle` shortcode is similar to the `code-toggle`, but it's more generic.

<!--more-->

## Usage

```markdown
{{</* toggle myToggleName */>}}

{{</* toggle-item myToggleItemName */>}}
CONTENT HERE, MARKDOWN and SHORTCODE are support.
{{</* /toggle-item */>}}

...

{{</* /toggle */>}}
```

- The `myToggleName` MUST be unique per page.
- The `myToggleItemName` MUST be unique per toggle.

## Example

{{< toggle foobar >}}

{{< toggle-item Foo >}}
Foo
{{< /toggle-item >}}

{{< toggle-item Bar >}}
Bar
{{< /toggle-item >}}

{{< /toggle >}}


{{< toggle languages >}}
{{< toggle-item PHP >}}
{{< highlight php >}}
<?php
echo "hello world"
{{< /highlight >}}
{{< /toggle-item >}}

{{< toggle-item JS >}}
{{< highlight javascript >}}
console.log("hello world")
{{< /highlight >}}
{{< /toggle-item >}}

{{< toggle-item SQL >}}
{{< highlight sql >}}
SELECT "hello world"
{{< /highlight >}}
{{< /toggle-item >}}

{{< /toggle >}}

3 changes: 3 additions & 0 deletions layouts/shortcodes/toggle-item.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{{- $parentName := .Parent.Get 0 }}
{{- $name := .Get 0 }}
{{- .Page.Store.SetInMap (printf "toggle-%s-items" $parentName) $name .Inner -}}
37 changes: 37 additions & 0 deletions layouts/shortcodes/toggle.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{{- $name := .Get 0 }}
{{- if eq .Inner "" }}{{ end }}
{{- $items := .Page.Store.Get (printf "toggle-%s-items" $name) }}
<ul class="nav nav-tabs toggle" id="toggle-{{ $name }}" role="tablist">
{{- $count := 0 }}
{{- range $itemName, $item := $items }}
<li class="nav-item" role="presentation">
<button
class="nav-link{{ if eq $count 0 }} active{{ end }}"
id="toggle-{{ $name }}-{{ $itemName }}-tab"
data-bs-toggle="tab"
data-bs-target="#toggle-{{ $name }}-{{ $itemName }}-tab-pane"
type="button"
role="tab"
aria-controls="toggle-{{ $name }}-{{ $itemName }}-tab-pane"
aria-selected="{{ cond (eq $count 0) `true` `false` }}">
{{ $itemName }}
</button>
</li>
{{- $count = add $count 1 }}
{{- end }}
</ul>
<div class="tab-content mb-3" id="toggle-{{ $name }}-content">
{{- $count := 0 }}
{{- range $itemName, $item := $items }}
<div
class="tab-pane fade{{ if eq $count 0 }} show active{{ end }}"
id="toggle-{{ $name }}-{{ $itemName }}-tab-pane"
role="tabpanel"
aria-labelledby="toggle-{{ $name }}-{{ $itemName }}-tab"
tabindex="0">
{{ $item }}
</div>
{{- $count = add $count 1 }}
{{- end }}
</div>

Loading