Vous êtes ici :
Composants Web Lightning personnalisés dans Grille de saisie de dons dans Nonprofit
Comprenez comment les composants Web Lightning personnalisés déplacent les données depuis et vers la Grille de saisie de dons.
| ÉDITIONS NÉCESSAIRES |
|---|
| Disponible dans : Lightning Experience |
Disponible dans : Enterprise, Performance, Unlimited et Developer Editions avec Education Cloud Disponible avec : Éditions Enterprise, Unlimited et Developer avec Nonprofit Cloud |
- Propriétés envoyées à un composant depuis la grille de saisie de dons
La Grille d'entrée de don transmet les données des lignes aux composants Web Lightning personnalisés via la propriété params pour les composants de cellule et la propriété rowData pour les fenêtres modales. - Renvoi de données à la grille de saisie des cadeaux
Les fenêtres modales de colonne et les composants de modification de cellule utilisent différents mécanismes pour renvoyer des données à la Grille de saisie de dons. - Considérations relatives au renvoi de données
Lorsque vous renvoyez des données à la Grille de saisie de dons, tenez compte des règles ci-dessous pour les champs de liste de sélection et de référence.
Propriétés envoyées à un composant depuis la grille de saisie de dons
La Grille d'entrée de don transmet les données des lignes aux composants Web Lightning personnalisés via la propriété params pour les composants de cellule et la propriété rowData pour les fenêtres modales.
| ÉDITIONS NÉCESSAIRES |
|---|
| Disponible dans : Lightning Experience |
Disponible dans : Enterprise, Performance, Unlimited et Developer Editions avec Education Cloud Disponible avec : Éditions Enterprise, Unlimited et Developer avec Nonprofit Cloud |
| Propriété | Description |
|---|---|
| params |
|
| rowData |
|
Renvoi de données à la grille de saisie des cadeaux
Les fenêtres modales de colonne et les composants de modification de cellule utilisent différents mécanismes pour renvoyer des données à la Grille de saisie de dons.
| ÉDITIONS NÉCESSAIRES |
|---|
| Disponible dans : Lightning Experience |
Disponible dans : Enterprise, Performance, Unlimited et Developer Editions avec Education Cloud Disponible avec : Éditions Enterprise, Unlimited et Developer avec Nonprofit Cloud |
Fenêtres modales de colonne
Les modales de colonne sont restituées dans un composant Web Lightning wrapper qui inclut le titre modal (tel que défini dans le modèle) ainsi qu'un bouton Continuer et Annuler.
Le bouton Continuer permet à l'utilisateur de cliquer pour fermer votre fenêtre modale personnalisée. Il appellera les fonctions exposées requises suivantes :
| Fonction | Description |
|---|---|
@api validate() |
Renvoyez un objet avec deux propriétés :
|
@api getComponentValues() |
Renvoie un ensemble de propriétés key:value à appliquer à la ligne :
|
Composant Modifier la cellule
Pour renvoyer des données à la Grille de saisie de dons à partir d'un composant de modification de cellule :
- Construisez un objet en tant que message pour revenir à la Grille de saisie de dons.
- Publiez un événement dans le canal de messagerie
lightning__giftEntryGridComponentAction.
Le contenu du corps du message est strict. Suivez la structure de cet exemple :
// Build the "message" object to send back to
// Gift Entry Grid following the documented contract
const message = {
// Required properties (do not change the values below)
action: "ColumnEdit",
componentName: this.tagName,
colId: this._params?.colDef?.colId,
// 'details' is an optional property:
// - include if there is data to write to the row
// in Gift Entry
details: {
// rowId and rowIndex must be included in details
rowId: this.params?.data?.id, // Required
rowIndex: this.params?.data?.rowIndex, // Required
// All GiftEntry fields to write to rowData
// and as object in a key:value collection.
// To clear the value of a field on the GiftEntry rowData
// object, return null instead of undefined
giftEntryFields : { key: value, ... },
// rowProperties is optional, but if passed can be
// referenced by other custom components. Data in this
// object are not persisted to the GiftEntry record.
rowProperties: { key : value, ... },
// Special Use: If your custom column component is
// forcing a matched gift transaction, use these
// properties to send the matching transaction ID
// and NAME back to grid for proper handling:
matchingGiftTransactionId: {giftTransactionId},
matchingGiftTransactionName: {giftTransactionName}
}
}
Considérations relatives au renvoi de données
Lorsque vous renvoyez des données à la Grille de saisie de dons, tenez compte des règles ci-dessous pour les champs de liste de sélection et de référence.
| ÉDITIONS NÉCESSAIRES |
|---|
| Disponible dans : Lightning Experience |
Disponible dans : Enterprise, Performance, Unlimited et Developer Editions avec Education Cloud Disponible avec : Éditions Enterprise, Unlimited et Developer avec Nonprofit Cloud |
Considérations relatives aux champs de liste de sélection :
- Si les champs de liste de sélection sont renvoyés sous forme de chaîne simple, la valeur doit représenter le nom d'API de la liste de sélection si l'étiquette et le nom d'API sont différents.
- Les champs de liste de sélection peuvent également être renvoyés en tant qu'objet sous forme de
{ value: xx, displayValue: zz }. Exemple :{ giftType: { value: “Organizational”, displayValue: “Organizativo/Doméstico” } }
Considérations relatives aux champs de référence :
- Les champs de référence qui ne sont pas des colonnes dans la Grille de saisie de don peuvent être renvoyés uniquement sous forme de chaîne d'ID dans un objet de réponse. Par exemple,
{MyLookupFieldId__c: ‘xxx00000000’} - Les champs de référence qui sont des colonnes de champ dans la Grille de saisie de dons, par exemple Campagne et Code source de diffusion, doivent être renvoyés depuis un composant Web Lightning personnalisé sous forme d'objet pour s'assurer qu'ils sont correctement restitués dans la grille. Exemple :
Campaign: { Id: {campaignId}, Name: {campaignName} }
