Download the PHP package swiegmann/kirby-index-block without Composer

On this page you can find all versions of the php package swiegmann/kirby-index-block. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kirby-index-block

Kirby Index Block

This plugin displays individual index-pages with a variety of options such as:

Current translations:

Prerequisites

Installation

Download

Download and copy this repository to /site/plugins/kirby-index-block.

Git submodule

Composer

Usage

Add the block-type index to your layout/block-blueprints. Add a block, select "Index". The frontend should display already an unformatted index. You can start applying css to it, and that may already be sufficient to your needs.

However, you can read on and customize the plugin.

Options

Property Default Description
filterPath /site/helpers/index-block/filters (string) path to custom filter files
snippetPath /site/snippets/index-block (string) path to custom snippet files
paginationCurrentPageCssClass active (string) css-class for the current pagination page
paginationUrlArgument p (string) url-argument for generated navigation- & pagination-links

Overwrite all values in /site/config/config.php.

Appy filters, sorting, etc. to the results

  1. Create a php-file in: /site/helpers/index-block/filters. Note: This path is a plugin-option, you can override it.

  2. The file will receive the current result-set of pages with the variable name $entries. It is an instance of Kirby\Cms\Pages, you can apply all methods of $pages to it. The file must return the variable, it must end with: return $entries. Note: You can return also a variable type of Kirby\Cms\Files by using the relevant $pages-methods. So the result can be regular files or images.

  3. In the block-section "Pages" click "Apply filter file" and select the file from the list. Note: The result-set that the filter-file receives is from the exact position in the panel, which is the actual "Apply filter file"-field. Everything below that field can override your filter again (especially sorting).

Customize the default view of list and entries

Copy the snippet-files from:

to:

and edit it.

Customize the view of a single block instance

Copy the snippet-files from:

to:

Note: The destination path is a plugin-option, you can override it.

Edit the files. In the block-section "Snippet" enable "overwrite" and select the files.

Add own list and entry fields to the block

Copy the blueprint-files from:

to:

and add your own fields to the blueprints. The new fields appear below the default list/entry fields.

Add own tabs to the block

Copy the blueprint-file from:

to:

and add your own tabs to the blueprint.

License

MIT License Copyright © 2024-present swiegmann

All versions of kirby-index-block with dependencies

PHP Build Version
Package Version
Requires php Version >=8.3.8
getkirby/composer-installer Version ^1.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package swiegmann/kirby-index-block contains the following files

Loading the files please wait ...