Módulos & Rails

O que são módulos

Um Módulo é uma secção do teu workspace, apresentada como um ícone no rail de navegação vertical no extremo esquerdo do ecrã. Os módulos organizam a tua aplicação em áreas lógicas — como departamentos, funções ou categorias.

Exemplos: Um workspace de gestão de inventário pode ter módulos para "Produtos", "Encomendas", "Fornecedores" e "Relatórios", cada um com o seu próprio ícone e conjunto de rails.

Propriedades do módulo

Propriedade	Descrição
Nome	Identificador interno
Designação	Nome de apresentação mostrado ao passar o rato
Ícone	Ícone Material ou Cupertino, selecionado a partir de um seletor visual. Por predefinição, usa um ícone de pasta se não estiver definido.
Rail Padrão	O rail que abre automaticamente ao entrar no módulo (opcional)
Ordem dos rails	Ordenação personalizada dos rails dentro do módulo

Criar um módulo

1. No Admin panel, vai a Modules.
2. Clica em Adicionar módulo.
3. Preenche a designação e o nome interno.
4. Clica no campo do ícone para abrires o seletor de ícones — pesquisa e seleciona a partir das bibliotecas de ícones Material e Cupertino.
5. Opcionalmente, seleciona um Rail Padrão (disponível depois de criares rails).
6. Clica em Guardar.

Como os módulos aparecem

No desktop, os módulos aparecem como um rail vertical estreito (40px de largura) no extremo esquerdo. Cada módulo é representado pelo seu ícone, com um indicador de destaque no módulo selecionado. Passar o rato mostra a designação do módulo como tooltip.

No telemóvel, os módulos aparecem numa gaveta lateral deslizante, acessível através do menu hambúrguer.

O que são rails

Um Rail é uma entrada de navegação dentro de um módulo. Cada rail liga a uma view configurada e aparece no painel lateral quando o respetivo módulo é selecionado.

Os rails não são contentores — são links para views. A configuração de um rail define que tipo de view renderizar e como apresentar os dados.

Propriedades do rail

Propriedade	Descrição
Designação	Nome de apresentação mostrado na barra lateral
Caminho	Segmento de path do URL, opcional (ex.: "/tasks")
Categoria	Etiqueta de agrupamento opcional, para organização hierárquica
Config	Configuração da view — define o que o rail apresenta

Criar um rail

1. No Admin panel, vai a Modules.
2. Expande o módulo ao qual queres adicionar um rail.
3. Clica em Adicionar página.
4. Introduz a designação de apresentação.
5. Opcionalmente, define um caminho e uma categoria.
6. Clica em Guardar.

Depois de criares o rail, configura-o com uma view através da secção de administração de Views.

Organizar a tua navegação

Categorias

Os rails podem ser agrupados em categorias para uma melhor organização. Quando um rail tem uma categoria definida, aparece sob uma etiqueta de secção, com os rails dessa categoria ligeiramente indentados por baixo na barra lateral.

Exemplo de layout:

Products Module
├── Daily Report (no category)
├── Catalog (category)
│   ├── All Products
│   ├── New Arrivals
│   └── Discontinued
└── Stock (category)
    ├── Current Inventory
    └── Low Stock Alert

As categorias são extraídas da configuração de cada rail. Os rails sem categoria aparecem diretamente na lista, sem cabeçalho de secção.

Ordenação

Tanto os módulos como os rails suportam ordenação personalizada:

• A ordem dos módulos é guardada ao nível do workspace. Os módulos aparecem na sequência configurada; os módulos que não estejam na lista de ordenação são acrescentados alfabeticamente.
• A ordem dos rails é guardada ao nível do módulo. Mesma lógica — primeiro a ordem configurada, depois alfabética.

Se não estiver definida nenhuma ordem personalizada, tanto os módulos como os rails são ordenados alfabeticamente pela designação. As páginas criadas através do formulário são acrescentadas automaticamente ao fim da ordem guardada do módulo, pelo que a ordenação alfabética passa a aplicar-se apenas a rails criados antes deste comportamento existir.

No painel de páginas do Admin, os grupos de categoria podem ser reordenados arrastando o cabeçalho do grupo — o grupo move-se inteiro, com todos os seus rails. O grupo "Sem categoria" fica sempre fixo no topo da lista e não pode ser arrastado.

Configuração do módulo

Rail Padrão

Cada módulo pode ter um Rail Padrão — o rail que carrega automaticamente quando o utilizador entra no módulo. Isto é útil para definir um ecrã "inicial" para cada módulo.

Para definires um Rail Padrão:

1. Edita o módulo no Admin panel.
2. No dropdown Rail Padrão, seleciona o rail pretendido.
3. Clica em Guardar.

Se o Rail Padrão selecionado for eliminado mais tarde, a definição é automaticamente limpa. Se não estiver definido nenhum Rail Padrão, o OutDo carrega o primeiro rail na ordem configurada.

Fluxo de navegação

Quando um utilizador clica no ícone de um módulo, o OutDo:

1. Verifica se o módulo tem um Rail Padrão.
2. Se existir, navega para a view desse rail.
3. Caso contrário, navega para o primeiro rail na lista ordenada.
4. A view configurada do rail carrega na área de conteúdo principal.

O caminho de URL completo segue o padrão: /organization/{orgId}/workspace/{wsId}/module/{moduleId}/view/{railId}