https://github.com/ntd/silverstripe-togglepaginator

A GridField component that provides a way to enable/disable the pagination
https://github.com/ntd/silverstripe-togglepaginator

gridfield module silverstripe silverstripe-module

Last synced: about 1 year ago
JSON representation

A GridField component that provides a way to enable/disable the pagination

• Host: GitHub
• URL: https://github.com/ntd/silverstripe-togglepaginator
• Owner: ntd
• License: bsd-2-clause
• Created: 2015-08-10T07:36:56.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-02-19T14:43:17.000Z (over 10 years ago)
• Last Synced: 2025-02-15T23:42:01.885Z (over 1 year ago)
• Topics: gridfield, module, silverstripe, silverstripe-module
• Language: PHP
• Homepage:
• Size: 13.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
SilverStripe Toggle-Paginator

=============================

[![Code Quality](https://scrutinizer-ci.com/g/ntd/silverstripe-togglepaginator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/ntd/silverstripe-togglepaginator/?branch=master)

[![Latest Stable Version](https://poser.pugx.org/entidi/silverstripe-togglepaginator/v/stable)](https://packagist.org/packages/entidi/silverstripe-togglepaginator)

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](https://github.com/markguinn/silverstripe-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](https://getcomposer.org/), 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](mailto:ntd@entidi.it). Its

[home page](http://silverstripe.entidi.com/) is shared by other

[SilverStripe](http://www.silverstripe.org/) modules and themes.

To check out the code, report issues or propose enhancements, go to the

[dedicated tracker](http://dev.entidi.com/p/silverstripe-togglepaginator).

Alternatively, you can do the same things by leveraging the official

[github repository](https://github.com/ntd/silverstripe-togglepaginator).