victor
103 lines
4.0 KiB
TypeScript
Executable File
103 lines
4.0 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 CrudPanelDoc: VitruvioComponentDoc = {
|
|
component: "CrudPanel",
|
|
summary: "Documentacao do componente CrudPanel mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Layout",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 846, paineis: 573, processos: 273 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de organizacao visual da tela para estruturar conteudo e navegacao.",
|
|
basicUsage: "Usar CrudPanel no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"align",
|
|
"backgroundColor",
|
|
"caption",
|
|
"expandRatio",
|
|
"height",
|
|
"id",
|
|
"margin",
|
|
"spacing",
|
|
"visible",
|
|
"width"
|
|
],
|
|
propertyValues: {
|
|
"align": ["TOP_CENTER", "TOP_LEFT", "TOP_RIGHT"],
|
|
"backgroundColor": ["BLUE", "ORANGE"],
|
|
"caption": ["", "Acompanhamento saldos dos fornecedores", "Bloqueio de fornecedores", "Detalhes contratos Fornecedor", "Liberar Fornecedores Permanentemente", "Liberar fornecedores Temporariamente", "Logs Status Fornecedor", "Painel de seleção de impressora CD"],
|
|
"expandRatio": ["0", "1", "2"],
|
|
"height": ["100%"],
|
|
"id": ["crdControleSelos", "crdDivergenciasNL", "crdSelosRegistro", "crud", "crudConcorrencia", "crudDivergencias", "crudInclusao", "crudNovaQuestao", "crudPanel", "crudPanelEmail", "crudPrincipal", "crudProcessoChamado", "crudTelaInicial", "crudWhatsapp", "gravarSubNivel", "__TRUNCADO__"],
|
|
"margin": ["false", "true"],
|
|
"spacing": ["false", "true"],
|
|
"visible": ["false", "true"],
|
|
"width": ["100%"]
|
|
},
|
|
propertyValueTypes: {
|
|
"align": "enum",
|
|
"backgroundColor": "enum",
|
|
"caption": "text",
|
|
"expandRatio": "numeric",
|
|
"height": "numeric",
|
|
"id": "text",
|
|
"margin": "boolean",
|
|
"spacing": "boolean",
|
|
"visible": "boolean",
|
|
"width": "numeric"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Paineis/Impressão de etiqueta LJ06 WS.xml:689",
|
|
"Vitruvio/Paineis/Acompanhamento dos produtos da NL.xml:327",
|
|
"Vitruvio/Paineis/Resultados da Geração de Dados abastecimento.xml:92",
|
|
"Vitruvio/Paineis/teste lustosa.xml:181",
|
|
"Vitruvio/Paineis/FIFO.xml:2152",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:450",
|
|
"Vitruvio/Paineis/CD - Cadastro de Regras de Priorização WMS.xml:640",
|
|
"Vitruvio/Paineis/Acompanhamento de Versões Mobile.xml:212",
|
|
"Vitruvio/Paineis/Painel de Queijos.xml:704",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:592",
|
|
"Vitruvio/Paineis/Cadastro de Elementos.xml:860",
|
|
"Vitruvio/Paineis/Migração EAN.xml:222"
|
|
],
|
|
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 CrudPanelDoc;
|