Menus de navegação

Nesta página

Os menus do EmDash são listas ordenadas de ligações que gere através da interface de administração. Suportam aninhamento para menus pendentes e podem apontar para páginas, artigos, termos de taxonomia ou URLs externos.

Consultar menus

Utilize getMenu() para obter um menu pelo nome único:

---
import { getMenu } from "emdash";

const primaryMenu = await getMenu("primary");
---

{primaryMenu && (
  <nav>
    <ul>
      {primaryMenu.items.map(item => (
        <li>
          <a href={item.url}>{item.label}</a>
        </li>
      ))}
    </ul>
  </nav>
)}

A função devolve null se não existir menu com esse nome.

Estrutura do menu

Um menu contém metadados e um array de itens:

interface Menu {
	id: string;
	name: string; // Unique identifier ("primary", "footer")
	label: string; // Display name ("Primary Navigation")
	items: MenuItem[];
}

interface MenuItem {
	id: string;
	label: string;
	url: string; // Resolved URL
	target?: string; // "_blank" for new window
	titleAttr?: string; // HTML title attribute
	cssClasses?: string; // Custom CSS classes
	children: MenuItem[]; // Nested items for dropdowns
}

Os URLs são resolvidos automaticamente consoante o tipo de item:

  • Itens de página/artigo resolvem para /{collection}/{slug}
  • Itens de taxonomia resolvem para /{taxonomy}/{slug}
  • Itens de coleção resolvem para /{collection}/
  • Ligações personalizadas utilizam o URL tal como está

Renderizar menus aninhados

Os itens de menu podem ter filhos para navegação pendente. Trate o aninhamento renderizando recursivamente o array children:

---
import { getMenu } from "emdash";
import type { MenuItem } from "emdash";

interface Props {
  name: string;
}

const menu = await getMenu(Astro.props.name);
---

{menu && (
  <nav class="nav">
    <ul class="nav-list">
      {menu.items.map(item => (
        <li class:list={["nav-item", item.cssClasses]}>
          <a
            href={item.url}
            target={item.target}
            title={item.titleAttr}
            aria-current={Astro.url.pathname === item.url ? "page" : undefined}
          >
            {item.label}
          </a>
          {item.children.length > 0 && (
            <ul class="submenu">
              {item.children.map(child => (
                <li>
                  <a href={child.url} target={child.target}>
                    {child.label}
                  </a>
                </li>
              ))}
            </ul>
          )}
        </li>
      ))}
    </ul>
  </nav>
)}

Tipos de item de menu

A administração suporta cinco tipos de itens de menu:

TipoDescriçãoResolução de URL
pageLigação para uma página/{collection}/{slug}
postLigação para um artigo/{collection}/{slug}
taxonomyLigação para categoria ou etiqueta/{taxonomy}/{slug}
collectionLigação para arquivo da coleção/{collection}/
customURL externo ou personalizadoUtilizado tal como está

Listar todos os menus

Utilize getMenus() para obter todas as definições de menu (sem itens):

import { getMenus } from "emdash";

const menus = await getMenus();
// Returns: [{ id, name, label }, ...]

É sobretudo útil para interfaces de administração ou depuração.

Criar menus

Crie menus na interface de administração em /_emdash/admin/menus ou com a API de administração:

POST /_emdash/api/menus
Content-Type: application/json

{
  "name": "footer",
  "label": "Footer Navigation"
}

Adicione itens a um menu:

POST /_emdash/api/menus/footer/items
Content-Type: application/json

{
  "type": "page",
  "referenceCollection": "pages",
  "referenceId": "page_privacy",
  "label": "Privacy Policy"
}

Adicione uma ligação externa personalizada:

POST /_emdash/api/menus/footer/items
Content-Type: application/json

{
  "type": "custom",
  "customUrl": "https://github.com/example",
  "label": "GitHub",
  "target": "_blank"
}

Reordenar e aninhar

Atualize a ordem dos itens e as relações pai-filho com o endpoint de reordenação:

POST /_emdash/api/menus/primary/reorder
Content-Type: application/json

{
  "items": [
    { "id": "item_1", "parentId": null, "sortOrder": 0 },
    { "id": "item_2", "parentId": null, "sortOrder": 1 },
    { "id": "item_3", "parentId": "item_2", "sortOrder": 0 }
  ]
}

Isto faz com que item_3 seja filho de item_2, criando um menu pendente.

Exemplo completo

O exemplo seguinte mostra um cabeçalho responsivo com navegação principal:

---
import { getMenu, getSiteSettings } from "emdash";

const settings = await getSiteSettings();
const primaryMenu = await getMenu("primary");
---

<html lang="en">
  <head>
    <title>{settings.title}</title>
  </head>
  <body>
    <header class="header">
      <a href="/" class="logo">
        {settings.logo ? (
          <img src={settings.logo.url} alt={settings.logo.alt || settings.title} />
        ) : (
          settings.title
        )}
      </a>

      {primaryMenu && (
        <nav class="main-nav" aria-label="Main navigation">
          <ul>
            {primaryMenu.items.map(item => (
              <li class:list={[item.cssClasses, { "has-children": item.children.length > 0 }]}>
                <a
                  href={item.url}
                  target={item.target}
                  aria-current={Astro.url.pathname === item.url ? "page" : undefined}
                >
                  {item.label}
                </a>
                {item.children.length > 0 && (
                  <ul class="dropdown">
                    {item.children.map(child => (
                      <li>
                        <a href={child.url} target={child.target}>{child.label}</a>
                      </li>
                    ))}
                  </ul>
                )}
              </li>
            ))}
          </ul>
        </nav>
      )}
    </header>

    <main>
      <slot />
    </main>
  </body>
</html>

Referência da API

getMenu(name)

Obtém um menu pelo nome com todos os itens e URLs resolvidos.

Parâmetros:

  • name — Identificador único do menu (cadeia)

Devolve: Promise<Menu | null>

getMenus()

Lista todas as definições de menu sem itens.

Devolve: Promise<Array<{ id: string; name: string; label: string }>>