brocessing / kirby-previewfiles

:muscle: A Kirby field to enable file thumbnail preview in the panel sidebar

Kirby Preview Files

Enable file thumbnail preview in the panel sidebar

Installation

Use one of the alternatives below.

1. Using kirby-webpack

Simply use the built-in Kirby Package Manager by running:

$ npm run kirby:add
$ [?] Git URL: https://github.com/brocessing/kirby-previewfiles
$ [?] Module name: previewfiles
$ [?] Category: fields

2. Kirby CLI

If you are using the Kirby CLI you can install this plugin by running the following commands in your shell:

$ cd path/to/kirby
$ kirby plugin:install brocessing/kirby-previewfiles

3. Clone or download

1. Clone or download this repository.
2. Unzip the archive if needed and rename the folder to previewfiles.

Make sure that the plugin folder structure looks like this:

site/fields/previewfiles/

4. Git Submodule

If you know your way around Git, you can download this plugin as a submodule:

$ cd path/to/kirby
$ git submodule add https://github.com/brocessing/kirby-previewfiles site/fields/previewfiles

Setup

Blueprint

To enable file preview for a given page, add the following code to its blueprint:

fields:
  previewfiles:
    type: previewfiles

Requirements

• Kirby 2.0+

Disclaimer

This field is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this field in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.