Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
+78
@@ -0,0 +1,78 @@
|
||||
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 ModalLayoutDoc: VitruvioComponentDoc = {
|
||||
component: "ModalLayout",
|
||||
summary: "Documentacao do componente ModalLayout mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "Layout",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 9, paineis: 0, processos: 9 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
|
||||
basicUsage: "Usar ModalLayout no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"align",
|
||||
"caption",
|
||||
"id"
|
||||
],
|
||||
propertyValues: {
|
||||
"align": ["MIDDLE_CENTER"],
|
||||
"caption": ["Foto do Produto", "Pontuação", "Resultado Final"],
|
||||
"id": ["modalFotoProduto", "resultadoModalLayout"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"align": "enum",
|
||||
"caption": "text",
|
||||
"id": "enum"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:822",
|
||||
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:964",
|
||||
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:1010",
|
||||
"Vitruvio/Processos/Inventário Geral/form_web_mobile.xml:1700",
|
||||
"Vitruvio/Processos/Checklist/form_web_mobile.xml:1386",
|
||||
"Vitruvio/Processos/Checklist/form_web_mobile.xml:5233",
|
||||
"Vitruvio/Processos/Checklist Padrão/form_web_mobile.xml:800",
|
||||
"Vitruvio/Processos/Checklist TI/form_web_mobile.xml:1457",
|
||||
"Vitruvio/Processos/Checklist Seg-Trabalho/form_web_mobile.xml:939"
|
||||
],
|
||||
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 ModalLayoutDoc;
|
||||
Reference in New Issue
Block a user