pixelpoems/silverstripe-selection-field

Silverstripe Module that provides a selection field for the CMS.

1.1.0 2024-04-16 13:17 UTC

Requires

• php: >=7.4
• heyday/silverstripe-colorpalette: ^2.1.0
• silverstripe/cms: >=4
• silverstripe/framework: >=4
• silverstripe/vendor-plugin: >=1

Requires (Dev)

• phpunit/phpunit: ^5.7

BSD-3-Clause

• Bettina Bröthaler

• silverstripe
• field

README

This module provides a selection field wich is based on color palate field by heyday.

• Requirements
• Installation
• Usage
• Reporting Issues
• Credits

Requirements

• Silverstripe CMS >=4.0
• Silverstripe Framework >=4.0
• Versioned Admin >=1.0
• Silverstripe Color Palette Field ^2.1

Installation

composer require pixelpoems/silverstripe-selection-field

Usage

Based on: SilverStripe\Forms\OptionsetField and Heyday\ColorPalette\Fields\ColorPaletteField

private static $db = [
    'Alignment' => 'Varchar',
];

private static $defaults = [
    'Alignment' => 'left',
];

public function getCMSFields()
{
    $fields = parent::getCMSFields();

    $fields->addFieldsToTab('Root.Main', [

        SelectionField::create(
           $name = 'Alignment',
           $title = 'Alignment',
           $source = [
                'left' => [
                    'Value' => 'left',
                    'Title' => _t('LayoutOptions.Left', "Left"),
                    'ShowTitle' => true,
                    'Icon' => 'align-left'
                ],
                'center' => [
                    'Value' => 'center',
                    'Title' => _t('LayoutOptions.Center', "Center"),
                    'ShowTitle' => true,
                    'Icon' => 'align-center'
                ],
                'right' => [
                    'Value' => 'right',
                    'Title' => _t('LayoutOptions.Right', "Right"),
                    'ShowTitle' => true,
                    'Icon' => 'align-right'
                ],
                $value = 'left'
        );

    ]);
}

To display Icons you need to reference Font Awesome Icons (Free & Solid): https://fontawesome.com Use the name of the icon without the fa- prefix. e.g. align-left for fa-align-left.

If no Icon is defined within the array, the box will display the title! You can define an alternative box content when you define "Content" within Options. Furthermore you can define an image link:

'medium' => [
    'Value' => 'medium',
    'Title' => _t('LayoutOptions.Medium', 'Medium'),
    'ShowTitle' => true,
    'Content' => 'M',
    'ImgLink' => '/assets/medium.png'
],

If you defined an icon and an image link, the image link will be ignored. Based on hierarchy the icon will be displayed first, then the image link and then the content - if nothing is defined, the title will be displayed.

If you use ImgLink, you can let the user upload the images to a predefined folder. You can use the Icon Selection Service, which comes with this module, to provide the images to the user. You can use the following code to provide the images:

private static array $db = [
    'IconID' => 'Varchar'
];

public function getCMSFields()
{
    $fields = parent::getCMSFields();

    $fields->addFieldsToTab('Root.Main', [
        SelectionField::create('IconID', 'Icon', IconSelectionService::getIconOptions())
    ]);

    return $fields;
}

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.

Credits

Icons from Font Awesome
Selection Field is based on Heyday's Color Palette Field