Einen Eintrag im Zeilenmenü anlegen
Jede Tabelle des Core hat eine eigene Registry für ihr Zeilenmenü. Ihr Bundle trägt dort einen Eintrag ein, der die Rechnungsnummer in die Zwischenablage kopiert.
Was Sie bauen
Einen Eintrag „Rechnungsnummer kopieren“ im Zeilenmenü der Rechnungsliste.
Voraussetzungen
- Zuerst durcharbeiten: Ein Bundle anlegen
- Node.js und npm, um das Frontend des Bundles zu bauen
- Mindestens eine Rechnung in Ihrer Installation
Schritt 1 von 5
Den Eintrag schreiben
Ein Eintrag im Zeilenmenü ist eine Klasse mit Kennung, Position, Text und einer Aktion.
assets/js/src/modules/invoice/copy-invoice-number-entry.ts
Neue Datei
import i18n from 'i18next'
import { isEmpty } from 'lodash'
import { Copy01Icon } from '@hugeicons-pro/core-duotone-rounded'
import { SimpleTableContextMenuType } from '@vendority/core/data-table'
import type { TableContextMenuActionContext } from '@vendority/core/data-table'
import type { Invoice } from '@VendorityApi/invoice-api-slice.gen'
export class CopyInvoiceNumberEntry extends SimpleTableContextMenuType<Invoice> {
readonly id: string = 'acme-copy-invoice-number'
readonly order: number = 150
readonly label: string = 'acme.invoice.copy-number'
readonly icon = Copy01Icon
isVisible(row: Invoice): boolean {
return !isEmpty(row.invoiceNumber)
}
async onSelect(ctx: TableContextMenuActionContext<Invoice>): Promise<void> {
try {
await navigator.clipboard.writeText(ctx.row.invoiceNumber)
ctx.toast.success(i18n.t('acme.invoice.number-copied'))
} catch {
ctx.toast.error(i18n.t('acme.invoice.copy-failed'))
}
}
}-
1
SimpleTableContextMenuTypeist die Basis für einen Eintrag mit Symbol, Text und Klick. Die Klasse rendert selbst einen Menüpunkt. Nur wenn sie aus@vendority/core/data-tablekommt, passt dieser Menüpunkt in das Menü, das der Core rendert. Eine Kopie aus@vendority/coreoder@Vendority/…bricht das Menü beim Öffnen ab. -
2
Aus demselben Grund prüft der Eintrag Berechtigungen richtig: Die geerbte Methode
isAllowedliest die angemeldete Person aus dem Core. Mitpermissionkönnen Sie den Eintrag an eine Berechtigung knüpfen. -
3
idmuss in der Registry eindeutig sein. Das Präfixacme-verhindert, dass sie mit einer Kennung des Core kollidiert. -
4
ordersortiert die Einträge. „Öffnen“ und „Bearbeiten“ haben 100, „PDF anzeigen“ 110, „Herunterladen“ 120, „Aktivität“ 200. Mit 150 steht Ihr Eintrag zwischen „Herunterladen“ und „Aktivität“. -
5
labelist ein Übersetzungsschlüssel, den der Eintrag selbst mitt()übersetzt. -
6
isVisiblebekommt die Zeile. Wiederkehrende Rechnungen haben keine Nummer, bei ihnen blendetisVisibleden Eintrag aus. -
7
onSelectbekommtctxmit der Zeile inctx.row, dazuctx.toastfür Meldungen,ctx.modalfür Rückfragen,ctx.openTabzum Öffnen eines Reiters,ctx.isMobileundctx.close. GibtonSelectein Promise zurück, zeigt der Eintrag bis zum Ende einen Ladekreis.
Schritt 2 von 5
Den Eintrag registrieren
Ein Modul trägt den Eintrag in die Registry der Rechnungsliste ein.
assets/js/src/modules/invoice/index.ts
Neue Datei
import { container, serviceIds } from '@vendority/core'
import type { AbstractModule, DynamicTypeRegistryAbstract } from '@vendority/core'
import type { AbstractTableContextMenuType } from '@vendority/core/data-table'
import { CopyInvoiceNumberEntry } from './copy-invoice-number-entry'
export const InvoiceMenuModule: AbstractModule = {
onInit: (): void => {
container
.get<DynamicTypeRegistryAbstract<AbstractTableContextMenuType>>(serviceIds['DynamicTypes/Table/ContextMenu/Invoice'])
.registerDynamicType(new CopyInvoiceNumberEntry())
},
}-
1
serviceIds['DynamicTypes/Table/ContextMenu/Invoice']ist die Registry des Zeilenmenüs der Rechnungsliste. Für die anderen Tabellen tauschen Sie das letzte Wort gegenContact,Project,Item,TimeEntry,WorkType,SequenceValue,ProductoderQuantityValue. -
2
Erzeugen Sie den Eintrag mit
new. Mitcontainer.bind(…).to(…)fände der Container des Core Ihre Klasse nicht, weil jede Kopie von inversify ihre eigenen Klassen-Annotationen verwaltet. -
3
Mit
overrideDynamicTypeersetzen Sie einen Eintrag des Core, der dieselbeidhat.removeDynamicTypeentfernt einen Eintrag. -
4
„Deeplink kopieren“ hängt der Core selbst unten an das Menü an. Dafür tragen Sie nichts ein.
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 { InvoiceMenuModule } from './modules/invoice'
…
onStartup: ({ moduleSystem }: { moduleSystem: ModuleSystem }): void => {
moduleSystem.registerModule(HelloModule)
moduleSystem.registerModule(InvoiceMenuModule)
},
}+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 Einträge des Core bereits in der Registry, undoverrideDynamicTypefindet sie.
Schritt 4 von 5
Die Texte übersetzen
Der Eintrag und seine beiden Meldungen brauchen einen Text in allen vier Sprachen.
translations/messages.de.yaml
Geändert
acme.invoice.copy-number: Rechnungsnummer kopieren
acme.invoice.number-copied: Rechnungsnummer kopiert
acme.invoice.copy-failed: Rechnungsnummer konnte nicht kopiert werden+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.en.yaml
Geändert
acme.invoice.copy-number: Copy invoice number
acme.invoice.number-copied: Invoice number copied
acme.invoice.copy-failed: Could not copy the invoice number+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.fr.yaml
Geändert
acme.invoice.copy-number: Copier le numéro de facture
acme.invoice.number-copied: Numéro de facture copié
acme.invoice.copy-failed: Impossible de copier le numéro de facture+3 Zeilen neu · grau: bestehender Code zur Orientierung
translations/messages.it.yaml
Geändert
acme.invoice.copy-number: Copia numero fattura
acme.invoice.number-copied: Numero fattura copiato
acme.invoice.copy-failed: Impossibile copiare il numero fattura+3 Zeilen neu · grau: bestehender Code zur Orientierung
-
1
Gibt es die Dateien im Ordner
translationsIhres Bundles noch nicht, legen Sie sie an. -
2
Die Meldungen enthalten die Nummer bewusst nicht. Werte, die Sie per Platzhalter in einen Text einsetzen, maskiert Vendority für HTML. Ein Schrägstrich in der Nummer stünde in der Meldung dann als Zeichencode da.
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 Eintrag im Zeilenmenü anlegen“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →