Adicionado documentação dos componentes de Vitruvio.

2026-05-14 11:32:24 -03:00
parent dbe669d03e
commit 7410422af7
79 changed files with 8180 additions and 0 deletions
@@ -0,0 +1,73 @@
+export type VitruvioComponentDoc = {
+   component: string;
+   summary: string;
+   status: "draft" | "review" | "ready";
+   context: {
+      module: string;
+      family: string;
+      mappedFrom: string[];
+      occurrences: {
+         total: number;
+         paineis: number;
+         processos: number;
+      };
+   };
+   sections: {
+      purpose: string;
+      basicUsage: string;
+      properties: string[];
+      propertyValues: { [property: string]: string[] };
+      propertyValueTypes: { [property: string]: "boolean" | "enum" | "numeric" | "text" | "mixed" };
+      events: string[];
+      examples: string[];
+      notes: string[];
+   };
+};
+
+const OpenPanelDoc: VitruvioComponentDoc = {
+   component: "OpenPanel",
+   summary: "Documentacao do componente OpenPanel mapeada a partir de exemplos reais de XML.",
+   status: "draft",
+   context: {
+      module: "Vitruvio",
+      family: "Layout",
+      mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
+      occurrences: { total: 7, paineis: 7, processos: 0 }
+   },
+   sections: {
+      purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
+      basicUsage: "Usar OpenPanel no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
+      properties: [
+         "panel-key",
+         "target"
+      ],
+      propertyValues: {
+         "panel-key": ["detalhes_gmd", "detalhes_gmd_desenv"],
+         "target": ["MODAL_WINDOW"]
+      },
+      propertyValueTypes: {
+         "panel-key": "enum",
+         "target": "enum"
+      },
+      events: [
+
+      ],
+      examples: [
+         "Vitruvio/Paineis/GMD Desenv Vertical Principal.xml:21",
+         "Vitruvio/Paineis/Apresentação GMD (BI) - Servidor Antigo.xml:21",
+         "Vitruvio/Paineis/GMD Oficial Version 5.xml:21",
+         "Vitruvio/Paineis/GMR - Faturamento Revenda e Produção - Teste.xml:21",
+         "Vitruvio/Paineis/Apresentação GMD (BI) Oficial.xml:21",
+         "Vitruvio/Paineis/GMD - Comparativo de Vendas.xml:19",
+         "Vitruvio/Paineis/Venda por Hora - BI.xml:21"
+      ],
+      notes: [
+         "Mapeamento automatico baseado em uso observado nos XMLs de paineis e processos.",
+         "Valores ruidosos/textos muito longos sao filtrados para facilitar consulta.",
+         "propertyValueTypes classifica o perfil observado da propriedade (boolean, enum, numeric, text ou mixed).",
+         "Validar com documentacao oficial do Vitruvio quando houver divergencia funcional."
+      ]
+   }
+};
+
+export default OpenPanelDoc;