Files

88 lines
3.2 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 ProgressBarWidgetDoc: VitruvioComponentDoc = {
component: "ProgressBarWidget",
summary: "Documentacao do componente ProgressBarWidget mapeada a partir de exemplos reais de XML.",
status: "draft",
context: {
module: "Vitruvio",
family: "Visualizacao",
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
occurrences: { total: 26, paineis: 4, processos: 22 }
},
sections: {
purpose: "Componente para exibicao de informacoes, resultados e feedback visual.",
basicUsage: "Usar ProgressBarWidget no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
properties: [
"caption",
"expandRatio",
"id",
"initialValue",
"width"
],
propertyValues: {
"caption": ["Progress Bar", "Progresso"],
"expandRatio": ["1"],
"id": ["pb1", "pb10", "pb11", "pb12", "pb13", "pb14", "pb15", "pb16", "pb17", "pb18", "pb2", "pb3", "pb4", "pb5", "pb6", "__TRUNCADO__"],
"initialValue": ["0", "0.1", "0.15", "0.25", "0.35"],
"width": ["50%"]
},
propertyValueTypes: {
"caption": "text",
"expandRatio": "numeric",
"id": "mixed",
"initialValue": "numeric",
"width": "numeric"
},
events: [
],
examples: [
"Vitruvio/Paineis/ProgressBar.xml:11",
"Vitruvio/Paineis/ProgressBar.xml:12",
"Vitruvio/Paineis/ProgressBar.xml:13",
"Vitruvio/Paineis/ProgressBar.xml:14",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:9294",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:9508",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:9721",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:9933",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:10145",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:10356",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:10566",
"Vitruvio/Processos/Compra de utensílios/form_web_desktop.xml:10775"
],
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 ProgressBarWidgetDoc;