rasteiner/k3-pagesdisplay-section

This package is abandoned and no longer maintained. No replacement package was suggested.

K3 plugin: display any page list in a section. Any parent, many parents, filtered, don't care.

0.2.4 2022-12-15 13:27 UTC

Requires

• getkirby/cms: ^3.7.2
• getkirby/composer-installer: ^1.2

ISC

• Roman Steiner

README

Display any page list in a section using Kirby's query language. Any parent, many parents, filtered, don't care.

ℹ️ Note: While this functionality gives you a lot of freedom, you won't be able to sort the list or add new pages to the query.

Installation

Download

Download and copy this repository to /site/plugins/k3-pagesdisplay-section.

Git submodule

git submodule add https://github.com/rasteiner/k3-pagesdisplay-section.git site/plugins/k3-pagesdisplay-section

Composer

composer require rasteiner/k3-pagesdisplay-section

Usage

Create a section of your liking and add a query property. Within the query you may select and filter any pages by making use of Kirby's query language.

You can start the query with one of the following variables:

• site
• page (refers to the current page)
• pages (which equals site.pages)
• kirby (mainly to use with kirby.collection)

Example

All pages with Foo in their title

sections:
  mysection:
    headline: Foo Pages
    type: pagesdisplay
    query: site.index.filterBy('title', '*=', 'Foo')

Sibling pages (exclude the current page)

sections:
  mysection:
    headline: Siblings
    type: pagesdisplay
    query: page.siblings(false)

Disable Controls

In addition to leaving the controls (the status flag and the options dropdown) visible - the default, it's possible to either hide them completely or show only the status flag.

To completely hide the controls:

sections:
  mysection:
    headline: Siblings
    type: pagesdisplay
    query: page.siblings(false)
    controls: false

To show only the status flag:

sections:
  mysection:
    headline: Siblings
    type: pagesdisplay
    query: page.siblings(false)
    controls: flag