Skip to content

Commit c026b86

Browse files
chore: update readme
1 parent 46c1bea commit c026b86

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
![Kirby Table Field](./.github/preview.png)
22

3-
# Kirby Table Field
4-
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.
3+
[![Version](https://img.shields.io/badge/version-2.4.0-8dbae7.svg?style=for-the-badge)](https://github.com/bogdancondorachi/kirby-table-field/releases)
4+
[![Dependency](https://img.shields.io/badge/kirby-4.0--4.x-f0d575.svg?style=for-the-badge)](https://getkirby.com/)
5+
[![Donate](https://img.shields.io/badge/support-buy_me_a_coffee-bdde7a.svg?style=for-the-badge)](https://github.com/sponsors/bogdancondorachi)
6+
7+
> [!NOTE]
8+
> 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.
59
610
## Installation
711

@@ -32,23 +36,20 @@ fields:
3236
```
3337

3438
### Field Properties:
35-
| Name | Type | Default | Description |
36-
|:-----------|:----------------|:--------|:---------------------------------------------------------------------|
37-
| align | `string` | `-` | Set the text alignment of the table |
38-
| disabled | `bool` | `-` | If `true`, the field is no longer editable and will not be saved |
39-
| duplicate | `bool` | `true` | Toggles duplicating columns and rows in the table |
40-
| empty | `string` | `-` | The placeholder text if no rows exists |
41-
| help | `string` | `-` | Optional help text below the field |
42-
| index | `int`, `bool` | `1` | Specifies the starting index. If set to `false`, it removes the index
43-
column; in this case, `sortable` would be disabled as well |
44-
| label | `string` | `-` | Set the label above the field |
45-
| marks | `bool`, `array` | `true` | Set the allowed HTML formats. Activate/deactivate them all by passing
46-
`true`/`false` |
47-
| maxColumns | `int` | `8` | Set the maximum allowed columns in the table |
48-
| minColumns | `int` | `2` | Set the minimum required columns in the table |
49-
| sortable | `bool` | `true` | Toggles drag & drop sorting |
50-
| translate | `bool` | `true` | If `false`, the field will be disabled in non-default languages and
51-
cannot be translated. This is only relevant in multi-language setups. |
39+
| Name | Type | Default | Description |
40+
|:-----------|:----------------|:--------|:-----------------------------------------------------------------|
41+
| align | `string` | `-` | Set the text alignment of the table |
42+
| disabled | `bool` | `-` | If `true`, the field is no longer editable and will not be saved |
43+
| duplicate | `bool` | `true` | Toggles duplicating columns and rows in the table |
44+
| empty | `string` | `-` | The placeholder text if no rows exists |
45+
| help | `string` | `-` | Optional help text below the field |
46+
| 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 |
47+
| label | `string` | `-` | Set the label above the field |
48+
| marks | `bool`, `array` | `true` | Set the allowed HTML formats. Activate/deactivate them all by passing `true`/`false` |
49+
| maxColumns | `int` | `8` | Set the maximum allowed columns in the table |
50+
| minColumns | `int` | `2` | Set the minimum required columns in the table |
51+
| sortable | `bool` | `true` | Toggles drag & drop sorting |
52+
| 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. |
5253

5354
### Use the field in your template:
5455
```php
@@ -128,10 +129,10 @@ if (!empty($table['headers']) && !empty($table['rows'])): ?>
128129
```
129130
To overwrite this default snippet, place your custom file in `/site/snippets/blocks/table.php`
130131

131-
## Credits
132+
## Buy me a coffee ☕
132133

133-
- [Kirby Team](https://getkirby.com) for the [table](https://github.com/getkirby/kirby/blob/main/panel/src/components/Layout/Table.vue) layout.
134-
- [Rafael Giezendanner](https://github.com/ragi96) for the initial [table-field](https://github.com/ragi96/table-field) plugin.
134+
> [!NOTE]
135+
> This plugin is provided free of charge & published under the permissive MIT License. If you're using it for a commercial project or just want to help keep it alive, please consider [donating](https://github.com/sponsors/bogdancondorachi). Your support fuels future development!
135136

136137
## License
137138

0 commit comments

Comments
 (0)