Download the PHP package toastnz/colourpalettes without Composer
On this page you can find all versions of the php package toastnz/colourpalettes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download toastnz/colourpalettes
More information about toastnz/colourpalettes
Files in toastnz/colourpalettes
Package colourpalettes
Short Description Silverstripe colour palettes module
License BSD-3-Clause
Informations about the package colourpalettes
ColourPalette Module
This module allows you to manage and use colour palettes in your SilverStripe project.
Installation
To install the module, use Composer:
Adding and editing colours
Colours can be managed in the CMS site config under 'Customisation' -> 'Colour Palettes'. Here you can add, edit and delete colours.
Colour palettes configuration
You can define default colours as well as colour groups in a yml config file. Default colours need to be hex codes without the #, contract colours are more customisable, and can be set to other variables, therefore a # is required if you want to use a hex code.
Adding colour groups will add a listbox to each colour added in the site config, allowing you to assign a colour to a single group or multiple groups.
Colours with a value will be locked and cannot be deleted or edited in the CMS. Groups are optional, but can be used to separate colours into various colour palette fields.
Contrast colours are the colours used when generating the css variables, on-dark will be used if the colour is set to dark, and on-light will be used if the colour is set to light. Makes senses right?
Adding Colour Palette Field to a Class
To add a colour palette field to a class, you can use the following code as an example:
Template usage
To use the colours in your templates, you can use the following code as an example:
Using the colours in your CSS
The colours will automatically generate their own CSS variables based on the name you give them on the class. For example, if you have a colour field called 'PrimaryColour', the following CSS variables will be generated:
Helper functions
Sometimes you just want to know if the colour is light or dark:
All versions of colourpalettes with dependencies
silverstripe/cms Version ^5 || ^6
composer/installers Version *
tractorcow/silverstripe-colorpicker Version dev-master