Você está aqui:
Componentes da Web Lightning personalizados na Grade de entrada de presente na Educação
Entenda como componentes da Web Lightning personalizados movem dados de e para a Grade de entrada de presente.
| EDIÇÕES NECESSÁRIAS |
|---|
| Disponível em: Lightning Experience |
Disponível em: Edições Enterprise, Performance, Unlimited e Developer com Education Cloud Disponível em: Edições Enterprise, Unlimited e Developer com a Nonprofit Cloud |
- Propriedades enviadas a um componente da grade de entrada de presente
A Grade de entrada de presente passa dados de linha para componentes da Web Lightning personalizados por meio da propriedade params para componentes de célula e da propriedade rowData para modals. - Enviar dados de volta à grade de entrada de presente
Os modais de coluna e os componentes de edição de célula usam mecanismos diferentes para retornar dados à Grade de entrada de presente. - Considerações para retornar dados
Ao retornar dados de volta à Grade de entrada de presente, considere estas regras para campos de lista de opções e pesquisa.
Propriedades enviadas a um componente da grade de entrada de presente
A Grade de entrada de presente passa dados de linha para componentes da Web Lightning personalizados por meio da propriedade params para componentes de célula e da propriedade rowData para modals.
| EDIÇÕES NECESSÁRIAS |
|---|
| Disponível em: Lightning Experience |
Disponível em: Edições Enterprise, Performance, Unlimited e Developer com Education Cloud Disponível em: Edições Enterprise, Unlimited e Developer com a Nonprofit Cloud |
| Propriedade | Descrição |
|---|---|
| parames |
|
| rowData |
|
Enviar dados de volta à grade de entrada de presente
Os modais de coluna e os componentes de edição de célula usam mecanismos diferentes para retornar dados à Grade de entrada de presente.
| EDIÇÕES NECESSÁRIAS |
|---|
| Disponível em: Lightning Experience |
Disponível em: Edições Enterprise, Performance, Unlimited e Developer com Education Cloud Disponível em: Edições Enterprise, Unlimited e Developer com a Nonprofit Cloud |
Modais de coluna
Os modais de coluna são renderizados dentro de um componente da Web Lightning wrapper que inclui o título do modal (como definido no modelo), bem como um botão Continuar e Cancelar.
O botão Continuar é o que o usuário clica para fechar seu modal personalizado. Ele chamará estas funções expostas obrigatórias:
| Função | Descrição |
|---|---|
@api validate() |
Retorne um objeto com duas propriedades:
|
@api getComponentValues() |
Retorna um conjunto de propriedades key:value a ser aplicado à linha:
|
Componente Edição de célula
Para retornar dados de volta à Grade de entrada de presente de um componente de edição de célula:
- Crie um objeto como a mensagem para retornar à Grade de entrada de presente.
- Publique um evento no canal de mensagens de
lightning__giftEntryGridComponentAction.
O conteúdo do corpo da mensagem é rígido. Siga a estrutura deste exemplo:
// 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}
}
}
Considerações para retornar dados
Ao retornar dados de volta à Grade de entrada de presente, considere estas regras para campos de lista de opções e pesquisa.
| EDIÇÕES NECESSÁRIAS |
|---|
| Disponível em: Lightning Experience |
Disponível em: Edições Enterprise, Performance, Unlimited e Developer com Education Cloud Disponível em: Edições Enterprise, Unlimited e Developer com a Nonprofit Cloud |
Considerações sobre campos de lista de opções:
- Se os campos da lista de opções forem retornados como uma string simples, o valor deverá representar o nome da API da lista de opções caso o rótulo e o nome da API sejam diferentes.
- Os campos de lista de opções também podem ser retornados como um objeto na forma de
{ value: xx, displayValue: zz }. Aqui está um exemplo:{ giftType: { value: “Organizational”, displayValue: “Organizativo/Doméstico” } }
Considerações sobre o campo de pesquisa:
- Campos de pesquisa que não sejam colunas na Grade de entrada de presente só podem ser retornados como uma string de ID em um objeto de resposta. Por exemplo,
{MyLookupFieldId__c: ‘xxx00000000’} - Os campos de pesquisa que são colunas de campo na Grade de entrada de presente, como Campanha e Código-fonte de alcance, devem ser retornados de um componente da Web Lightning personalizado em um formulário de objeto para garantir que sejam renderizados corretamente na grade. Veja um exemplo:
Campaign: { Id: {campaignId}, Name: {campaignName} }
