victor
97 lines
3.6 KiB
TypeScript
Executable File
97 lines
3.6 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 TabDoc: VitruvioComponentDoc = {
|
|
component: "Tab",
|
|
summary: "Documentacao do componente Tab mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Layout",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 869, paineis: 643, processos: 226 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
|
|
basicUsage: "Usar Tab no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"caption",
|
|
"height",
|
|
"icon",
|
|
"id",
|
|
"margin",
|
|
"spacing",
|
|
"visible",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"caption": ["", " Contratos", "2º Coleta", "3º Prevenção Perdas", "4º Gestão de Estoque", "Abas", "Abastecimento CD", "Abastecimento Estatíticas", "Abertura", "Abertura de processo", "Abrangência", "Acampanhamento atividade", "Acompanhamento de Itens", "Acompanhamento de Pontas", "Acompanhar Atividades", "__TRUNCADO__"],
|
|
"height": ["100%"],
|
|
"icon": ["person", "trophy"],
|
|
"id": ["editar", "lytConsulta", "pontuacaoTab", "tabCondPag", "tabJustificativa"],
|
|
"margin": ["true"],
|
|
"spacing": ["true"],
|
|
"visible": ["false", "true"],
|
|
"width": ["100%"]
|
|
},
|
|
propertyValueTypes: {
|
|
"caption": "text",
|
|
"height": "numeric",
|
|
"icon": "enum",
|
|
"id": "enum",
|
|
"margin": "boolean",
|
|
"spacing": "boolean",
|
|
"visible": "boolean",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/imp - Pônica - aux - Ações(Previsão_Real).xml:735",
|
|
"Vitruvio/Paineis/imp - Pônica - aux - Ações(Previsão_Real).xml:811",
|
|
"Vitruvio/Paineis/imp - Pônica - aux - Ações(Previsão_Real).xml:864",
|
|
"Vitruvio/Paineis/Relatório de Transferências.xml:281",
|
|
"Vitruvio/Paineis/Cadastro de Usuários.xml:721",
|
|
"Vitruvio/Paineis/Cadastro de Usuários.xml:736",
|
|
"Vitruvio/Paineis/Cadastro de Usuários.xml:770",
|
|
"Vitruvio/Paineis/Cadastro - Metas.xml:506",
|
|
"Vitruvio/Paineis/03 - Registro Temporário de Boletos BB.xml:386",
|
|
"Vitruvio/Paineis/Relatório de Colaboradores por Escala.xml:225",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:453",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:893"
|
|
],
|
|
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 TabDoc;
|