codein/ibexa-color-picker

Ibexa Platform color picker field type

Installs: 725

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 2

Forks: 3

Open Issues: 7

Type:ezplatform-bundle

3.0.0 2023-06-16 10:43 UTC

This package is auto-updated.

Last update: 2024-04-16 14:24:47 UTC


README

Symfony bundle that adds color management to Ibexa Platform.

(If you want an eZ Platform 2.5 compatible version of this bundle, check this repository instead : https://github.com/Codein-Labs/ezplatform-color-picker)

Installation

composer require codein/ibexa-color-picker

Activate the bundle in bundles.php

Codein\eZColorPicker\eZColorPickerBundle::class => ['all' => true],

Compile the assets for the admin UI

./bin/console ezplatform:encore:compile

Usage

Default value

You can set a default color for your field. The default color will be proposed to the user if no color is already set. If the field is required, the default color is assigned as default. If not, no color is assigned.

Twig

The default color format rendered in Twig is RGBa. You can pass extra options to ez_render_field.

  • format: RGBa, HEXa, HSVa, RGB, HEX
  • default: default value returned if field is empty. If not set ez_render_field will return an empty string
{{ ez_render_field(content, 'color2', {'parameters': {'format': 'HEX', 'default': 'none'}}) }}

Migration

The method \Codein\eZColorPicker\FieldType\ColorPicker\Type::acceptValue will accept a single string and convert it into a color. Following formats are converted into a valid value object :

HSVa: hsva(0, 86%, 69%, 0.69)
RGBa: rgba(176, 25, 25, 0.69)
HEXa: #B01919B0
RGB: rgb(176, 25, 25)
HEX: #B01919

You can use this feature when writing migrations.

We also provide a color converter service for your needs here.

Acknowledgement

This bundle uses Pickr (https://github.com/Simonwep/pickr) under the MIT Licence.