Einen UI-Slot füllen
Slots sind benannte Stellen, an denen der Core Komponenten aus Bundles rendert. Sie füllen den Slot im Benutzermenü und sehen dabei, welche Props ein Slot an Ihre Komponente übergibt.
Was Sie bauen
Einen Menüpunkt „Acme-Hilfe“ im Benutzermenü, den nur Administratoren sehen.
Voraussetzungen
- Zuerst durcharbeiten: Ein Bundle anlegen
- Node.js und npm, um das Frontend des Bundles zu bauen
Schritt 1 von 5
Den Menüpunkt schreiben
Der Slot im Benutzermenü erwartet pro Eintrag einen einzelnen Menüpunkt.
assets/js/src/components/acme-help-menu-item/acme-help-menu-item.tsx
Neue Datei
import { HelpCircleIcon } from '@hugeicons-pro/core-duotone-rounded'
import { HugeiconsIcon } from '@hugeicons/react'
import { DropdownMenuItem } from '@vendority/core/data-table'
import { useTranslation } from 'react-i18next'
const HELP_URL = 'https://acme.example/hilfe'
export const AcmeHelpMenuItem = (props: Record<string, unknown>): React.JSX.Element | null => {
const { t } = useTranslation()
if (props.isAdmin !== true) {
return null
}
return (
<DropdownMenuItem onSelect={(): void => { window.open(HELP_URL, '_blank', 'noopener') }}>
<HugeiconsIcon icon={HelpCircleIcon} />
{t('acme.user-menu.help')}
</DropdownMenuItem>
)
}-
1
Der Slot
sidebar.user-menuübergibt jedem Eintrag zwei Props:userIdundisAdmin. Ihre Komponente wird in Ihrem Bundle gebaut und vom Core gerendert, TypeScript kann die Props also nicht prüfen. Deshalb der TypRecord<string, unknown>und der Vergleich mit=== true. -
2
Gibt die Komponente
nullzurück, erscheint an dieser Stelle nichts. So sehen nur Administratoren den Menüpunkt. -
3
DropdownMenuItemmuss aus@vendority/core/data-tablekommen. Das Menü rendert der Core. Ein Menüpunkt aus einer Kopie in Ihrem Bundle findet dieses Menü nicht, und das Menü bricht beim Öffnen mit einem Fehler ab. -
4
onSelectläuft beim Klick und öffnet hier die Hilfeseite in einem neuen Browser-Tab.
Schritt 2 von 5
Den Slot füllen
Ein Modul trägt die Komponente in den Slot ein.
assets/js/src/modules/user-menu/index.ts
Neue Datei
import { container, serviceIds } from '@vendority/core'
import type { AbstractModule, SlotRegistry } from '@vendority/core'
import { AcmeHelpMenuItem } from '../../components/acme-help-menu-item/acme-help-menu-item'
// Entspricht SlotName.SidebarUserMenu im Core
const SIDEBAR_USER_MENU = 'sidebar.user-menu'
export const UserMenuModule: AbstractModule = {
onInit: (): void => {
container.get<SlotRegistry>(serviceIds.slotRegistry).register(SIDEBAR_USER_MENU, {
id: 'acme-help',
component: AcmeHelpMenuItem,
})
},
}-
1
registernimmt den Namen des Slots und einen Eintrag mitidundcomponent. Registriert ein anderes Modul später dieselbeid, ersetzt es Ihren Eintrag. -
2
Mit
orderlegen Sie die Reihenfolge innerhalb eines Slots fest, kleinere Zahlen zuerst. Ohneorderbleibt es bei der Reihenfolge der Registrierung. -
3
Alle Slots des Core stehen mit ihren Props in
SlotNameinslot-names.ts. Schreiben Sie den Namen als Text, funktioniert der Eintrag mit jeder Version von@vendority/core, die in Ihrem Bundle installiert ist.
Schritt 3 von 5
Das Modul anmelden
Das Plugin meldet sein Modul beim Start der Anwendung an.
assets/js/src/plugins.ts
Geändert
import '../../css/plugin.css'
import type { ModuleSystem, VendorityPlugin } from '@vendority/core'
import { HelloModule } from './modules/hello'
import { UserMenuModule } from './modules/user-menu'
…
onStartup: ({ moduleSystem }: { moduleSystem: ModuleSystem }): void => {
moduleSystem.registerModule(HelloModule)
moduleSystem.registerModule(UserMenuModule)
},
}+2 Zeilen neu · grau: bestehender Code zur Orientierung
-
1
onStartupbekommt das Modulsystem des Core als Argument. Verwenden Sie genau dieses, kein selbst importiertesmoduleSystem. -
2
Der Core ruft
onIniterst auf, wenn alle Plugins ihre Module angemeldet haben. Wenn jemand das Menü öffnet, ist Ihr Eintrag bereits registriert.
Schritt 4 von 5
Den Text übersetzen
Der Menüpunkt braucht seinen Text in allen vier Sprachen.
translations/messages.de.yaml
Geändert
acme.user-menu.help: Acme-Hilfe+1 Zeile neu · grau: bestehender Code zur Orientierung
translations/messages.en.yaml
Geändert
acme.user-menu.help: Acme help+1 Zeile neu · grau: bestehender Code zur Orientierung
translations/messages.fr.yaml
Geändert
acme.user-menu.help: Aide Acme+1 Zeile neu · grau: bestehender Code zur Orientierung
translations/messages.it.yaml
Geändert
acme.user-menu.help: Guida Acme+1 Zeile neu · grau: bestehender Code zur Orientierung
-
1
Gibt es die Dateien im Ordner
translationsIhres Bundles noch nicht, legen Sie sie an. -
2
Vendority lädt nur die Texte der Sprache, die die Person eingestellt hat. Fehlt der Schlüssel dort, steht im Menü
acme.user-menu.help.
Schritt 5 von 5
Bauen und ansehen
Nach dem Build lädt Vendority die neue Fassung Ihres Bundles.
Terminal
Befehl
npm run buildTerminal
Befehl
docker compose exec -T php php bin/console cache:clear-
1
npm run buildführen Sie im OrdnerassetsIhres Bundles aus. Den OrdnerpublicIhres Bundles hatassets:install --symlinkim Tutorial „Ein Bundle anlegen“ verlinkt, deshalb lädt Vendority den neuen Build ohne weiteren Befehl. -
2
cache:clearführen Sie im Ordner Ihrer Vendority-Installation aus. In der Umgebungdevliest Symfony geänderte Übersetzungen auch ohne diesen Befehl ein, inproderst danach. -
3
Laden Sie Vendority danach im Browser neu.
Geschafft.
Sie haben „Einen UI-Slot füllen“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →