entidi/silverstripe-togglepaginator

Allow to enable/disable the GridField pagination with one click

0.1.1 2016-02-18 17:03 UTC

Requires

• silverstripe/framework: ~3.1

BSD-2-Clause

• Nicola Fontana

• paginator
• pagination
• silverstripe
• gridfield
• toggle
• GridFieldPaginator

README

A module that provides a GridField component for temporarily switching the pagination on or off. This can be especially useful when used in conjunction with other modules, e.g. I am currently using it with gridfieldmultiselect to execute special actions on a filtered subset of records.

Installation

You can install silverstripe-togglepaginator by hand by dropping the directory tree into your SilverStripe root. No flush or dev/build is required.

If you use composer, execute:

composer require entidi/silverstripe-togglepaginator dev-master

Usage

Just add the component to the grid field you want disable the pagination on, ensuring it is added before GridFieldPaginator, e.g.:

$grid->getConfig()->addComponent(
    new GridFieldTogglePaginator(),
    'GridFieldPaginator'
);

This by default will add a button on the top right corner of every grid field instance (this can be overriden by providing a different target fragment while calling the constructor). This button will toggle between pagination enabled and pagination disabled.

Author

This project has been developed by ntd. Its home page is shared by other SilverStripe modules and themes.

To check out the code, report issues or propose enhancements, go to the dedicated tracker. Alternatively, you can do the same things by leveraging the official github repository.