From 39784aa9199062a79b103eed986603e0961b27f4 Mon Sep 17 00:00:00 2001 From: robin Date: Fri, 16 Jun 2023 16:05:25 +0000 Subject: [PATCH] t --- api/collections/medialib.yml | 2 +- docs/md/projektkonfig/collections/fields.md | 4 ++++ docs/md/projektkonfig/collections/meta.md | 3 ++- docs/md/projektkonfig/dashboard.md | 13 +++++++++++-- 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/api/collections/medialib.yml b/api/collections/medialib.yml index 30e1a26..e9296c4 100644 --- a/api/collections/medialib.yml +++ b/api/collections/medialib.yml @@ -29,7 +29,7 @@ meta: defaultValue: eval: | (function(){ - return "Title" + $namespace + return "Title" + $file.name })() diff --git a/docs/md/projektkonfig/collections/fields.md b/docs/md/projektkonfig/collections/fields.md index 3e806f5..e27a7fa 100644 --- a/docs/md/projektkonfig/collections/fields.md +++ b/docs/md/projektkonfig/collections/fields.md @@ -138,6 +138,10 @@ containerProps: Wenn man das Input element direkt bearbeiten möchte (Bspw. readonly oder ähnliches), so kann man diese hier als Objekt übergeben: +## hide + +möchte man, dass ein bestimmtes Feld nicht im TibiAdmin sichtbar ist, so muss man die property hide auf true setzen. + ```yaml inputProps: { readonly: true, placeholder: { de: "Wert wird automatisch gesetzt", en: "Value is set automatically" } } ``` diff --git a/docs/md/projektkonfig/collections/meta.md b/docs/md/projektkonfig/collections/meta.md index ad34e87..3f814de 100644 --- a/docs/md/projektkonfig/collections/meta.md +++ b/docs/md/projektkonfig/collections/meta.md @@ -11,6 +11,7 @@ Folgende Angaben sind möglich: `views` werden für die Darstellung der Kollektion-Daten im _tibi-admin_ benötigt. Die Auswahl des passenden View erfolgt über CSS Media-Queries. Optionale Unternavigationen können eigene `views` haben. +Möchte man, dass in der view selection Navbar vor den View namen bestimme Icons angezeigt werden, so kann man diese einfach per muiIcon im jeweiligen View Objekt angeben. Folgende möglche Einträge für `views` gibt es derzeit: @@ -60,6 +61,6 @@ Wird die `tablist` verwendet, ist sicher zu stellen, dass alle Felder in der Def ## multiupload -Der mutliupload kann bei jedem view type verwendet werden. Hier ist eine Beispielscollection, welchen diesen verwendet. +Der mutliupload kann bei jedem view type verwendet werden. Über $file kann man in eval auf das aktuelle file Objekt zugreifen. Hier ist eine Beispielscollection, welchen diesen verwendet. !!!include(../api/collections/medialib.yml)!!! diff --git a/docs/md/projektkonfig/dashboard.md b/docs/md/projektkonfig/dashboard.md index b53a7a0..42d7c6d 100644 --- a/docs/md/projektkonfig/dashboard.md +++ b/docs/md/projektkonfig/dashboard.md @@ -2,7 +2,7 @@ # Übersicht -Die bereitgestellte Konfiguration ist eine Spezifikation für ein Dashboard-Layout und seine Komponenten. Dieses Layout bestimmt die Anzeige und Interaktion von verschiedenen Datenvisualisierungen, vor allem in Form von Diagrammen (Graphen). Die Konfiguration ist in zwei Hauptabschnitte unterteilt: "majorItems" und "minorItems". Die "majorItems" sind größere, prominentere Darstellungen von Daten, während die "minorItems" kleinere, weniger prominente Datenelemente repräsentieren. Jedes Element innerhalb dieser Abschnitte ist ein einzelnes Modul oder eine Komponente auf dem Dashboard und kann verschiedene Arten von Datenvisualisierungen darstellen, einschließlich Linien-, Balken-, Kreis- (donut) und Flächendiagramme. Generell ist zu sagen, dass bei jeder string angabe auch I18n verwendet werden kann und bei nahezu jeder String angabe ist ebenfalls die eval angabe möglich. +Die bereitgestellte Konfiguration ist eine Spezifikation für ein Dashboard-Layout und seine Komponenten. Dieses Layout bestimmt die Anzeige und Interaktion von verschiedenen Datenvisualisierungen, vor allem in Form von Diagrammen (Graphen). Die Konfiguration ist in zwei Hauptabschnitte unterteilt: "majorItems" und "minorItems". Die "majorItems" sind größere, prominentere Darstellungen von Daten, während die "minorItems" kleinere, weniger prominente Datenelemente repräsentieren. Jedes Element innerhalb dieser Abschnitte ist ein einzelnes Modul oder eine Komponente auf dem Dashboard und kann verschiedene Arten von Datenvisualisierungen darstellen, einschließlich Linien-, Balken-, Kreis- (donut) und Flächendiagramme. Generell ist zu sagen, dass bei jeder string angabe auch I18n verwendet werden kann und bei nahezu jeder String angabe ist ebenfalls die eval angabe möglich. Sollten Nutzer keinen Zugriff auf die Daten haben dürfen, so wird das bestimmte Diagramm nicht gerendert und stattdessen ein Placeholder mit Zugriff verweigert angezeigt. # Elementbeschreibungen @@ -129,7 +129,11 @@ switch (input) { ## until -Dieses Feld definiert den Endpunkt des Zeitintervalls für die Datenvisualisierung. Mögliche Werte sind "lastWeek", “lastMonth”, “lastYear” und "allTime", welches jedoch default ist. Zum Beispiel, wenn until auf "lastMonth" gesetzt ist, wird das Diagramm Daten bis zum letzten Monat anzeigen. Außerdem sind alle Optionen darunter für den Nutzer auswählbar. Um dies zu unterbinden, muss das filter attribut auf false gesetzt werden. +Dieses Feld definiert den Endpunkt des Zeitintervalls für die Datenvisualisierung. Mögliche Werte sind "lastWeek", “lastMonth”, “lastYear” und "allTime", welches jedoch default ist. Zum Beispiel, wenn until auf "lastMonth" gesetzt ist, wird das Diagramm maximal Daten bis zum letzten Monat anzeigen. Außerdem sind alle Optionen darunter für den Nutzer auswählbar. Um dies zu unterbinden, muss das filter attribut auf false gesetzt werden. + +## defaultUntil + +Dieses Attribut setzt den default Filter. Es ist anzumerken, dass mit jedem Filter change eine Neue Request einhergeht, und immer mit dem aktuellem Filter requested wird, dieser sollte also ggf. für perfomance per default niedrig gesetzt werden. ## filter @@ -163,6 +167,10 @@ Dies ist das Feld, das den Zeitstempel in der Datensammlung repräsentiert. Es w gibt an wie viele Elemente maximal returned werden sollen. +## newPageRef + +boolean, wenn explizit auf false, dann wird bei type reference kein Neue Seite hinzufügen button angezeigt. + # Code Beispiel ```yaml @@ -497,6 +505,7 @@ dashboard: - collection: contact_form subNavigation: 0 - collection: contact_form + newPageRef: false ``` ![Resultierende Dashboard](dashboard.png)