Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
+114
@@ -0,0 +1,114 @@
|
||||
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 ScriptComboBoxDoc: VitruvioComponentDoc = {
|
||||
component: "ScriptComboBox",
|
||||
summary: "Documentacao do componente ScriptComboBox mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "EntradaDeDados",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 49, paineis: 9, processos: 40 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente de captura e edicao de dados em formularios e filtros.",
|
||||
basicUsage: "Usar ScriptComboBox no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"align",
|
||||
"allowNullSelection",
|
||||
"caption",
|
||||
"description",
|
||||
"enabled",
|
||||
"expandRatio",
|
||||
"height",
|
||||
"id",
|
||||
"immediate",
|
||||
"required",
|
||||
"searchCaption",
|
||||
"type",
|
||||
"visible",
|
||||
"width"
|
||||
],
|
||||
propertyValues: {
|
||||
"align": ["BOTTOM_LEFT", "MIDDLE_CENTER", "TOP_LEFT"],
|
||||
"allowNullSelection": ["false", "true"],
|
||||
"caption": ["ACORDOS/AÇÕES", "Balança", "DEVOLUÇÕES ", "FORMA DE QUITAÇÃO", "FRETE", "Impressora", "LOGÍSTICO", "Modelo OCR", "Motivo", "Motivo Não Conferência", "Motivo Não Separação", "Motivos", "OPÇÕES PARCIAL", "OPÇÕES TOTAL", "Ponto de Coleta", "__TRUNCADO__"],
|
||||
"description": ["Selecione o formato que será a questão a ser aplicada", "Selecione o modelo OCR"],
|
||||
"enabled": ["false"],
|
||||
"expandRatio": ["0.1", "0.2", "0.6", "0.65", "0.75", "1", "1.0"],
|
||||
"height": ["30px"],
|
||||
"id": ["acordosAcoes", "balanca", "devolucao", "dUIyyIER", "formaQuitacao", "frete", "impressora", "motivo_conf", "motivonaoconferencia", "motivonaoseparacao", "opcaoLogistico", "parJustificativas", "pontoColeta", "ProdutoComboBox", "promotor", "__TRUNCADO__"],
|
||||
"immediate": ["true"],
|
||||
"required": ["false", "true"],
|
||||
"searchCaption": ["Modelo OCR", "Selecione o tipo de questão"],
|
||||
"type": ["number", "string"],
|
||||
"visible": ["false", "true"],
|
||||
"width": ["100%", "50%"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"align": "enum",
|
||||
"allowNullSelection": "boolean",
|
||||
"caption": "text",
|
||||
"description": "text",
|
||||
"enabled": "boolean",
|
||||
"expandRatio": "numeric",
|
||||
"height": "numeric",
|
||||
"id": "mixed",
|
||||
"immediate": "boolean",
|
||||
"required": "boolean",
|
||||
"searchCaption": "text",
|
||||
"type": "enum",
|
||||
"visible": "boolean",
|
||||
"width": "numeric"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Seg-Trabalho.xml:997",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - TI.xml:1216",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Manutenção.xml:1093",
|
||||
"Vitruvio/Paineis/Kanban - Gestão de Projetos.xml:3232",
|
||||
"Vitruvio/Paineis/06 - Cadastro de Checklist Padrão.xml:2732",
|
||||
"Vitruvio/Paineis/04 - Cadastro de Checklist.xml:1050",
|
||||
"Vitruvio/Paineis/3 - Cadastro de Checklist - Fab. Própria.xml:1084",
|
||||
"Vitruvio/Paineis/Cadastro de Checklist.xml:2614",
|
||||
"Vitruvio/Paineis/Kanban - Gestão de Projetos - TESTE.xml:3080",
|
||||
"Vitruvio/Processos/Gestão de Atividades/form_web_desktop.xml:962",
|
||||
"Vitruvio/Processos/Gestão de Atividades/form_web_mobile.xml:653",
|
||||
"Vitruvio/Processos/Checklist Manutenção/form_web_mobile.xml:1253"
|
||||
],
|
||||
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 ScriptComboBoxDoc;
|
||||
Reference in New Issue
Block a user