micschk/silverstripe-groupable-gridfield

This module allows drag & drop grouping of items in a GridField

1.0 2020-07-18 09:03 UTC

Requires

• silverstripe/vendor-plugin: ^1.0
• symbiote/silverstripe-gridfieldextensions: ^3

Requires (Dev)

• phpunit/phpunit: ^5.7
• squizlabs/php_codesniffer: *

Suggests

• micschk/silverstripe-block_enhancements: Enhancements to the Silverstripe Blocks module

MIT

• Restruct web & apps

• silverstripe
• gridfield
• groups

README

This module allows drag & drop grouping of items in a GridField. It bolts on top of- and depends on GridFieldOrderableRows for the drag & drop sorting functionality

Screenshot

Example application (Block Enhancements module): assign content blocks to block-areas by drag & drop

Installation

Composer

composer require micschk/silverstripe-groupable-gridfield

Requirements (all pulled in by composer)

• SilverStripe Framework ~4.0
• SilverStripe GridFieldExtensions

Usage:

$grid = new GridField(
    'ExampleGrid',
    'Example Grid',
    $this->Items(),
    $gfConfig = GridFieldConfig::create()
        ->addComponent(new GridFieldToolbarHeader())
        ->addComponent(new GridFieldTitleHeader())
        ->addComponent(new GridFieldEditableColumns())
        ->addComponent(new GridFieldOrderableRows())
        ->addComponent(new GridFieldFooter())
);
// add Groupable (example from BlockEnhancements module)
$gfConfig->addComponent(new GridFieldGroupable(
        'BlockArea',    // The fieldname to set the Group
        'Area',   // A description of the function of the group
        'none',         // A title/header for items without a group/unassigned
        array(          // List of available values for the Group field
            'BeforeContent' => 'Before Content',
            'AfterContent' => 'Before Content',
        )
    ));

Thank you

TITLE WEB SOLUTIONS for sponsoring the isolation of this module out of Blocks Enhancements