Skip to content

feat: add raw-query option for search bangs #896

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
NecRaul wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat: add raw-query option for search bangs #896

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
49 changes: 44 additions & 5 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1205,6 +1205,7 @@ Example:
- title: YouTube
shortcut: "!yt"
url: https://www.youtube.com/results?search_query={QUERY}
raw-query: false
```

Preview:
Expand Down Expand Up @@ -1264,11 +1265,12 @@ What now? [Bangs](https://duckduckgo.com/bangs). They're shortcuts that allow yo
![](images/search-widget-bangs-preview.png)

##### Properties for each bang
| Name | Type | Required |
| ---- | ---- | -------- |
| title | string | no |
| shortcut | string | yes |
| url | string | yes |
| Name | Type | Required | Default |
| ---- | ---- | -------- | ------- |
| title | string | no | |
| shortcut | string | yes | |
| url | string | yes | |
| raw-query | boolean | no | false |

###### `title`
Optional title that will appear on the right side of the search bar when the query starts with the associated shortcut.
Expand All @@ -1292,6 +1294,43 @@ url: https://store.steampowered.com/search/?term={QUERY}
url: https://www.amazon.com/s?k={QUERY}
```

###### `raw-query`
Optional boolean that determines whether the query is inserted raw (without URL encoding) into the URL.

> ```yaml
> shortcut: "!gh"
> url: https://github.com/{QUERY}
> raw-query: false
>
> shortcut: "!ghr"
> url: https://github.com/{QUERY}
> raw-query: true
>```

Typing

```
!gh glanceapp/glance
```

would result in

```
https://github.com/glanceapp%2Fglance
```

whereas

```
!ghr glanceapp/glance
```

would result in

```
https://github.com/glanceapp/glance
```

### Group
Group multiple widgets into one using tabs. Widgets are defined using a `widgets` property exactly as you would on a page column. The only limitation is that you cannot place a group widget or a split column widget within a group widget.

Expand Down
5 changes: 4 additions & 1 deletion internal/glance/static/js/page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,10 @@ function setupSearchBoxes() {
return;
}

const url = searchUrlTemplate.replace("!QUERY!", encodeURIComponent(query));
const url = currentBang.dataset.raw === "true"
? searchUrlTemplate.replace("!QUERY!", query)
: searchUrlTemplate.replace("!QUERY!", encodeURIComponent(query));


if (newTab && !event.ctrlKey || !newTab && event.ctrlKey) {
window.open(url, target).focus();
Expand Down
2 changes: 1 addition & 1 deletion internal/glance/templates/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<div class="search widget-content-frame padding-inline-widget flex gap-15 items-center" data-default-search-url="{{ .SearchEngine }}" data-new-tab="{{ .NewTab }}" data-target="{{ .Target }}">
<div class="search-bangs">
{{ range .Bangs }}
<input type="hidden" data-shortcut="{{ .Shortcut }}" data-title="{{ .Title }}" data-url="{{ .URL }}">
<input type="hidden" data-shortcut="{{ .Shortcut }}" data-title="{{ .Title }}" data-url="{{ .URL }}" data-raw="{{ .RawQuery }}">
{{ end }}
</div>

Expand Down
1 change: 1 addition & 0 deletions internal/glance/widget-search.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ type SearchBang struct {
Title string
Shortcut string
URL string
RawQuery bool `yaml:"raw-query"`
}

type searchWidget struct {
Expand Down