Skip to content

Commit b1ab3a4

Browse files
committed
Update README.md
1 parent 8bd5d3b commit b1ab3a4

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

docs/README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# kirby-link-field
22

3-
Kirby 3 Field for links of any kind - external, page, file, email, phone. Has settings for text, popup true/false, and hash. Original plugin is [this](https://github.com/medienbaecker/kirby-link-field), created by [Thomas Günther](https://github.com/medienbaecker).
3+
Kirby 3 Field for links of any kind - external, page, file, email, phone. Has settings for text, popup true/false, and hash.
44

55
The plugin uses the native Kirby fields for pages, files, url, email, and tel:
66

@@ -10,9 +10,14 @@ If used inside a structure field, link fields get a nice preview. Links to pages
1010

1111
![links in structure field](structure.gif)
1212

13+
## Contributing
14+
15+
- Read the [CONTRIBUTING.md](https://github.com/OblikStudio/kirby-link-field/blob/master/docs/CONTRIBUTING.md) for details
16+
- Support development by [sponsoring us](https://github.com/sponsors/OblikStudio)
17+
1318
## Installation
1419

15-
With [Composer](https://packagist.org/packages/oblik/kirby-link-field):
20+
With Composer from [oblik/kirby-link-field on packagist](https://packagist.org/packages/oblik/kirby-link-field):
1621

1722
```
1823
composer require oblik/kirby-link-field
@@ -31,18 +36,20 @@ fields:
3136
label: Link
3237
```
3338
34-
To define what link types you want, use `options`. Possible values are `url`, `page`, `file`, `email`, and `tel`:
39+
To define what link types you want, use `linkTypes`. Possible values are `url`, `page`, `file`, `email`, and `tel`:
3540

3641
```yaml
3742
fields:
3843
myfield:
3944
type: link
4045
label: Link
41-
options:
46+
linkTypes:
4247
- page
4348
- url
4449
```
4550

51+
**Note:** This was changed in version 4.0.0 from `options` to `linkTypes` due to an issue with Kirby's internal logic.
52+
4653
By default, you can also specify link text, popup true/false, and hash. You can disable those options or change their appearance by using the `settings` value:
4754

4855
```yaml
@@ -72,8 +79,8 @@ _config/config.php_
7279

7380
```php
7481
return [
75-
'oblik.linkField' => [
76-
'options' => [
82+
'oblik.link-field' => [
83+
'linkTypes' => [
7784
'url',
7885
'page'
7986
],
@@ -90,7 +97,7 @@ return [
9097

9198
```php
9299
return [
93-
'oblik.linkField.settings' => false
100+
'oblik.link-field.settings' => false
94101
];
95102
```
96103

@@ -233,3 +240,7 @@ Myfield:
233240
type: url
234241
value: https://example.com
235242
```
243+
244+
## Support
245+
246+
If you find the plugin useful and would like to receive better support for it, please consider [sponsoring us](https://github.com/sponsors/OblikStudio). Thank you! 🙏

0 commit comments

Comments
 (0)