Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
+78
@@ -0,0 +1,78 @@
|
||||
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 SearchButtonDoc: VitruvioComponentDoc = {
|
||||
component: "SearchButton",
|
||||
summary: "Documentacao do componente SearchButton mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "Acao",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 153, paineis: 153, processos: 0 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente de interacao para disparar acoes e fluxos de processo.",
|
||||
basicUsage: "Usar SearchButton no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"caption",
|
||||
"id"
|
||||
],
|
||||
propertyValues: {
|
||||
"caption": ["Filtrar", "Pesquisar"],
|
||||
"id": ["clickMyButton", "refreshScript"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"caption": "text",
|
||||
"id": "enum"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Paineis/Expedição - Ranking - Área Climatizada - CX.xml:734",
|
||||
"Vitruvio/Paineis/Gráfico CheckList - Resultado por Bimestre Loja.xml:658",
|
||||
"Vitruvio/Paineis/Venda produto Unidade.xml:155",
|
||||
"Vitruvio/Paineis/recebimento seca teste danilo.xml:1134",
|
||||
"Vitruvio/Paineis/Usuários - old.xml:410",
|
||||
"Vitruvio/Paineis/Análise de Movimentação de Produtos.xml:481",
|
||||
"Vitruvio/Paineis/Ativos X Finalizados (Loja).xml:78",
|
||||
"Vitruvio/Paineis/Gráfico CheckList - % de Notas Verdes Bimestre.xml:477",
|
||||
"Vitruvio/Paineis/Chamados Ativos X Finalizados (Tipo).xml:41",
|
||||
"Vitruvio/Paineis/Teste Lázaro De Prod.xml:1129",
|
||||
"Vitruvio/Paineis/Análise Importações Abertas - grid.xml:88",
|
||||
"Vitruvio/Paineis/Checklists - Conformes e não conformes.xml:290"
|
||||
],
|
||||
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 SearchButtonDoc;
|
||||
Reference in New Issue
Block a user