victor
89 lines
2.8 KiB
TypeScript
Executable File
89 lines
2.8 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 ButtonGroupDoc: VitruvioComponentDoc = {
|
|
component: "ButtonGroup",
|
|
summary: "Documentacao do componente ButtonGroup mapeada a partir de exemplos reais de XML.",
|
|
status: "draft",
|
|
context: {
|
|
module: "Vitruvio",
|
|
family: "Acao",
|
|
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
|
occurrences: { total: 4, paineis: 0, processos: 4 }
|
|
},
|
|
sections: {
|
|
purpose: "Componente de interacao para disparar acoes e fluxos de processo.",
|
|
basicUsage: "Usar ButtonGroup no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
|
properties: [
|
|
"caption",
|
|
"colorEnd",
|
|
"colorMedium",
|
|
"colorSelected",
|
|
"colorStart",
|
|
"id",
|
|
"required",
|
|
"type"
|
|
],
|
|
propertyValues: {
|
|
"caption": ["Informe sua resposta", "Tipo de responsável"],
|
|
"colorEnd": ["green"],
|
|
"colorMedium": ["yellow"],
|
|
"colorSelected": ["dark", "orange"],
|
|
"colorStart": ["red"],
|
|
"id": ["nps", "tipoResponsavel"],
|
|
"required": ["true"],
|
|
"type": ["number", "string"]
|
|
},
|
|
propertyValueTypes: {
|
|
"caption": "text",
|
|
"colorEnd": "enum",
|
|
"colorMedium": "enum",
|
|
"colorSelected": "enum",
|
|
"colorStart": "enum",
|
|
"id": "enum",
|
|
"required": "boolean",
|
|
"type": "enum"
|
|
},
|
|
events: [
|
|
|
|
],
|
|
examples: [
|
|
"Vitruvio/Processos/Checklist/form_web_mobile.xml:3405",
|
|
"Vitruvio/Processos/Checklist/form_web_mobile.xml:5786",
|
|
"Vitruvio/Processos/5W2H/form_web_mobile.xml:426",
|
|
"Vitruvio/Processos/5W2H RH/form_web_mobile.xml:439"
|
|
],
|
|
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 ButtonGroupDoc;
|