From 8f6bd9ab400ef39b437d6350f369839eb5fc4e57 Mon Sep 17 00:00:00 2001 From: Pedro Domingues Date: Thu, 9 Nov 2023 16:27:22 -0300 Subject: [PATCH] =?UTF-8?q?docs(page-dynamic-edit):=20otimiza=20os=20exemp?= =?UTF-8?q?los=20de=20utiliza=C3=A7=C3=A3o=20via=20rota?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../po-page-dynamic-edit.component.ts | 27 +++++++++++++------ 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/projects/templates/src/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.component.ts b/projects/templates/src/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.component.ts index ad5dcc783..7a08b4d1f 100644 --- a/projects/templates/src/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.component.ts +++ b/projects/templates/src/lib/components/po-page-dynamic-edit/po-page-dynamic-edit.component.ts @@ -87,16 +87,14 @@ export const poPageDynamicEditLiteralsDefault = { * * ### Utilização via rota * - * Ao utilizar as rotas para carregar o template, o `page-dynamic-edit` disponibiliza propriedades para - * poder especificar o endpoint dos dados e dos metadados. Exemplo de utilização: + * Ao utilizar as rotas para inicializar o template, o `page-dynamic-edit` disponibiliza propriedades que devem ser fornecidas no arquivo de configuração de rotas da aplicação, para + * poder especificar o endpoint dos dados e dos metadados que serão carregados na inicialização. * - * O componente primeiro irá carregar o metadado da rota definida na propriedade serviceMetadataApi - * e depois irá buscar da rota definida na propriedade serviceLoadApi - * - * > Caso o servidor retornar um erro ao recuperar o metadados, será repassado o metadados salvo em cache, - * se o cache não existe será disparado uma notificação. + * Exemplo de utilização: * + * Arquivo de configuração de rotas da aplicação: `app-routing.module.ts` * ``` + * const routes: Routes = [ * { * path: 'people', * component: PoPageDynamicEditComponent, @@ -105,9 +103,22 @@ export const poPageDynamicEditLiteralsDefault = { * serviceMetadataApi: 'http://localhost:3000/v1/metadata', // endpoint dos metadados utilizando o método HTTP Get * serviceLoadApi: 'http://localhost:3000/load-metadata' // endpoint de customizações dos metadados utilizando o método HTTP Post * } - * } + * }, + * { + * path: 'home', + * component: HomeExampleComponent + * } + * ]; * * ``` + * O componente primeiro irá carregar o metadado da rota definida na propriedade serviceMetadataApi + * e depois irá buscar da rota definida na propriedade serviceLoadApi. + * + * A requisição dos metadados é feita na inicialização do template para buscar os metadados da página passando o + * tipo do metadado esperado e a versão cacheada pelo browser. + * + * > Caso o servidor retornar um erro ao recuperar os metadados, serão repassados os metadados salvos em cache, + * se o cache não existir será disparada uma notificação. * * Para carregar com um recurso já existente, deve-se ser incluído um parâmetro na rota chamado `id`: *