Einen Reiter in den Einstellungen anlegen
Die Einstellungen bestehen aus Reitern, die Module in einer Registry anmelden. Ihr Bundle legt dort einen eigenen Reiter mit einer eigenen Seite an.
Was Sie bauen
Einen Reiter „Acme“ in den Einstellungen, der die Karte „Acme-Einstellungen“ zeigt.
Voraussetzungen
- Zuerst durcharbeiten: Ein Bundle anlegen
- Node.js und npm, um das Frontend des Bundles zu bauen
Schritt 1 von 5
Die Seite schreiben
Der Inhalt des Reiters ist eine React-Komponente ohne Props.
assets/js/src/pages/acme-settings-page.tsx
Neue Datei
import { useTranslation } from 'react-i18next'
import { Card } from '@Vendority/components/card/card'
import { CardContent } from '@Vendority/components/card/card-content'
import { CardHeader } from '@Vendority/components/card/card-header'
import { CardTitle } from '@Vendority/components/card/card-title'
export const AcmeSettingsPage = (): React.JSX.Element => {
const { t } = useTranslation()
return (
<Card>
<CardHeader>
<CardTitle>{t('acme.settings.title')}</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm text-muted-foreground">{t('acme.settings.intro')}</p>
</CardContent>
</Card>
)
}-
1
Die Seite rendert nur ihren Inhalt. Die Reiterleiste und den Rand darum stellt der Core.
-
2
Card,CardHeader,CardTitleundCardContentsind die Karten, aus denen auch die Einstellungen des Core bestehen. -
3
Die beiden Schlüssel für
t()legen Sie in Schritt 4 an.
Schritt 2 von 5
Den Reiter registrieren
Ein Modul meldet die Seite als Reiter der Einstellungen an.
assets/js/src/modules/settings/index.ts
Neue Datei
import { Settings02Icon } from '@hugeicons-pro/core-duotone-rounded'
import { container, serviceIds } from '@vendority/core'
import type { AbstractModule, SettingsTabRegistry } from '@vendority/core'
import { AcmeSettingsPage } from '../../pages/acme-settings-page'
export const SettingsModule: AbstractModule = {
onInit: (): void => {
const settingsTabRegistry = container.get<SettingsTabRegistry>(serviceIds['Settings/TabRegistry'])
settingsTabRegistry.registerTab({
id: 'acme',
label: 'acme.settings.tab',
icon: Settings02Icon,
order: 850,
component: AcmeSettingsPage,
})
},
}-
1
serviceIds['Settings/TabRegistry']liefert die Registry mit den Reitern der Einstellungen. -
2
labelist der vollständige Übersetzungsschlüssel, die Einstellungen geben ihn unverändert ant()weiter. -
3
orderbestimmt die Position in der Reiterleiste. Der Core belegt die Werte 100 bis 700, von „Allgemein“ bis „Updates“. Wählen Sie einen Wert, den kein anderer Reiter verwendet. Haben zwei Reiter denselben Wert, steht der zuerst registrierte vorne. -
4
componentist die Seite aus Schritt 1,icondas Symbol neben dem Namen.
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 { SettingsModule } from './modules/settings'
…
onStartup: ({ moduleSystem }: { moduleSystem: ModuleSystem }): void => {
moduleSystem.registerModule(HelloModule)
moduleSystem.registerModule(SettingsModule)
},
}+2 Zeilen neu · grau: bestehender Code zur Orientierung
-
1
onStartupbekommt das Modulsystem des Core als Argument. Verwenden Sie genau dieses, kein selbst importiertesmoduleSystem. -
2
Die Module des Core laufen vor Ihren. Wenn
onInitIhres Moduls läuft, stehen die Reiter des Core bereits in der Registry.
Schritt 4 von 5
Die Texte übersetzen
Reiter, Kartentitel und Beschreibung brauchen einen Text in allen vier Sprachen.
translations/messages.de.yaml
Geändert
acme.settings.tab: Acme
acme.settings.title: Acme-Einstellungen
acme.settings.intro: Hier stellen Sie das Acme-Bundle ein.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.en.yaml
Geändert
acme.settings.tab: Acme
acme.settings.title: Acme settings
acme.settings.intro: Configure the Acme bundle here.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.fr.yaml
Geändert
acme.settings.tab: Acme
acme.settings.title: Paramètres Acme
acme.settings.intro: Configurez ici le bundle Acme.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.it.yaml
Geändert
acme.settings.tab: Acme
acme.settings.title: Impostazioni Acme
acme.settings.intro: Configura qui il bundle Acme.+3 Zeilen 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 ein Schlüssel dort, zeigt die Oberfläche den Schlüssel selbst.
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 Reiter in den Einstellungen anlegen“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →