#ctx.modal

Uma API de atalho baseada no Ant Design Modal, usada para abrir ativamente caixas modais (avisos de informação, pop-ups de confirmação, etc.) no RunJS. É implementada pelo ctx.viewer / sistema de visualização.

#Casos de Uso

Nota: ctx.modal está disponível em ambientes RunJS com um contexto de visualização (como JSBlocks dentro de uma página, fluxos de trabalho, etc.); pode não existir no backend ou em contextos sem interface de usuário (UI). Recomenda-se usar o encadeamento opcional (ctx.modal?.confirm?.()) ao chamá-lo.

#Definição de Tipo

modal: {
  info: (config: ModalConfig) => Promise<void>;
  success: (config: ModalConfig) => Promise<void>;
  error: (config: ModalConfig) => Promise<void>;
  warning: (config: ModalConfig) => Promise<void>;
  confirm: (config: ModalConfig) => Promise<boolean>;  // Retorna true se o usuário clicar em OK, false se cancelar
};

ModalConfig é consistente com a configuração dos métodos estáticos do Modal do Ant Design.

#Métodos Comuns

#Parâmetros de Configuração

Consistente com o Modal do Ant Design, os campos comuns incluem:

#Relação com ctx.message e ctx.openView

#Exemplos

#Modal de Informação Simples

ctx.modal.info({
  title: 'Aviso',
  content: 'Operação concluída',
});

#Modal de Confirmação e Controle de Fluxo

const confirmed = await ctx.modal.confirm({
  title: 'Confirmar Exclusão',
  content: 'Tem certeza de que deseja excluir este registro?',
  okText: 'Confirmar',
  cancelText: 'Cancelar',
});
if (!confirmed) {
  ctx.exit();  // Encerra as etapas subsequentes se o usuário cancelar
  return;
}
await ctx.runAction('destroy', { filterByTk: ctx.record?.id });

#Modal de Confirmação com onOk

await ctx.modal.confirm({
  title: 'Confirmar Envio',
  content: 'As alterações não poderão ser modificadas após o envio. Deseja continuar?',
  async onOk() {
    await ctx.form.submit();
  },
});

#Aviso de Erro

try {
  await someOperation();
  ctx.modal.success({ title: 'Sucesso', content: 'Operação concluída' });
} catch (e) {
  ctx.modal.error({ title: 'Erro', content: e.message });
}

#Relacionado

• ctx.message: Aviso temporário leve, desaparece automaticamente
• ctx.exit(): Comumente usado como if (!confirmed) ctx.exit() para encerrar o fluxo quando um usuário cancela a confirmação
• ctx.openView(): Abre uma visualização personalizada, adequado para interações complexas