victor
112 lines
5.1 KiB
TypeScript
Executable File
112 lines
5.1 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 SectionDoc: VitruvioComponentDoc = {
|
|
component: "Section",
|
|
summary: "Documentacao do componente Section mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Layout",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 1167, paineis: 652, processos: 515 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
|
|
basicUsage: "Usar Section no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"align",
|
|
"caption",
|
|
"captionColor",
|
|
"colorSeparator",
|
|
"expandRatio",
|
|
"height",
|
|
"id",
|
|
"showHeader",
|
|
"subCaption",
|
|
"subCaptionColor",
|
|
"titleOrientation",
|
|
"visible",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"align": ["MIDDLE_CENTER", "MIDDLE_LEFT", "TOP_LEFT"],
|
|
"caption": ["", " ", "a", "Abertura aprovação", "Abertura da Coleta", "Abertura de Processo de Devolução Via Voucher", "Abertura do Processo", "Aceitar ou não", "Aceitar ou não com justificativa - Marketing", "Aceitar ou não com justificativa do Cadastro", "acompanhamento", "Acompanhamento", "Acompanhamento - CD - WMS - Separação 2.0", "ACOMPANHAMENTO DA APROVAÇÃO", "Acompanhamento da aprovação geral", "__TRUNCADO__"],
|
|
"captionColor": ["#000000", "#4F4F4F", "#54576e", "#75D9AB", "BLUE", "navy"],
|
|
"colorSeparator": ["#000000", "#191970", "#524a4a", "orange", "transparent", "white", "WHITE"],
|
|
"expandRatio": ["0", "1", "2"],
|
|
"height": ["100%", "50%", "95%"],
|
|
"id": ["anexoImagem", "dadosComplementares", "pnlTitulo", "sc__all", "sc__detalhar", "sc__imagem", "sec__rel", "sec__remocao", "secConexao", "secConfig", "secDetalhes", "secEditar", "secKpiProcessos", "secPrincipal", "sectionHome", "__TRUNCADO__"],
|
|
"showHeader": ["false", "true"],
|
|
"subCaption": ["", " ", " ", "--", "Abaixo encontra-se as configurações", "Abaixo encontra-se todas as Alçadas", "Abaixo encontra-se todos os registros", "Abaixo encontram-se todos os registros", "Abaixo se encontra a configuração das lojas", "Abaixo se encontra os acessos para ", "Abaixo se encontra os acessos para: ", "Abaixo se encontra os dados do agendamento", "Abaixo se encontra os parâmetros da classificação de notas fiscais", "Abaixo se encontra os parâmetros das Auditoria de Placas Promocionais", "Abaixo se encontra todas as Ajudas e os filtros", "__TRUNCADO__"],
|
|
"subCaptionColor": ["", "#000000", "#1C1C1C", "#1c2a94", "#75d9ab", "#ffffff", "Black", "navy"],
|
|
"titleOrientation": ["VERTICAL"],
|
|
"visible": ["false", "true"],
|
|
"width": ["100%"]
|
|
},
|
|
propertyValueTypes: {
|
|
"align": "enum",
|
|
"caption": "text",
|
|
"captionColor": "text",
|
|
"colorSeparator": "enum",
|
|
"expandRatio": "numeric",
|
|
"height": "numeric",
|
|
"id": "enum",
|
|
"showHeader": "boolean",
|
|
"subCaption": "text",
|
|
"subCaptionColor": "text",
|
|
"titleOrientation": "text",
|
|
"visible": "boolean",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/Acompanhamento dos produtos da NL.xml:326",
|
|
"Vitruvio/Paineis/Resultados da Geração de Dados abastecimento.xml:91",
|
|
"Vitruvio/Paineis/teste lustosa.xml:180",
|
|
"Vitruvio/Paineis/FIFO.xml:2151",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:449",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:639",
|
|
"Vitruvio/Paineis/Acompanhamento de Versões Mobile.xml:211",
|
|
"Vitruvio/Paineis/Painel de Queijos.xml:703",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:591",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:859",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:1176",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:1407"
|
|
],
|
|
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 SectionDoc;
|