Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
+96
@@ -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 AbsoluteLayoutDoc: VitruvioComponentDoc = {
|
||||
component: "AbsoluteLayout",
|
||||
summary: "Documentacao do componente AbsoluteLayout mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "Layout",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 211, paineis: 209, processos: 2 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
|
||||
basicUsage: "Usar AbsoluteLayout no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"align",
|
||||
"backgroundColor",
|
||||
"dragAndDropEnabled",
|
||||
"draggable",
|
||||
"expandRatio",
|
||||
"height",
|
||||
"id",
|
||||
"width"
|
||||
],
|
||||
propertyValues: {
|
||||
"align": ["TOP_CENTER", "TOP_LEFT", "TOP_RIGHT"],
|
||||
"backgroundColor": ["#004D40", "#FFFFFF"],
|
||||
"dragAndDropEnabled": ["false", "true"],
|
||||
"draggable": ["true"],
|
||||
"expandRatio": ["1"],
|
||||
"height": ["100%", "350", "360px", "460px"],
|
||||
"id": ["pai"],
|
||||
"width": ["100%"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"align": "enum",
|
||||
"backgroundColor": "enum",
|
||||
"dragAndDropEnabled": "boolean",
|
||||
"draggable": "boolean",
|
||||
"expandRatio": "numeric",
|
||||
"height": "numeric",
|
||||
"id": "enum",
|
||||
"width": "numeric"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Paineis/Manutenção de Gôndolas.xml:729",
|
||||
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:891",
|
||||
"Vitruvio/Paineis/Painel de Queijos.xml:705",
|
||||
"Vitruvio/Paineis/Expedição - Ranking - Área Climatizada - CX.xml:738",
|
||||
"Vitruvio/Paineis/Gráfico CheckList - Resultado por Bimestre Loja.xml:662",
|
||||
"Vitruvio/Paineis/Venda produto Unidade.xml:159",
|
||||
"Vitruvio/Paineis/recebimento seca teste danilo.xml:1138",
|
||||
"Vitruvio/Paineis/21 - Contratos - Saldos Trocas e Perdas.xml:2461",
|
||||
"Vitruvio/Paineis/Usuários - old.xml:415",
|
||||
"Vitruvio/Paineis/Análise de Movimentação de Produtos.xml:485",
|
||||
"Vitruvio/Paineis/Ativos X Finalizados (Loja).xml:792",
|
||||
"Vitruvio/Paineis/Gráfico CheckList - % de Notas Verdes Bimestre.xml:481"
|
||||
],
|
||||
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 AbsoluteLayoutDoc;
|
||||
Reference in New Issue
Block a user