victor
88 lines
3.3 KiB
TypeScript
Executable File
88 lines
3.3 KiB
TypeScript
Executable File
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 HeaderDoc: VitruvioComponentDoc = {
|
|
component: "Header",
|
|
summary: "Documentacao do componente Header mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Infraestrutura",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 901, paineis: 618, processos: 283 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de suporte para configuracao, integracao e comportamento da tela.",
|
|
basicUsage: "Usar Header no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"align",
|
|
"backgroundColor",
|
|
"captionColor",
|
|
"colorSeparator",
|
|
"subCaptionColor"
|
|
],
|
|
propertyValues: {
|
|
"align": ["MIDDLE_CENTER", "MIDDLE_LEFT", "MIDDLE_RIGHT", "MIDDLE_RIGTH", "TOP_CENTER", "TOP_LEFT"],
|
|
"backgroundColor": ["#191970", "#f88158", "#F88158", "#fcba03", "#FD8204", "#FF6347", "#ff8c00", "#FF9800", "#FFA500", "chocolate", "GREEN", "ORANGE"],
|
|
"captionColor": ["#4a4434", "#FFFFF", "#ffFFFF", "#FFFFFF", "#ffffff", "FFFFFF"],
|
|
"colorSeparator": ["transparent"],
|
|
"subCaptionColor": ["#6e6754", "#ff8c00", "#FFFFF", "#ffffff", "FFFFFF"]
|
|
},
|
|
propertyValueTypes: {
|
|
"align": "enum",
|
|
"backgroundColor": "enum",
|
|
"captionColor": "text",
|
|
"colorSeparator": "enum",
|
|
"subCaptionColor": "text"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/Impressão de etiqueta LJ06 WS.xml:183",
|
|
"Vitruvio/Paineis/Acompanhamento dos produtos da NL.xml:27",
|
|
"Vitruvio/Paineis/Resultados da Geração de Dados abastecimento.xml:32",
|
|
"Vitruvio/Paineis/teste lustosa.xml:26",
|
|
"Vitruvio/Paineis/FIFO.xml:749",
|
|
"Vitruvio/Paineis/FIFO.xml:1964",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:74",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:461",
|
|
"Vitruvio/Paineis/Acompanhamento de Versões Mobile.xml:13",
|
|
"Vitruvio/Paineis/Painel de Queijos.xml:169",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:440",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:598"
|
|
],
|
|
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 HeaderDoc;
|