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,70 @@
+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 OrbWidgetDoc: VitruvioComponentDoc = {
+   component: "OrbWidget",
+   summary: "Documentacao do componente OrbWidget mapeada a partir de exemplos reais de XML.",
+   status: "draft",
+   context: {
+      module: "Vitruvio",
+      family: "Visualizacao",
+      mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
+      occurrences: { total: 4, paineis: 4, processos: 0 }
+   },
+   sections: {
+      purpose: "Componente para exibicao de informacoes, resultados e feedback visual.",
+      basicUsage: "Usar OrbWidget no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
+      properties: [
+         "id",
+         "width"
+      ],
+      propertyValues: {
+         "id": ["orb"],
+         "width": ["100%"]
+      },
+      propertyValueTypes: {
+         "id": "enum",
+         "width": "numeric"
+      },
+      events: [
+
+      ],
+      examples: [
+         "Vitruvio/Paineis/Matriz Mês a Mês.xml:463",
+         "Vitruvio/Paineis/Evolução de Despesas.xml:274",
+         "Vitruvio/Paineis/Visão Recebimento - Histórico.xml:250",
+         "Vitruvio/Paineis/Manutenção das descrições.xml:432"
+      ],
+      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 OrbWidgetDoc;