The files section can be used to show any combination of files for the current page or any other page in your site.
For simple sections that are only used once per blueprint, you can use shortcuts. In its most basic form, a
files section consists of the section type as name, and
true as its value.
This will add a
files section with all default properties.
These shortcuts can be extended with other section properties as needed, for example:
Keep in mind that the same section name can only be used once per blueprint.
The files section has multiple options to control what kind of files should be displayed, how they should be displayed and what happens if a new file is uploaded.
||–||Columns config for
|empty||–||Sets the text for the empty state box|
||Enables/disables reverse sorting|
|headline||–||The headline for the section. This can be a simple string or a template with additional info from the parent page.|
|help||–||Sets the help text|
|image||–||Image options to control the source and look of preview|
|info||–||Optional info text setup. Info text is shown on the right (lists, cardlets) or below (cards) the title.|
|label||–||The label for the section. This can be a simple string or a template with additional info from the parent page.|
||Sets the number of items per page. If there are more items the pagination navigation will be shown at the bottom of the section.|
||–||Sets the maximum number of allowed entries in the section|
||–||Sets the minimum number of required entries in the section|
||–||Sets the default page for the pagination. This will overwrite default pagination.|
||–||Sets the query to a parent to find items for the list|
||Enable/disable the search in the sections|
||The size option controls the size of cards. By default cards are auto-sized and the cards grid will always fill the full width. With a size you can disable auto-sizing. Available sizes:
||–||Overwrites manual sorting and sorts by the given field and sorting direction (i.e.
||Enables/disables manual sorting|
||–||Filters all files by template and also sets the template, which will be used for all uploads|
||Setup for the main text in the list or cards. By default this will display the filename.|
The label will be displayed above the files section. You can pass a simple headline as a string or you can provide translations for multiple languages, if you have an international editing team.
You can inject information from the current page into the label with template placeholders using our query language.
The files can either be displayed as a simple list or as cards with preview images. The list view is the default view.
list layout is perfect for file types without thumbnails like PDFs, excel files, or any other docs. It can also be quite helpful for long galleries that would take up too much space as cards.
card layout is great for all kinds of images.
cardlets layout is great for nice visual previews of files, while your text content is still representend decently.
The table layout has the highest information density. Columns can be fully customized and make it perfect if you need to show multiple values at once for better overview and scannability.
The table layout will show the preview image together with a title and info column based on your text and info settings. You can switch off those automatic columns with
text: false and
info: false if you want to introduce your own columns.
Custom table columns can be defined with the
Each column can be customized with additional settings:
Text alignment can be left (default), center or right.
The column width can be set via the
width property. You can use the usual fractions:
By default, the table cells contain the field value matching the column name. You can customize the value with a string template.
Values are converted to safe HTML by default. This is the most secure way to handle content in your Panel. If you know what you are doing and you want to render HTML in a table cell, you can use the html option to stop HTML from being auto-encoded.
mobile option to
true for a column to be visible in the mobile view.
So far we offer three different column types, you can use to improve the preview of your data.
||This is the standard column type|
||If the value is a URL, you can convert the value to a link with this type|
||If the value is a comma-separated list of values or an array, you can use this type to show the value as tags.|
You can fine-tune the display text and additional information for every file in the list with the
By default the filename is shown in the list for every file. You can use our template syntax with query language to fetch any information from the file and display that instead of the filename.
If you want to display additional information for each file, like a caption, category or any other field value, you can use the template syntax with query language in the
If you want to restrict what types of files can be uploaded to the given section, assign a file template using the
template property. In your file template, set the
accept option. See the docs about file blueprints.
By default, Kirby supports the following files types.
To upload file types not supported out of the box by Kirby, you can register new file types with the
fileTypes extension in a plugin.
The (preview) image for each item in the list is configured with the
Whether or not the image will cover the available space.
A freely definable image ratio.
You are not limited to the example ratios above. In fact, Kirby calculates the ratio for you as long as you enter it in the format
Set an image background.
empty option you can define the message which is displayed when no files are listed in the section.
By default, the current page is being used as the parent to find files for the list. With this option, any page on your site can be the parent of the section.
You can define which template each file in the list must have. This
template option will also be applied to any new file that gets uploaded. Blueprints for file templates can be setup in
You can sort the list of files by a given field in descending or ascending order.
You can pass PHP sorting type flags, for example to make sorting work with special language specific characters.
sortBy option will automatically switch off manual sorting.
You can switch off manual sorting entirely with the
flip option to enable/disable reverse sorting (default is
limit property sets how many files will be shown per page. If there are more entries in the section, the pagination navigation will be shown at the bottom of the section.
You can define a maximum number of files, that will be allowed in this section. After the maximum is reached, the upload button will be hidden and no more files can be uploaded.
You can also define the minimum number of files, that need to be added in order to make the parent page valid.
Like conditional fields, sections can be shown/hidden based on the value of a given field (i.e. if a toggle is checked, a select field is at a certain option, etc.).
The condition for displaying the section is set with the
when option. In the
when option you define a field name as the key and the required value of that field. In the following example, the each section type is shown based on a different value of the
Section search is disabled by default. You can use the
search option to enable it.
Through a section, you upload files to a page, either the current page or another parent page. Contrary to a files field, the file does not become part of the content, i.e. it is not referenced in the content file.
If you assign a file template to a particular section, you can filter by this template when fetching files in the frontend.
Assuming a files section like the following which uploads images to the current page and assigns a template called
You can then fetch those files in the frontend like this: