UI Components

In der Regel werden Magento® 2 Module mit einer ./etc/adminhtml/system.xml Datei implementiert, welche dazu dient, zusätzliche Konfigurationen unter Stores > Configuration zur Verfügung zu stellen um diverse Funktionen im konfigurierbar zu machen.

Allerdings ist es nicht immer offensichtlich, wo diese zu finden sind. Es kommt vor, dass man solche Einstellungen erst nach Minuten unter Stores > Configuration findet, was unter umständen frustrierend sein kann. Darum möchte ich gerne meine Lösung teilen, welche ich inzwischen in jedem meiner Module implementiere und welche aus meiner Sicht durch jedem Backend-Entwickler in wenigen Minuten implementiert werden kann.

XML Layout

Zuerst muss eine existierende Layout Datei ( zum Beispiel ./view/adminhtml/layout/namespace_module_custom_index.xml ) ergänzt werden.

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
<body>
    <referenceContainer name="content">
        <uiComponent name="namespace_module_custom_index"/>
        <block class="Magento\Framework\View\Element\Template" name="namespace.module.adminhtml.info" template="Namespace_Module::info.phtml"/>
    </referenceContainer>
</body>
</page>

<?xml version="1.0"?>

<body>

</referenceContainer>

</body>

</page>

Innerhalb des Reference Containers content muss folgender Block platziert werden.

<block class="Magento\Framework\View\Element\Template" name="namespace.module.adminhtml.info" template="Namespace_Module::info.phtml"/>

1	<block class="Magento\Framework\View\Element\Template" name="namespace.module.adminhtml.info" template="Namespace_Module::info.phtml"/>

Wichtig hier ist die Referenz zum Template Namespace_Module::info.phtml welche im nächsten Schritt genauer erklärt wird.

Template

Die Referenz Namespace_Module::info.phtml im folgenden Block erwartet eine info.phtml Datei im Verzeichnis ./view/adminhtml/templates/ welche lediglich folgenden HTML Code enthalten sollte.

<div id="namespace-module">
    <p><?php echo __('Go to <a href="%1">Stores > Configuration > Advanced > Admin</a> for module settings.', $this->getUrl('adminhtml/system_config/edit/section/admin')); ?></p>
</div>

<p><?php echo __('Go to <a href="%1">Stores > Configuration > Advanced > Admin</a> for module settings.', $this->getUrl('adminhtml/system_config/edit/section/admin')); ?></p>

</div>

Der Link-Text sowie der Parameter für getUrl muss natürlich noch geändert werden. Mein Beispiel zeigt auf Stores > Configuration > Advanced > Admin.

Cheers

In der Regel werden UI Component Listings mit MassActions und Checkboxen erstellt, so dass in der Übersicht mehrere Elemente mit einer Aktion ( massAction ) gelöscht werden können.

In einigen Fällen braucht es diese Funktion jedoch nicht. Zum Beispiel wenn Datensätze nur hinzugefügt oder geändert werden sollen können, und/oder das Löschen von Datensätzen nur in der Detailansicht möglich sein soll.

Um die oben gezeigte Checkbox zu entfernen muss die XML Datei geöffnet werden, welche das für das neue Listing zuständig ist. Zum Beispiel:

[Namespace]/[Module]/view/adminhtml/ui_component/[namespace]/[module]_listing.xml

1	[Namespace]/[Module]/view/adminhtml/ui_component/[namespace]/[module]_listing.xml

In dieser Datei sollte sich die XML Node selectionColumn befinden, welche ohne weiteres entfernt werden kann.

<selectionsColumn name="ids">
	<argument name="data" xsi:type="array">
		<item name="config" xsi:type="array">
			<item name="resizeEnabled" xsi:type="boolean">false</item>
			<item name="resizeDefaultWidth" xsi:type="string">55</item>
			<item name="indexField" xsi:type="string">id</item>
		</item>
	</argument>
</selectionsColumn>

<item name="resizeEnabled" xsi:type="boolean">false</item>

</item>

</argument>

</selectionsColumn>

An der Stelle genügt es den Magento cache zu leeren um die Änderungen zu sehen.

Tag: UI Components

Magento2 Module mit Konfigurationen verlinken

XML Layout

Template

Checkbox aus UI Component Listing in Magento2 entfernen