Skip to content

Commit c42da0a

Browse files
chore: update readme
1 parent c5d1a72 commit c42da0a

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

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

33
# Kirby Table Field
4-
The table field streamlines the management of structured data in tables, offering a user-friendly interface that simplifies data entry and enhances content creation by making tabular information effortlessly manageable.
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.
5+
6+
> [!WARNING]
7+
> Starting from version [v2.2.0](https://github.com/bogdancondorachi/kirby-table-field/releases/tag/v2.2.0), this plugin is compatible only with Kirby 4.<br />
8+
> If you are still using Kirby 3, it's recommended to stick with [v2.1.0](https://github.com/bogdancondorachi/kirby-table-field/releases/tag/v2.1.0) for compatibility.
59
610
## Installation
711

@@ -26,18 +30,24 @@ git submodule add https://github.com/bogdancondorachi/kirby-table-field.git site
2630
```yaml
2731
fields:
2832
table:
29-
label: table
33+
label: Table
3034
type: table
31-
#optional (see props below)
35+
#optional (see field properties)
3236
```
3337

3438
### Field Properties:
35-
| Name | Type | Default | Description |
36-
|:---------- |:--------------------|:------- |:---------------------------------------------------|
37-
| index | `Number`, `Boolean` | `1` | Specifies the starting index. If set to `false`, it removes the index column; in this case, `sortable` also needs to be set to `false` |
38-
| sortable | `Boolean` | `true` | Toggles drag & drop sorting |
39-
| minColumns | `Number` | `2` | Sets the minimum required columns in the table |
40-
| minColumns | `Number` | `5` | Sets the maximum allowed columns in the table |
39+
| Name | Type | Default | Description |
40+
|:-----------|:--------------|:--------|:-----------------------------------------------------------------|
41+
| disabled | `bool` | `-` | If `true`, the field is no longer editable and will not be saved |
42+
| duplicate | `bool` | `true` | Toggles duplicating columns and rows in the table |
43+
| empty | `string` | `-` | The placeholder text if no rows exists |
44+
| help | `string` | `-` | Optional help text below the field |
45+
| index | `int`, `bool` | `1` | Specifies the starting index. If set to `false`, it removes the index column; in this case, `sortable` also needs to be set to `false` |
46+
| label | `string` | `-` | The field label above the field |
47+
| maxColumns | `int` | `5` | Sets the maximum allowed columns in the table |
48+
| minColumns | `int` | `2` | Sets 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 cannot be translated. This is only relevant in multi-language setups. |
4151

4252
### Use the field in your template:
4353
```php
@@ -66,6 +76,7 @@ fields:
6676

6777
## Credits
6878

79+
- [Kirby Team](https://getkirby.com) for the [table](https://github.com/getkirby/kirby/blob/main/panel/src/components/Layout/Table.vue) layout.
6980
- [Rafael Giezendanner](https://github.com/ragi96) for the initial [table-field](https://github.com/ragi96/table-field) plugin.
7081

7182
## License

0 commit comments

Comments
 (0)