Einen Bereich in der Seitenleiste anlegen

5 Schritte·ca. 15 Min.·Einsteiger·Stand: September 2026

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

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. 1

    ACME_SCREEN ist 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. 2

    Page und PageHeaderTitle kommen aus dem Core. Ihre Seite hat damit denselben Rand und dieselbe Überschrift wie die Seiten des Core.

  3. 3

    useTranslation importieren Sie direkt aus react-i18next. Ihr Bundle und der Core teilen sich dieses Paket, deshalb findet t() auch die Texte Ihres Bundles.

  4. 4

    Klassen wie text-sm und text-muted-foreground erzeugt der Core bereits. Klassen, die nur Ihr Bundle braucht, schreiben Sie mit dem Präfix acme:.

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. 1

    container und serviceIds liefern die Registries des Core. Der Container liegt auf window.Vendority, deshalb bekommt Ihr Bundle dieselben Instanzen wie der Core.

  2. 2

    registerComponent meldet AcmePage als Reiter an. tabNameGenerator liefert den Titel auf dem Reiter, icon das Symbol davor.

  3. 3

    registerMainNavItem legt den Eintrag in der Navigation an. label ist kein fertiger Text, sondern das Ende eines Übersetzungsschlüssels: Vendority liest components.sidebar.item.acme.

  4. 4

    componentId bestimmt, welcher Reiter sich beim Klick öffnet. url ist im Typ ein Pflichtfeld, zum Öffnen verwendet Vendority es nicht.

  5. 5

    area legt fest, unter welcher Überschrift der Eintrag in „Alle Bereiche“ steht: sales ist „Verkauf“, work ist „Arbeit & Team“, tools ist „Werkzeuge“. Innerhalb eines Bereichs sortiert order; „Designer“ aus dem Core hat 700.

  6. 6

    Mit permission an 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. 1

    onStartup bekommt das Modulsystem des Core als Argument. Verwenden Sie genau dieses. Ein moduleSystem, das Sie selbst importieren, ist eine Kopie in Ihrem Bundle, die der Core nie startet.

  2. 2

    Der Core ruft onInit aller 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. 1

    Gibt es die Dateien im Ordner translations Ihres Bundles noch nicht, legen Sie sie an. Symfony liest sie von dort automatisch ein.

  2. 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. 3

    components.sidebar.item.acme ist der Name in der Navigation, acme.overview.title der 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 build
Terminal Befehl
docker compose exec -T php php bin/console cache:clear
  1. 1

    npm run build führen Sie im Ordner assets Ihres Bundles aus. Den Ordner public Ihres Bundles hat assets:install --symlink im Tutorial „Ein Bundle anlegen“ verlinkt, deshalb lädt Vendority den neuen Build ohne weiteren Befehl.

  2. 2

    cache:clear führen Sie im Ordner Ihrer Vendority-Installation aus. In der Umgebung dev liest Symfony geänderte Übersetzungen auch ohne diesen Befehl ein, in prod erst danach.

  3. 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 →