diff --git a/docs/md/projektkonfig/collections/fields/widgets.md b/docs/md/projektkonfig/collections/fields/widgets.md index 18f5bf1..232be14 100644 --- a/docs/md/projektkonfig/collections/fields/widgets.md +++ b/docs/md/projektkonfig/collections/fields/widgets.md @@ -1,41 +1,178 @@ # Widgets -Das im _tibi-admin_ für die Ein- und Ausgabe von Daten zu verwendente Widget wird über die Feldkonfiguration `meta.widget` festgelegt. Die Angabe erfolgt als String mit dem Widget-Namen. +Die Verwendung von Widgets innerhalb der Anwendung tibi-admin dient zur Handhabung von Dateninputs und -outputs. Das genutzte Widget wird über das meta.widget Feld in der Konfiguration spezifiziert. Dabei wird der Name des Widgets als Textzeichenkette (String) angegeben. -Nicht jedes Widget kann mit jedem Datentyp umgehen, die möglichen Datentypen werden aber nachfolgend bei jedem Widget erwähnt. Außerdem wird auf individuelle Konfigurationsmöglichkeiten eingegangen. +Es ist zu beachten, dass nicht jedes Widget für jeden Datentyp geeignet ist. Im Weiteren werden die kompatiblen Datentypen für jedes Widget aufgeführt. Zusätzlich werden spezielle Konfigurationsmöglichkeiten für jedes Widget erläutert. -## string / text / input +## Texteingabefeld-Widgets: string / text / input -## number / int / integer / float / double +Diese Bezeichnungen stehen alle für dasselbe Widget. Es handelt sich hierbei um ein Texteingabefeld. Dieses Widget wird für den Datentyp String verwendet. Sollte ein größeres Textfeld (Textarea) anstatt eines einfachen Eingabefeldes (Input) gewünscht sein, so kann dies erreicht werden, indem das Attribut multiline im inputProps Objekt auf true gesetzt wird. -## boolean / bool / check / switch / checkbox +```yaml +- name: firstname + type: string + meta: + label: { de: "Vorname", en: "firstname" } + inputProps: + multiline: true +``` -## select / selectArray +## Numerische Eingabefeld-Widgets: number / int / integer / float / double -Diese beiden sind eigentlich auch einfach nur unterschiedliche Namen für dasselbe widget, da intern die differenzierung zwischen anhand davon getroffen wird, ob im Datentyp ein "[]" am Ende ist oder nicht. Vorgesehen ist aber natürlich selectArray für string array Datentypen und select für einen normalen String. Es sind (aktuell) nur Strings möglich, da