IDialogService

Ele IDialogService fornece métodos para exibir diálogos modais ao usuário, incluindo prompts de confirmação, mensagens de erro, avisos informativos, notificações de sucesso e avisos, além de diálogos com conteúdo próprio.

Injeção do Serviço

Acesse o serviço de diálogo a partir de qualquer componente. No React, chamada useDialogService() de dentro da árvore encapsulada pelo provedor de diálogo do framework; no Blazor, injetar o serviço via injeção de propriedades. Note que o serviço de diálogo PowerPortalsPro é distinto do serviço de diálogo subjacente FluentUI.

React Blazor

Diálogos de Confirmação

Use ShowConfirmationAsync para pedir ao usuário uma pergunta de sim/não. A propriedade retornada DialogResult.Cancelled é true quando o usuário seleciona a opção secundária (negativa).

React Blazor

Diálogos de Mensagens

Use os seguintes métodos para mostrar diálogos de mensagens de um único botão com diferentes estilos visuais:

  • ShowInfoAsync — Mensagem informativa com ícone neutro.
  • ShowSuccessAsync — Mensagem de sucesso com um ícone verde.
  • ShowWarningAsync — Mensagem de aviso com um ícone amarelo.
  • ShowErrorAsync — Mensagem de erro com um ícone vermelho de erro.
React Blazor

Diálogos com seu próprio conteúdo

ShowDialogAsync mostra conteúdo seu, como um formulário, um seletor ou uma prévia, e retorna o que o diálogo encerra. No Blazor, passe um componente (ou um RenderFragment); no React, passe uma função que renderize o conteúdo. Defina PrimaryText e SecondaryText para os botões que o serviço desenha, ou deixe ambos de fora para conteúdo que desenha seu próprio.

O conteúdo recebe o diálogo em que é mostrado: um IDialogContext em Blazor, recebido como um parâmetro em cascata, e um DialogHandle em React, passado para a função de renderização e disponível em qualquer lugar dentro de . useDialogHandle()Use para fechar com um valor, cancelar, ativar ou desativar o botão primário, ou definir o que o botão primário faz. O que essa ação retorna é o que o diálogo retorna. Retorne KeepOpen (KEEP_OPEN no React) para manter o diálogo aberto, por exemplo, enquanto a entrada ainda não for válida.

React Blazor

Demonstração de Conteúdo Personalizado

Abre um diálogo com um formulário. Salvar mantém o diálogo aberto até que um nome seja inserido, então retorna para a página; Cancelar não retorna nada.

Exemplo de reação Exemplo de Blazor React TypeScript Razor
Renomear...

Parâmetros Comuns

Todos os métodos de diálogo aceitam opcionais title e primaryText parâmetros. Se omitidos, valores padrão localizados são usados. O diálogo de confirmação também aceita um secondaryText parâmetro para o rótulo do botão de cancelar.

Todos os métodos retornam um DialogResult objeto. Para diálogos de confirmação, verifique a Cancelled propriedade para determinar a escolha do usuário. Para diálogos de mensagens, o resultado indica que o diálogo foi descartado.

Demonstração Interativa

Use os controles abaixo para personalizar o título e a mensagem do diálogo, depois clique em qualquer botão para ver o tipo de diálogo correspondente.

Exemplo de reação Exemplo de Blazor React TypeScript Razor
Diálogo de Confirmação de Exibição Mostrar Diálogo de Erro Diálogo de Mostrar Informações Diálogo de Sucesso do Espetáculo Diálogo de Aviso de Mostrar
React Blazor

IDialogService Interface

Propriedades

Nome
Tipo
Padrão
Descrição
OpenDialogCountint
Quantos diálogos este serviço tem abertos atualmente. Apenas seus próprios diálogos — as caixas de mensagem e confirmações levantadas pelos métodos abaixo. Um painel de registros é um diálogo do FluentUI criado pelo serviço deles , então não é contado aqui, e é isso que torna esse número útil para a camada de sobreposição: significa 'um mensagem que o usuário precisa ser capaz de ler e responder', não 'algo em formato de diálogo aberto'.
Nome: OpenDialogCount
Tipo: int
Descrição: Quantos diálogos este serviço tem abertos atualmente. Apenas seus próprios diálogos — as caixas de mensagem e confirmações levantadas pelos métodos abaixo. Um painel de registros é um diálogo do FluentUI criado pelo serviço deles , então não é contado aqui, e é isso que torna esse número útil para a camada de sobreposição: significa 'um mensagem que o usuário precisa ser capaz de ler e responder', não 'algo em formato de diálogo aberto'.

Métodos

Nome
Parâmetros
Tipo
Descrição
ShowConfirmationAsyncstring message
string title
string primaryText
string secondaryText
Task<DialogResult>
Mostra um diálogo de confirmação com os botões fornecidos message e dois de ação, depois espera por o usuário deve escolher um. O retorno Services.DialogResult foi DialogResult.Cancelled definido para Verdade quando o usuário seleciona a opção secundária (negativa).
ShowDialogAsync<TComponent>Action<CustomDialogOptions> configure
IDictionary<string, Object> parameters
Task<DialogResult>
Aparece em um diálogo e espera ele fechar.
ShowErrorAsyncstring message
string title
string primaryText
Task<DialogResult>
Mostra uma caixa de diálogo de erro com o fornecido message e espera o usuário descartá-lo.
ShowInfoAsyncstring message
string title
string primaryText
Task<DialogResult>
Mostra um diálogo informativo com o fornecido message e espera que o usuário o descarte.
ShowSuccessAsyncstring message
string title
string primaryText
Task<DialogResult>
Mostra um diálogo de sucesso com o fornecido message e espera o usuário descartá-lo.
ShowWarningAsyncstring message
string title
string primaryText
Task<DialogResult>
Mostra uma caixa de aviso com o fornecido message e espera o usuário descartá-lo.
Nome: ShowConfirmationAsync
Parâmetros: string message
string title
string primaryText
string secondaryText
Tipo: Task<DialogResult>
Descrição: Mostra um diálogo de confirmação com os botões fornecidos message e dois de ação, depois espera por o usuário deve escolher um. O retorno Services.DialogResult foi DialogResult.Cancelled definido para Verdade quando o usuário seleciona a opção secundária (negativa).
Nome: ShowDialogAsync<TComponent>
Parâmetros: Action<CustomDialogOptions> configure
IDictionary<string, Object> parameters
Tipo: Task<DialogResult>
Descrição: Aparece em um diálogo e espera ele fechar.
Nome: ShowErrorAsync
Parâmetros: string message
string title
string primaryText
Tipo: Task<DialogResult>
Descrição: Mostra uma caixa de diálogo de erro com o fornecido message e espera o usuário descartá-lo.
Nome: ShowInfoAsync
Parâmetros: string message
string title
string primaryText
Tipo: Task<DialogResult>
Descrição: Mostra um diálogo informativo com o fornecido message e espera que o usuário o descarte.
Nome: ShowSuccessAsync
Parâmetros: string message
string title
string primaryText
Tipo: Task<DialogResult>
Descrição: Mostra um diálogo de sucesso com o fornecido message e espera o usuário descartá-lo.
Nome: ShowWarningAsync
Parâmetros: string message
string title
string primaryText
Tipo: Task<DialogResult>
Descrição: Mostra uma caixa de aviso com o fornecido message e espera o usuário descartá-lo.
React Blazor

DialogResult Classe

Propriedades

Nome
Tipo
Padrão
Descrição
Cancelledbool
False
Recebe um valor indicando se o diálogo foi cancelado (por exemplo, o usuário o descartou sem confirmar).
DataObject?
Carga útil opcional de dados retornada pelo diálogo quando ele era fechado.
Nome: Cancelled
Tipo: bool
Padrão: False
Descrição: Recebe um valor indicando se o diálogo foi cancelado (por exemplo, o usuário o descartou sem confirmar).
Nome: Data
Tipo: Object?
Descrição: Carga útil opcional de dados retornada pelo diálogo quando ele era fechado.

Métodos

Nome
Parâmetros
Tipo
Descrição
CancelObject data
DialogResult
Cria um Services.DialogResult que representa um resultado cancelado, opcionalmente carregando uma carga útil de dados.
GetData<T>T?
O valor com o diálogo fechado, como : padrão quando era cancelado, fechado com nada ou fechado com um valor de outro tipo.
Ok<T>T result
DialogResult
Cria um Services.DialogResult que representa um resultado confirmado, carregando result como carga útil de dados.
TryGetData<T>out T value
bool
Lê o valor com o encerramento do diálogo, como .
Nome: Cancel
Parâmetros: Object data
Tipo: DialogResult
Descrição: Cria um Services.DialogResult que representa um resultado cancelado, opcionalmente carregando uma carga útil de dados.
Nome: GetData<T>
Tipo: T?
Descrição: O valor com o diálogo fechado, como : padrão quando era cancelado, fechado com nada ou fechado com um valor de outro tipo.
Nome: Ok<T>
Parâmetros: T result
Tipo: DialogResult
Descrição: Cria um Services.DialogResult que representa um resultado confirmado, carregando result como carga útil de dados.
Nome: TryGetData<T>
Parâmetros: out T value
Tipo: bool
Descrição: Lê o valor com o encerramento do diálogo, como .
React Blazor

CustomDialogOptions Classe

Propriedades

Nome
Tipo
Padrão
Descrição
PreventDismissOnEscapebool
False
Se o Escape é impedido de fechar o diálogo. Padrão false.
PrimaryTextstring?
O rótulo do botão primário. O serviço desenha o botão quando isso está definido; deixe ambos e CustomDialogOptions.SecondaryText não configurado para conteúdo que desenha seus próprios botões. O que é o botão faz é até IDialogContext.OnPrimary.
SecondaryTextstring?
O rótulo do botão secundário. O serviço desenha o botão quando isso é ativado, e cancela O diálogo.
ShowDismissbool
True
Se o cabeçalho mostra um botão de fechar. Padrão true.
Titlestring?
O título do diálogo, mostrado no cabeçalho. Omita para um diálogo sem ele.
Widthstring?
A largura do diálogo como um comprimento CSS, por exemplo, 'min(700px, 90vw)'. Omita no padrão.
Nome: PreventDismissOnEscape
Tipo: bool
Padrão: False
Descrição: Se o Escape é impedido de fechar o diálogo. Padrão false.
Nome: PrimaryText
Tipo: string?
Descrição: O rótulo do botão primário. O serviço desenha o botão quando isso está definido; deixe ambos e CustomDialogOptions.SecondaryText não configurado para conteúdo que desenha seus próprios botões. O que é o botão faz é até IDialogContext.OnPrimary.
Nome: SecondaryText
Tipo: string?
Descrição: O rótulo do botão secundário. O serviço desenha o botão quando isso é ativado, e cancela O diálogo.
Nome: ShowDismiss
Tipo: bool
Padrão: True
Descrição: Se o cabeçalho mostra um botão de fechar. Padrão true.
Nome: Title
Tipo: string?
Descrição: O título do diálogo, mostrado no cabeçalho. Omita para um diálogo sem ele.
Nome: Width
Tipo: string?
Descrição: A largura do diálogo como um comprimento CSS, por exemplo, 'min(700px, 90vw)'. Omita no padrão.
React Blazor

IDialogContext Interface

Propriedades

Nome
Tipo
Padrão
Descrição
OnPrimaryFunc<Task<Object>>?
Executa quando o botão primário desenhado pelo serviço é pressionado. Seu resultado é o que o diálogo retorna, em DialogResult.Data; retorne IDialogContext.KeepOpen para manter o diálogo aberto em vez disso. Desconfigurado, o botão fecha o diálogo sem dados. Enquanto roda, os botões são desativado e o modo Escape não cancela o diálogo (no Blazor Server, a partir de um momento após o clica: o bloco chega ao navegador uma viagem de ida e volta depois). Se ele lançar, o erro é registrado, o diálogo permanece aberto e uma mensagem de erro geral é exibida sobre ele; para falhas que o usuário pode corrigir, diga você mesmo o que deu errado e devolve.IDialogContext.KeepOpen
PrimaryEnabledbool
Se o botão primário puxado pelo serviço pode ser pressionado, por exemplo, apenas uma vez que uma escolha obrigatória é Feito. Padrão true.
Nome: OnPrimary
Tipo: Func<Task<Object>>?
Descrição: Executa quando o botão primário desenhado pelo serviço é pressionado. Seu resultado é o que o diálogo retorna, em DialogResult.Data; retorne IDialogContext.KeepOpen para manter o diálogo aberto em vez disso. Desconfigurado, o botão fecha o diálogo sem dados. Enquanto roda, os botões são desativado e o modo Escape não cancela o diálogo (no Blazor Server, a partir de um momento após o clica: o bloco chega ao navegador uma viagem de ida e volta depois). Se ele lançar, o erro é registrado, o diálogo permanece aberto e uma mensagem de erro geral é exibida sobre ele; para falhas que o usuário pode corrigir, diga você mesmo o que deu errado e devolve.IDialogContext.KeepOpen
Nome: PrimaryEnabled
Tipo: bool
Descrição: Se o botão primário puxado pelo serviço pode ser pressionado, por exemplo, apenas uma vez que uma escolha obrigatória é Feito. Padrão true.

Métodos

Nome
Parâmetros
Tipo
Descrição
CancelAsyncTask
Fecha o diálogo como cancelado, o que retorna Cancel(System.Object).
CloseAsyncObject data
Task
Fecha o diálogo, que retorna DialogResult.Ok`<T>(`<U>) com data.
Nome: CancelAsync
Tipo: Task
Descrição: Fecha o diálogo como cancelado, o que retorna Cancel(System.Object).
Nome: CloseAsync
Parâmetros: Object data
Tipo: Task
Descrição: Fecha o diálogo, que retorna DialogResult.Ok`<T>(`<U>) com data.