Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bnomei/kirby3-fontselector
Kirby 3 Plugin to select font family and font weight with two synced fields
https://github.com/bnomei/kirby3-fontselector
family fields font kirby3 kirby3-cms kirby3-plugin sync watch weight
Last synced: 14 days ago
JSON representation
Kirby 3 Plugin to select font family and font weight with two synced fields
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-fontselector
- Owner: bnomei
- License: mit
- Created: 2022-05-19T14:29:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T12:34:18.000Z (7 months ago)
- Last Synced: 2024-10-30T10:42:54.313Z (17 days ago)
- Topics: family, fields, font, kirby3, kirby3-cms, kirby3-plugin, sync, watch, weight
- Language: PHP
- Homepage:
- Size: 868 KB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kirby 3 Font Selector
[](https://twitter.com/bnomei)
Kirby 3 Plugin to select font family and font weight with two synced fields
## Commercial Usage
>
> Support open source!
> This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
> If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?
> Be kind. Share a little. Thanks.
> ‐ Bruno
>
| M | O | N | E | Y |
|---|----|---|---|---|
| [Github sponsor](https://github.com/sponsors/bnomei) | [Patreon](https://patreon.com/bnomei) | [Buy Me a Coffee](https://buymeacoff.ee/bnomei) | [Paypal dontation](https://www.paypal.me/bnomei/15) | [Hire me](mailto:[email protected]?subject=Kirby) |
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-fontselector/archive/master.zip) as folder `site/plugins/kirby3-fontselector` or
- `git submodule add https://github.com/bnomei/kirby3-fontselector.git site/plugins/kirby3-fontselector` or
- `composer require bnomei/kirby3-fontselector`
## Screenshot
## Fonts
Set the fonts you want to use with a config value. You could use a custom JSON file or return a php array.
**assets/fonts.json**
```json
{
"fonts": [
{
"font": "Merriweather",
"weight": [
600,
700
]
},
{
"font": "Montserrat",
"weight": [
300,
400,
500
]
}
]
}
```
```php
function() {
return Json::read(kirby()->roots()->assets() . '/fonts.json');
// return ['fonts' => [...]];
},
// other options
];
```
## Usage
Add the fields to your page blueprint.
**site/blueprints/default.yml**
```yaml
fields:
headlinefont:
type: fontfamily
default: Merriweather
required: true
# reload: true # optional reload on save
headlineh1weight:
type: fontweight
watchField: headlinefont
default: 700
required: true
headlineh2weight:
type: fontweight
watchField: headlinefont
default: 600
required: true
copytextfont:
type: fontfamily
default: Montserrat
required: true
copytextweight:
type: fontweight
watchField: copytextfont
default: 400
required: true
```
> ⚠️ This plugin has by default a 1 minute cache.
## Settings
| bnomei.fontselector. | Default | Description |
|----------------------|----------------------|------------------------------------|
| fonts | `function(){...}` | callback to return the fonts array |
| expire | `1` | cache will expire n-minutes |
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-fontselector/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.