enhanced-toolbar-link-dialog

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

enhanced-toolbar-link-dialog

★ 62 Open GitHub ↗

Extend Kirby's default link dialog with search functionality, allowing you to easily create links to existing or external pages at your fingertips.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Enhanced Toolbar Link Dialog

![Kirby](https://img.shields.io/badge/Kirby-%3E=3.6-brightgreen.svg)
![Version](https://img.shields.io/github/v/release/gearsdigital/enhanced-toolbar-link-dialog?label=Version&color=4CC61E&logo=github)
![E2E](https://github.com/gearsdigital/enhanced-toolbar-link-dialog/workflows/E2E/badge.svg)
![Downloads](https://img.shields.io/packagist/dt/gearsdigital/enhanced-toolbar-link-dialog?label=Downloads)
![PHP 8.0](https://img.shields.io/badge/php-8.1-brightgreen.svg?color=8892BF&logo=php)

This plugin extends the default link dialog with search functionality, making it possible to create links to _existing_ or _external_ pages.

## Configuration

These are all available configuration options and their default values.

| Option         | Description                                                                                                                       | Type      | Default            |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------|-----------|--------------------|
| `title`        | Format the page title of the result list using [Kirby Query Language](https://getkirby.com/docs/guide/blueprints/query-language). | `string`  | `{{ page.title }}` |
| `filter`       | Filter the result list. Learn how to use [`filterBy`](https://getkirby.com/docs/reference/objects/toolkit/collection/filter-by).  | `array`   | `null`             |
| `sort`         | Sort the result list. Learn how to use [`sortBy`](https://getkirby.com/docs/reference/objects/toolkit/collection/sort-by).        | `array`   | `null`             |
| `qualified`    | Prefix every link with your current [Site-Url](https://getkirby.com/docs/reference/objects/cms/site/url).                         | `boolean` | `false`            |
| `translations` | [Override plugin translations](#localization).                                                                                    | `array`   | `[]`               |
| `target-field` | By setting `hidden`, the field will be hidden. Setting `disabled` will disable the field but keep it visible.                     | `string`  |                    |
| `anchor-field` | By setting `hidden`, the field will be hidden. Setting `disabled` will disable the field but keep it visible.                     | `string`  |                    |

### Usage

```php
// site/config/config.php
return [
  "gearsdigital.enhanced-toolbar-link-dialog" => [
    "title" => "{{ page.title }}",
    "filter" => null,
    "sort" => null,
    "qualified" => false,
    "translations" => [],
    "anchor-field" => 'hidden',
    "target-field" => disabled,
  ]
];
```

## Installation

### Composer (recommended)

```
composer require gearsdigital/enhanced-toolbar-link-dialog
```

### Download

Download the [latest version](https://github.com/gearsdigital/enhanced-toolbar-link-dialog/releases/latest), copy all files to `/site/plugins/enhanced-toolbar-link-dialog`.

### Git submodule

```
git submodule add https://github.com/gearsdigital/enhanced-toolbar-link-dialog.git site/plugins/enhanced-toolbar-link-dialog
```

## FAQ

<details>
<summary>Can I use this plugin with Kirby Blocks?</summary>
Starting from version 3.0.0, <a href="https://getkirby.com/docs/reference/panel/fields/blocks">Blocks</a> are supported, and it also works seamlessly with default textareas.
</details>

<details>
<summary>Can I link to different sites?</summary>
Yes, absolutely. Just write (or paste) the URL into the Link field.
</details>

<details>
<summary>Can I create anchor-only links?</summary>
If you want to jump to a specific part of the page you're currently editing, you can create anchor-only links by leaving the Link field empty and filling in the Anchor field.
</details>

<details>
<summary>Can I customize the result list page title?</summary>
Yes, you can use the <code>title</code> option to customize the title according to your needs using the <a href="https://getkirby.com/docs/guide/blueprints/query-language">Kirby Query Language</a>.
Within a query, you have access to <code>page</code>, <code>site</code>, and <code>kirby</code> objects. For example, setting <code>'title' => '{{ page.title }} [{{ page.parent.title }}]'</code> will display the title as 'Mountains [Photography]'.
</details>

<details>
<summary>Can I show only pages that match some specific criteria?</summary>
Certainly! By setting <code>"filter"=> ['status', 'listed']</code>, only listed pages will be displayed. You can study the <a href="https://getkirby.com/docs/cookbook/content/filtering">
Filtering compendium</a> to learn more about filtering collections in Kirby.
</details>

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Localization

This is the list of all available translation keys:

| Key                                                                       | Value                       |
|---------------------------------------------------------------------------|-----------------------------|
| `gearsdigital.enhanced-toolbar-link-dialog.anchor.title`                  | Anchor                      |
| `gearsdigital.enhanced-toolbar-link-dialog.field.autosuggest.placeholder` | Enter a URL or search term… |

You can override translations by adding this to your site config.

```php
// site/config/config.php
return [
  "gearsdigital.enhanced-toolbar-link-dialog" => [
    "translations" => [
      "en" => [
        "gearsdigital.enhanced-toolbar-link-dialog.autosuggest.placeholder" => "I'm overridden!",
      ],
    ],
  ]
]
```

### Available languages

- English (default)
- German 🇩🇪
- French 🇫🇷
- Dutch 🇳🇱
- Danish 🇩🇰
- Norwegian 🇳🇴
- Swedish 🇸🇪
- Islandic 🇮🇸

## License

[MIT](https://choosealicense.com/licenses/mit/)

enhanced-toolbar-link-dialog

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README