Einen Bereich in der Seitenleiste anlegen
Sie melden eine Seite als Reiter an und legen dazu einen Eintrag in der Navigation an. Ihr Bereich steht dann unter „Alle Bereiche“, und jede Person kann ihn in ihre Seitenleiste heften.
Was Sie bauen
Einen Bereich „Acme“ mit eigener Seite, der unter „Alle Bereiche“ › „Werkzeuge“ steht und sich als Reiter öffnet.
Voraussetzungen
- Zuerst durcharbeiten: Ein Bundle anlegen
- Node.js und npm, um das Frontend des Bundles zu bauen
Schritt 1 von 5
Die Seite schreiben
Was im Reiter erscheint, ist eine gewöhnliche React-Komponente.
assets/js/src/pages/acme-page.tsx
Neue Datei
import { useTranslation } from 'react-i18next'
import { Page } from '@Vendority/components/page/page'
import { PageHeaderTitle } from '@Vendority/components/page/page-header-title'
export const ACME_SCREEN = 'acme-overview'
export const AcmePage = (): React.JSX.Element => {
const { t } = useTranslation()
return (
<Page>
<PageHeaderTitle>{t('acme.overview.title')}</PageHeaderTitle>
<p className="text-sm text-muted-foreground">{t('acme.overview.intro')}</p>
</Page>
)
}-
1
ACME_SCREENist die Kennung des Reiters. Sie brauchen sie im nächsten Schritt zweimal: für den Reiter und für den Eintrag in der Navigation. -
2
PageundPageHeaderTitlekommen aus dem Core. Ihre Seite hat damit denselben Rand und dieselbe Überschrift wie die Seiten des Core. -
3
useTranslationimportieren Sie direkt ausreact-i18next. Ihr Bundle und der Core teilen sich dieses Paket, deshalb findett()auch die Texte Ihres Bundles. -
4
Klassen wie
text-smundtext-muted-foregrounderzeugt der Core bereits. Klassen, die nur Ihr Bundle braucht, schreiben Sie mit dem Präfixacme:.
Schritt 2 von 5
Reiter und Eintrag registrieren
Ein Modul meldet die Seite als Reiter an und legt den Eintrag für die Navigation an.
assets/js/src/modules/acme/index.ts
Neue Datei
import i18n from 'i18next'
import { PuzzleIcon } from '@hugeicons-pro/core-duotone-rounded'
import { container, serviceIds } from '@vendority/core'
import type { AbstractModule, MainNavRegistry, TabComponentRegistry } from '@vendority/core'
import { ACME_SCREEN, AcmePage } from '../../pages/acme-page'
export const AcmeModule: AbstractModule = {
onInit: (): void => {
const tabRegistry = container.get<TabComponentRegistry>(serviceIds.tabComponentRegistry)
const mainNavRegistry = container.get<MainNavRegistry>(serviceIds.mainNavRegistry)
tabRegistry.registerComponent({
id: ACME_SCREEN,
component: AcmePage,
tabNameGenerator: (): string => i18n.t('acme.overview.title'),
icon: PuzzleIcon,
})
mainNavRegistry.registerMainNavItem({
id: 'acme',
label: 'acme',
icon: PuzzleIcon,
url: '/acme',
componentId: ACME_SCREEN,
area: 'tools',
order: 900,
})
},
}-
1
containerundserviceIdsliefern die Registries des Core. Der Container liegt aufwindow.Vendority, deshalb bekommt Ihr Bundle dieselben Instanzen wie der Core. -
2
registerComponentmeldetAcmePageals Reiter an.tabNameGeneratorliefert den Titel auf dem Reiter,icondas Symbol davor. -
3
registerMainNavItemlegt den Eintrag in der Navigation an.labelist kein fertiger Text, sondern das Ende eines Übersetzungsschlüssels: Vendority liestcomponents.sidebar.item.acme. -
4
componentIdbestimmt, welcher Reiter sich beim Klick öffnet.urlist im Typ ein Pflichtfeld, zum Öffnen verwendet Vendority es nicht. -
5
arealegt fest, unter welcher Überschrift der Eintrag in „Alle Bereiche“ steht:salesist „Verkauf“,workist „Arbeit & Team“,toolsist „Werkzeuge“. Innerhalb eines Bereichs sortiertorder; „Designer“ aus dem Core hat 700. -
6
Mit
permissionan Reiter und Eintrag sehen beides nur Personen, die diese Berechtigung haben.
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 { AcmeModule } from './modules/acme'
…
onStartup: ({ moduleSystem }: { moduleSystem: ModuleSystem }): void => {
moduleSystem.registerModule(HelloModule)
moduleSystem.registerModule(AcmeModule)
},
}+2 Zeilen neu · grau: bestehender Code zur Orientierung
-
1
onStartupbekommt das Modulsystem des Core als Argument. Verwenden Sie genau dieses. EinmoduleSystem, das Sie selbst importieren, ist eine Kopie in Ihrem Bundle, die der Core nie startet. -
2
Der Core ruft
onInitaller Module erst auf, wenn jedes Plugin seine Module angemeldet hat. Die Module des Core kommen dabei zuerst an die Reihe.
Schritt 4 von 5
Die Texte übersetzen
Jeder Schlüssel, den Seite, Reiter und Eintrag verwenden, braucht einen Text in allen vier Sprachen.
translations/messages.de.yaml
Geändert
components.sidebar.item.acme: Acme
acme.overview.title: Acme
acme.overview.intro: Dieser Bereich gehört zum Acme-Bundle.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.en.yaml
Geändert
components.sidebar.item.acme: Acme
acme.overview.title: Acme
acme.overview.intro: This area belongs to the Acme bundle.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.fr.yaml
Geändert
components.sidebar.item.acme: Acme
acme.overview.title: Acme
acme.overview.intro: Cet espace fait partie du bundle Acme.+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.it.yaml
Geändert
components.sidebar.item.acme: Acme
acme.overview.title: Acme
acme.overview.intro: "Quest'area fa parte del 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. Symfony liest sie von dort automatisch ein. -
2
Nach der Anmeldung lädt Vendority nur die Texte der Sprache, die die Person eingestellt hat. Fehlt ein Schlüssel in dieser Sprache, zeigt die Oberfläche den Schlüssel selbst an, auch wenn es ihn auf Englisch gibt.
-
3
components.sidebar.item.acmeist der Name in der Navigation,acme.overview.titleder Titel von Reiter und Seite.
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 Bereich in der Seitenleiste anlegen“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →