trilobit-gmbh/contao-ajaxpagination-bundle

Contao 4 ajax pagination bundle

Installs: 1 762

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 1

Forks: 0

Open Issues: 1

Language:JavaScript

Type:contao-bundle

1.2.0 2021-09-06 19:54 UTC

This package is auto-updated.

Last update: 2021-10-06 20:10:46 UTC


README

Das Ajaxpagination Bundle bietet ihnen die Möglichkeit die Paginierung ihrer Seite via Ajax-Request zu implementieren. Dafür müssen Sie die entsprechenden Templates mit einem Hilfscontainer versehen. Die Erweiterung kommt bereits mit einer Anzahl an Templates, die direkt verwendet werden können.

The Ajaxpagination Bundle offers you the possibility to implement the pagination of your page via Ajax-Request. To do this, you have to provide the appropriate templates with an auxiliary container. The extension already comes with a number of templates which can be used directly.

Aufbau Template

<?php $this->extend('block_unsearchable'); ?>

<?php $this->block('content'); ?>

  <div data-pagination="page_x<?= $this->id ?>">
    <?= $this->data ?>
    <?= $this->pagination ?>
  </div>

<?php $this->endblock(); ?>

Template mit Hilfscontainer / Template with auxiliary container

Enthaltene Templates

(überschreiben die entsprechenden Core-Templates)

  • cal_default
  • cal_mini
  • ce_comments
  • ce_gallery
  • mod_eventlist
  • mod_newslist
  • mod_search

Eigene / Neue Erweiterungen mit der Ajaxpagination nachrüsten

  • Die Paginierungs-Links müssen in einem NAV-Container mit der (auch Teil-) Klasse pagination liegen.
  • Die zu paginierenden Inhalte sowie die Paginierung selbst müssen in einem Hilfscontainer liegen.
  • <div data-pagination="...">
        ...
    </div>
    
  • Dieser Hilfscontainer benötigt eine eindeutige Kennung. Hier bietet sich die ID des verwendeten Elements mit einem Prefix an page_xyz<?php echo $this->id; ?> (Im Bundle wird das Muster des Parameternamen aus dem Paginierungs-Link verwendet).

Installation

  • Installation der Erweiterung via composer: trilobit-gmbh/contao-ajaxpagination-bundle.
  • Um die Installation abzuschließen bitte noch in den fraglichen Themes > Seitenlayouts unter jQuery laden die Option j_ajax-pagination aktivieren.

Konfiguration

Arbeitsmodus

In den Templates kann im umgebenden Container ergänzend der Arbeitsmodus umgeschaltet werden (von "ersetzen" zu "anhängen").

<div data-pagination="..." data-pagination-type="add">
    ...
</div>

Ohne das Attribut data-pagination-type="add" arbeitet die Paginierung wie bisher auch.

Opacity

In den Templates kann im umgebenden Container ergänzend die Transparenz definiert werden (die beim Nachladen gesetzt wird).

<div data-pagination="..." data-pagination-opacity=".25">
    ...
</div>

Ohne das Attribut data-pagination-opacity=".25" arbeitet die Paginierung wie bisher auch.

Auto Scrolling

Weiter kann jetzt im umgebenden Container ergänzend für die Standard-Paginierungs-Einstellung ein Auto Scrolling an den Anfang des paginierten Containers definiert werden.

Über das Attribut data-pagination-scroll="slow" wird das Auto Scrolling aktiviert und die Scrollgeschwindigkeit eingestellt.

Über das Attribut data-pagination-scroll-offset="-25" kann ein Offset für das definiert werden.

<div data-pagination="..." data-pagination-scroll="slow" data-pagination-scroll-offset="-25">
    ...
</div>

Ohne das jeweilige Attribut data-pagination-scroll="slow" bzw data-pagination-scroll-offset="-25" arbeitet die Paginierung wie bisher auch.

Events

Beim blättern werden folgende Events getriggert:

  • hide.pagination.container
  • show.pagination.container

Diese können z. B. für ein individuelles automatisches Scrolling verwendet werden (abweichend vom implementierten Scrolling).

Bspl.:

jQuery('[data-pagination]')
    .on('hide.pagination.container', function (event) {
        let $target = jQuery(event.relatedTarget[0]);

        $target.addClass('in-progress');
    })
    .on('show.pagination.container', function (event) {
        let $target = jQuery(event.relatedTarget[0]);
        let offsetStatic = 10;
        let offsetDynamic = jQuery('#header').outerHeight();

        jQuery('html, body')
            .animate({
                scrollTop: $target.offset().top - offsetStatic - offsetDynamic
            }, 'slow');

        $target.removeClass('in-progress');
    });

Compatibility

  • Contao version ~4.4
  • Contao version ~4.9