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,96 @@
+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 ScreenshotWidgetDoc: VitruvioComponentDoc = {
+   component: "ScreenshotWidget",
+   summary: "Documentacao do componente ScreenshotWidget mapeada a partir de exemplos reais de XML.",
+   status: "draft",
+   context: {
+      module: "Vitruvio",
+      family: "Visualizacao",
+      mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
+      occurrences: { total: 33, paineis: 33, processos: 0 }
+   },
+   sections: {
+      purpose: "Componente para exibicao de informacoes, resultados e feedback visual.",
+      basicUsage: "Usar ScreenshotWidget no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
+      properties: [
+         "align",
+         "caption",
+         "expandRatio",
+         "icon",
+         "id",
+         "size",
+         "style",
+         "width"
+      ],
+      propertyValues: {
+         "align": ["BOTTOM_RIGHT", "MIDDLE_CENTER"],
+         "caption": ["", "Abertos", "Abertos Atrasados", "Baixar PDF", "Barras", "Concluídos", "Concluídos atrasados", "Exportar PDF", "Exportar PNG"],
+         "expandRatio": ["0", "1"],
+         "icon": ["font://fa/FILE_PDF_O"],
+         "id": ["screenshot", "screenshot1", "screenshot2", "screenshot3", "screenshot4", "screenshot5", "screenshotpng"],
+         "size": ["SMALL"],
+         "style": ["DANGER", "FRIENDLY", "ICON_ONLY", "PRIMARY"],
+         "width": ["100%", "50px"]
+      },
+      propertyValueTypes: {
+         "align": "enum",
+         "caption": "text",
+         "expandRatio": "numeric",
+         "icon": "enum",
+         "id": "enum",
+         "size": "enum",
+         "style": "enum",
+         "width": "numeric"
+      },
+      events: [
+
+      ],
+      examples: [
+         "Vitruvio/Paineis/Acompanhamento Visita Diária - Loja e Setor.xml:564",
+         "Vitruvio/Paineis/Indicador de Processos.xml:3294",
+         "Vitruvio/Paineis/Indicador de Processos.xml:3307",
+         "Vitruvio/Paineis/Indicador de Processos.xml:3322",
+         "Vitruvio/Paineis/Indicador de Processos.xml:3335",
+         "Vitruvio/Paineis/Indicador de Processos.xml:3348",
+         "Vitruvio/Paineis/Painel HTML teste zero.xml:123",
+         "Vitruvio/Paineis/Painel HTML teste zero.xml:134",
+         "Vitruvio/Paineis/Painel - Demonstrativo de resultados TI.xml:128",
+         "Vitruvio/Paineis/Painel - Demonstrativo de resultados TI.xml:139",
+         "Vitruvio/Paineis/Painel Checklist Geral Bimestral.xml:123",
+         "Vitruvio/Paineis/Painel Checklist Geral Bimestral.xml:134"
+      ],
+      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 ScreenshotWidgetDoc;