Skip to content
Snippets Groups Projects
Commit a0e67c95 authored by Jan-Hendrik Willms's avatar Jan-Hendrik Willms
Browse files

fixes #50

parent 3a18d181
No related branches found
No related tags found
No related merge requests found
Pipeline #17633 passed
...@@ -2,10 +2,11 @@ ...@@ -2,10 +2,11 @@
title: Aktionsmenü title: Aktionsmenü
sidebar_label: Aktionsmenüs sidebar_label: Aktionsmenüs
--- ---
# ActionMenu
Am `ActionMenu` können Aktionsicons in ein ausklappbares Menü zusammengefasst werden. Am `ActionMenu` können Aktionsicons in ein ausklappbares Menü zusammengefasst werden.
## ActionMenu ## PHP
Die Klasse kann direkt innerhalb einer View verwendet werden, weil sie den nötigen HTML-Code generiert und ausgibt. Die Klasse kann direkt innerhalb einer View verwendet werden, weil sie den nötigen HTML-Code generiert und ausgibt.
...@@ -56,3 +57,34 @@ echo $menu->render(); ...@@ -56,3 +57,34 @@ echo $menu->render();
?> ?>
``` ```
## Vue
Die Vue-Komponente wird über das Tag `StudipActionMenu` eingebunden und hat die folgenden Properties:
```json
{
"collapseAt": "Schwellwert, ab dem das Menü als tatsächliches Menü angezeigt wird [Number] (optional)",
"context": "Optional Kontext, der über den Einträgen angezeigt wird [String]",
"items": [],
"title": "Titel des Aktionsmenüs [String] (optional, Default: 'Aktionsmenü')"
}
```
Der Wert für `collapseAt` ist optional und wenn er nicht angegeben wird, wird auf den Stud.IP-Default zurückgegriffen.
Das `items`-Array besteht dabei aus Einträgen des folgendes Formats:
```json
{
"label": "Text des Eintrags [String]",
"url": "URL, die aufgerufen werden soll, wenn der Eintrag ausgewählt wird [String] (optional, default: '#')",
"emit": "Event, der gefeuert werden soll, wenn der Eintrag ausgewählt wird [String] (optional)",
"emitArgument": "Argumente, die dem Event mitgegeben werden sollen, wenn dieser gefeuert wird [Array] (optional)",
"icon": "Icon, das für den Eintrag angezeigt werden soll [Objekt: {shape: String}] oder false, wenn kein Icon angegeben werden soll (optional, default: false)",
"type": "Möglicher Typ des Eintrags: 'link', 'button', 'separator' [String] (optional, default: 'link')",
"name": "Name des Buttons; Eintrag wird hierdurch automatisch zu einem Button, wenn keine 'url' gesetzt ist [String] (optional)",
"classes": "CSS-Klassen, die bei dem Eintrag gesetzt sein sollen [String] (optional)",
"attributes": "Weitere HTML-Attribute, die bei dem Eintrag gesetzt sein sollen [Objekt] (optional)",
"disabled": "Gibt an, ob der Eintrag deaktiviert sein soll [Boolean] (optional)"
}
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment