silverstripe / theme-fontpicker
Customise site fonts from the admin settings
Installs: 1 106
Dependents: 2
Suggesters: 1
Security: 0
Stars: 2
Watchers: 8
Forks: 1
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- silverstripe/fontpicker: dev-master
- silverstripe/siteconfig: ^4.4
Requires (Dev)
- phpunit/phpunit: ^5.7
- squizlabs/php_codesniffer: ^3
This package is auto-updated.
Last update: 2024-11-09 04:29:34 UTC
README
This module adds a font picker under the admin settings, under a Theme Options
tab. It comes with 3 fonts out of the box, provided by Google Fonts, but more fonts can be added.
Usage
Adding extra fonts
To add extra fonts, simply set the theme_fonts
field under SiteConfig
as follows:
SilverStripe\SiteConfig\SiteConfig: theme_fonts: metropolis: Metropolis nunito-sans: Nunito Sans fira-sans: Fira Sans merriweather: Merriweather
Note that any font which is unavailable at Google Fonts will not be displayed in preview in the font selector.
Changing the default font
To set the default font, simply set the default_font
field under SiteConfig
as follows:
SilverStripe\Fontpicker\Forms\FontPickerField: default_font: metropolis
Using in your own theme
First, ensure that there is a HTML class
present in your template which indicates the theme variation to the CSS.
Below is the default implementation which you'll also find in the Bambusa and Watea theme.
<body class="$ClassName <% if $SiteConfig.MainFontFamily %>theme-font-{$SiteConfig.MainFontFamily}<% end_if %>">
You can now either manually generated the colour variations in your CSS (class name suffixes),
or you can trawl through the src/scss
folder in either the Bambusa or Watea theme to find out how to use @mixin
in SCSS to achieve that automatically.
Versioning
This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.
All methods, with public
visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected
methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.