kirby-table-field
kirby-table-field copied to clipboard
Published
20 hours ago •
bogdancondorachi
bogdancondorachi
📈 Table field plugin for Kirby CMS
Kirby Table Field
The table field makes possible to effortlessly create and manage tables within the panel. You can easily tailor tables to their specific needs, enhancing the efficiency and management of data presentation.
[!WARNING] The plugin requires Kirby 4. For Kirby 3, you can use v2.1.0 (although without further support)
Installation
Composer
composer require bogdancondorachi/kirby-table-field
Git Submodule
git submodule add https://github.com/bogdancondorachi/kirby-table-field.git site/plugins/table-field
Manual
Download and extract the folder to /site/plugins/table-field
Field Usage
Add the field to your blueprint:
fields:
table:
label: Table
type: table
#optional (see field properties)
Field Properties:
| Name | Type | Default | Description |
|---|---|---|---|
| align | string |
- |
Set the text alignment of the table |
| disabled | bool |
- |
If true, the field is no longer editable and will not be saved |
| duplicate | bool |
true |
Toggles duplicating columns and rows in the table |
| empty | string |
- |
The placeholder text if no rows exists |
| help | string |
- |
Optional help text below the field |
| index | int, bool |
1 |
Specifies the starting index. If set to false, it removes the index column; in this case, sortable would be disabled as well |
| label | string |
- |
Set the label above the field |
| maxColumns | int |
8 |
Set the maximum allowed columns in the table |
| minColumns | int |
2 |
Set the minimum required columns in the table |
| sortable | bool |
true |
Toggles drag & drop sorting |
| translate | bool |
true |
If false, the field will be disabled in non-default languages and cannot be translated. This is only relevant in multi-language setups. |
Use the field in your template:
<?php
$table = $page->table()->toTable();
if (!empty($table['headers']) && !empty($table['rows'])): ?>
<table>
<thead>
<tr>
<?php foreach ($table['headers'] as $header): ?>
<th><?= $header ?></th>
<?php endforeach ?>
</tr>
</thead>
<tbody>
<?php foreach ($table['rows'] as $row): ?>
<tr>
<?php foreach ($row as $cell): ?>
<td><?= $cell ?></td>
<?php endforeach ?>
</tr>
<?php endforeach ?>
</tbody>
</table>
<?php endif ?>
Blocks Usage
Add the block to your blueprint:
fields:
text:
type: blocks
fieldsets:
- table
Blueprint:
name: Table
icon: table
preview: table
fields:
table:
type: table
To overwrite this default blueprint, place your custom file in /site/blueprints/blocks/table.yml
Snippet:
<?php
$table = $block->table()->toTable();
if (!empty($table['headers']) && !empty($table['rows'])): ?>
<table>
<thead>
<tr>
<?php foreach ($table['headers'] as $header): ?>
<th><?= $header ?></th>
<?php endforeach ?>
</tr>
</thead>
<tbody>
<?php foreach ($table['rows'] as $row): ?>
<tr>
<?php foreach ($row as $cell): ?>
<td><?= $cell ?></td>
<?php endforeach ?>
</tr>
<?php endforeach ?>
</tbody>
</table>
<?php endif ?>
To overwrite this default snippet, place your custom file in /site/snippets/blocks/table.php
Credits
- Kirby Team for the table layout.
- Rafael Giezendanner for the initial table-field plugin.
License
MIT License Copyright © 2024 Bogdan Condorachi
bogdancondorachi