Saltar para o conteúdo
Verificado

Xuda Slim

O ponto de entrada leve no navegador para o runtime do Xuda, sem necessidade de carregador de projeto.

O Xuda Slim é a superfície leve de escrita e incorporação para o runtime do Xuda. É útil quando quer a datasource reativa, as diretivas, os eventos e as tags estruturais do Xuda, sem partir da estrutura completa de um projeto Xuda CLI.

O Slim continua a ser Xuda, não é um runtime diferente. As expressões continuam a ler campos com @field_name, o runtime continua a trabalhar a partir de documentos de programa do Xuda, e as tags estruturais como xu-single-view e xu-panel continuam a ser importantes. O <template> é suportado, mas não é obrigatório.

Para que serve o Slim

  • páginas HTML escritas à mão com a reatividade do Xuda
  • demonstrações do runtime e documentação
  • widgets incorporáveis ou microsites
  • árvores de runtime project_data geradas
  • adoção progressiva do Xuda sem introduzir primeiro um compilador de código-fonte completo

Os três modos de escrita

Estes modos podem misturar-se: se o Slim receber project_data e a página tiver também tags <template>, os templates são analisados e adicionados a project_data.programs juntamente com ele.

Carregar o runtime

A forma suportada de obter o bundle é o pacote npm público @xuda.io/xuda-runtime-slim-es. Se tiver uma aplicação Xuda implementada, a plataforma serve também o bundle do runtime a partir do domínio da sua própria aplicação em /cdn, com uma versão não minificada em /cdn/debug.

html
<script src="https://xuda.ai/dist/runtime/js/xuda-runtime-slim.js"></script>
Não carregue a partir de um host de desenvolvimento em produção

A tag script acima aponta para um host de desenvolvimento, útil para experimentar o Slim localmente. Uma página implementada deve carregar @xuda.io/xuda-runtime-slim-es, ou servir o bundle a partir do domínio da sua própria aplicação em /cdn.

O construtor

js
new xuda(element?, options?, callback?)
new xuda.xuda(element?, options?, callback?)

Os argumentos são identificados pelo tipo, não pela posição: um elemento, um objeto de opções e uma callback podem ser passados em qualquer ordem.

  • element: o elemento do DOM onde montar. Opcional no Slim: se o omitir, o runtime recorre a document.body e regista um aviso em vez de falhar.
  • options: opções de sessão e de runtime, tratadas abaixo.
  • callback: chamada como callback('xuda_ready', SESSION_ID, SESSION_OBJ) quando a aplicação está pronta.

Para saber que a montagem terminou, o gancho mais fiável é o evento on_mounted em document.body:

js
document.body.addEventListener('on_mounted', () => {
  console.log('Slim page mounted');
}, { once: true });

Opções comuns

Todas as opções abaixo resolvem-se pela mesma cadeia de seis passos: primeiro um parâmetro de consulta do URL, depois um atributo no elemento de raiz, depois options.params[key], depois options[key], depois um cookie e depois o localStorage. É por isso que uma página Slim pode ser reconfigurada a partir de uma query string sem alterar código.

Como saber que o Slim está a funcionar

  • o bundle foi carregado
  • o seu prog_id apresenta algo visível
  • o evento on_mounted é disparado
  • a interface orientada por campos começa a comportar-se de forma reativa

Se as quatro coisas acontecerem, a página está em boa forma. Se nada for apresentado, verifique por ordem: se o bundle foi realmente carregado, se prog_id corresponde a um id de template ou chave de programa reais, se o programa existe em project_data.programs e se o alvo de montagem é um elemento real (ou foi intencionalmente deixado para o recurso ao body).