Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
+102
@@ -0,0 +1,102 @@
|
||||
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 ListSelectDoc: VitruvioComponentDoc = {
|
||||
component: "ListSelect",
|
||||
summary: "Documentacao do componente ListSelect mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "EntradaDeDados",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 25, paineis: 25, processos: 0 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
|
||||
basicUsage: "Usar ListSelect no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"align",
|
||||
"caption",
|
||||
"description",
|
||||
"expandRatio",
|
||||
"height",
|
||||
"id",
|
||||
"rows",
|
||||
"type",
|
||||
"visible",
|
||||
"width"
|
||||
],
|
||||
propertyValues: {
|
||||
"align": ["TOP_LEFT"],
|
||||
"caption": ["Campos disponíveis", "Dia da semana", "Mês do Agendamento:"],
|
||||
"description": ["Itens adicionados em caso de tipo de questão Lista"],
|
||||
"expandRatio": [".4", "0.3", "0.5", "0.7", "1"],
|
||||
"height": ["100%", "300", "87", "95"],
|
||||
"id": ["diaSemana", "lista", "mesAno", "pontoslista", "pontosna", "variaveis", "variaveisMaster"],
|
||||
"rows": ["4"],
|
||||
"type": ["string"],
|
||||
"visible": ["false"],
|
||||
"width": ["100%"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"align": "enum",
|
||||
"caption": "text",
|
||||
"description": "text",
|
||||
"expandRatio": "enum",
|
||||
"height": "numeric",
|
||||
"id": "enum",
|
||||
"rows": "numeric",
|
||||
"type": "enum",
|
||||
"visible": "boolean",
|
||||
"width": "numeric"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:1176",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:1180",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:1184",
|
||||
"Vitruvio/Paineis/Agendamento - Auditoria da Seg. Trabalho.xml:910",
|
||||
"Vitruvio/Paineis/Agendamento - Auditoria da Seg. Trabalho.xml:924",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - TI.xml:1547",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - TI.xml:1554",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - TI.xml:1560",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Manutenção.xml:1302",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Manutenção.xml:1306",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Manutenção.xml:1310",
|
||||
"Vitruvio/Paineis/06 - Cadastro de Checklist Padrão.xml:2896"
|
||||
],
|
||||
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 ListSelectDoc;
|
||||
Reference in New Issue
Block a user