Skip to content

Hugo: add searchTerm option to search shortcode #489

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Hugo: add searchTerm option to search shortcode #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions content/examples/shortcodes/search/en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ With this shortcode you can embed a search results widget on the page.
## Example

```
{{</* search contentType="How-to Guides" showContentTypes=false tags="encodings,commented cue" */>}}
{{</* search contentType="Tutorials" showContentTypes=false tags="encodings,cue command" searchTerm="\"json schema\"" */>}}
```

{{< search contentType="How-to Guides" showContentTypes=false tags="encodings,commented cue" >}}
{{< search contentType="Tutorials" showContentTypes=false tags="encodings,cue command" searchTerm="\"json schema\"" >}}


## Attributes
Expand All @@ -24,3 +24,6 @@ showContentTypes

tags
: optional - Adds preselected tags

searchTerm
: optional - Prefills the search bar
6 changes: 6 additions & 0 deletions hugo/assets/ts/widgets/search-filter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,12 @@ export class SearchFilter extends BaseWidget {
urlParamsChanged = true;
}

const initialSearchTerm = this.element.dataset.initialSearchTerm;
if (!query && this.parsedQuery.cleanQuery === '' && initialSearchTerm) {
this.parsedQuery.cleanQuery = initialSearchTerm;
urlParamsChanged = true;
}

// Update parsed query & save selected items
this.parsedQuery.facets[this.filterName] = selectedItems;
this.selectedItems = selectedItems;
Expand Down
7 changes: 5 additions & 2 deletions hugo/content/en/examples/shortcodes/search/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ With this shortcode you can embed a search results widget on the page.
## Example

```
{{</* search contentType="How-to Guides" showContentTypes=false tags="encodings,commented cue" */>}}
{{</* search contentType="Tutorials" showContentTypes=false tags="encodings,cue command" searchTerm="\"json schema\"" */>}}
```

{{< search contentType="How-to Guides" showContentTypes=false tags="encodings,commented cue" >}}
{{< search contentType="Tutorials" showContentTypes=false tags="encodings,cue command" searchTerm="\"json schema\"" >}}


## Attributes
Expand All @@ -24,3 +24,6 @@ showContentTypes

tags
: optional - Adds preselected tags

searchTerm
: optional - Prefills the search bar
2 changes: 2 additions & 0 deletions hugo/layouts/partials/filter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
{{ $inputLabel := printf "search_%s_input" $translationKey }}
{{ $noResults := printf "search_%s_no-results" $translationKey }}
{{ $preselectedItems := .preselectedItems }}
{{ $searchTerm := .searchTerm }}

<details class="filter{{ if $cssClass }} {{ $cssClass }}{{ end }} is-loading"
data-dropdown data-filter="{{ $name }}"
data-filter-items="{{ $filters | jsonify }}"
{{ if $preselectedItems }} data-preselected-items="{{ $preselectedItems }}"{{ end }}
{{ if $searchTerm }} data-initial-search-term="{{ $searchTerm }}"{{ end }}
{{ if $open }} open{{ end }}
>
<summary class="filter__title button button--small button--white">
Expand Down
2 changes: 2 additions & 0 deletions hugo/layouts/partials/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{{ $contentTypes := slice }}
{{ $contentType := .contentType | default "" }}
{{ $preselectedTags := .preselectedTags | default "" }}
{{ $searchTerm := .searchTerm | default "" }}
{{ $type := .type | default "full" }}
{{ $placeholder := (T "search_placeholder" ) }}

Expand Down Expand Up @@ -48,6 +49,7 @@
"name" "tags"
"filters" .Site.Params.tags
"preselectedItems" $preselectedTags
"searchTerm" $searchTerm
) -}}

{{ if $showContentTypes }}
Expand Down
2 changes: 2 additions & 0 deletions hugo/layouts/shortcodes/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
{{- $contentType := .Get "contentType" | default "" -}}
{{- $showContentTypes := .Get "showContentTypes" | default true -}}
{{- $preselectedTags := .Get "tags" | default "" -}}
{{- $searchTerm := .Get "searchTerm" | default "" -}}

{{- partial "search" (dict
"type" "widget"
"contentType" $contentType
"showContentTypes" $showContentTypes
"preselectedTags" $preselectedTags
"searchTerm" $searchTerm
"context" .
) -}}
Loading