victor
77 lines
2.6 KiB
TypeScript
Executable File
77 lines
2.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 ShowLayoutButtonDoc: VitruvioComponentDoc = {
|
|
component: "ShowLayoutButton",
|
|
summary: "Documentacao do componente ShowLayoutButton mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Acao",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 7, paineis: 0, processos: 7 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de interacao para disparar acoes e fluxos de processo.",
|
|
basicUsage: "Usar ShowLayoutButton no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"caption",
|
|
"mode",
|
|
"uppercase"
|
|
],
|
|
propertyValues: {
|
|
"caption": ["Ver Pontuação"],
|
|
"mode": ["text"],
|
|
"uppercase": ["true"]
|
|
},
|
|
propertyValueTypes: {
|
|
"caption": "text",
|
|
"mode": "enum",
|
|
"uppercase": "boolean"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:808",
|
|
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:949",
|
|
"Vitruvio/Processos/Checklist Fab. Própria/form_web_mobile.xml:995",
|
|
"Vitruvio/Processos/Checklist/form_web_mobile.xml:1372",
|
|
"Vitruvio/Processos/Checklist Padrão/form_web_mobile.xml:798",
|
|
"Vitruvio/Processos/Checklist TI/form_web_mobile.xml:1441",
|
|
"Vitruvio/Processos/Checklist Seg-Trabalho/form_web_mobile.xml:924"
|
|
],
|
|
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 ShowLayoutButtonDoc;
|