Configurações do Site

Nesta página

As configurações do site são valores de configuração globais para o seu site: título, slogan, logo, links sociais e preferências de exibição. Os administradores gerenciam essas configurações através da interface de administração, e você as acessa em seus templates.

Consultando Configurações

Use getSiteSettings() para buscar todas as configurações do site:

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

const settings = await getSiteSettings();
---

<html lang="en">
  <head>
    <title>{settings.title}</title>
    {settings.favicon && (
      <link rel="icon" href={settings.favicon.url} />
    )}
  </head>
  <body>
    <header>
      {settings.logo ? (
        <img src={settings.logo.url} alt={settings.logo.alt || settings.title} />
      ) : (
        <span class="site-title">{settings.title}</span>
      )}
      {settings.tagline && <p class="tagline">{settings.tagline}</p>}
    </header>
    <slot />
  </body>
</html>

Configurações Disponíveis

EmDash fornece essas configurações principais:

interface SiteSettings {
	// Identidade
	title: string;
	tagline?: string;
	logo?: MediaReference;
	favicon?: MediaReference;

	// URLs
	url?: string;

	// Exibição
	postsPerPage: number;
	dateFormat: string;
	timezone: string;

	// Social
	social?: {
		twitter?: string;
		github?: string;
		facebook?: string;
		instagram?: string;
		linkedin?: string;
		youtube?: string;
	};
}

interface MediaReference {
	mediaId: string;
	alt?: string;
	url?: string; // URL resolvida (somente leitura)
}

Buscando Configurações Individuais

Use getSiteSetting() para buscar uma única configuração por chave:

import { getSiteSetting } from "emdash";

const title = await getSiteSetting("title");
// Retorna: "Meu Site" ou undefined

const logo = await getSiteSetting("logo");
// Retorna: { mediaId: "...", url: "/_emdash/api/media/file/..." }

Isso é útil quando você precisa apenas de um ou dois valores e quer evitar buscar tudo.

Usando Configurações em Componentes

Cabeçalho do Site

O componente a seguir renderiza um cabeçalho com o logo do site e o menu principal:

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

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

<header class="header">
  <a href="/" class="logo">
    {settings.logo ? (
      <img
        src={settings.logo.url}
        alt={settings.logo.alt || settings.title}
        width="150"
        height="50"
      />
    ) : (
      <span class="site-name">{settings.title}</span>
    )}
  </a>

  {menu && (
    <nav>
      {menu.items.map(item => (
        <a href={item.url}>{item.label}</a>
      ))}
    </nav>
  )}
</header>

O componente a seguir renderiza links para cada plataforma social configurada:

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

const social = await getSiteSetting("social");

const platforms = [
  { key: "twitter", label: "Twitter", baseUrl: "https://twitter.com/" },
  { key: "github", label: "GitHub", baseUrl: "https://github.com/" },
  { key: "facebook", label: "Facebook", baseUrl: "https://facebook.com/" },
  { key: "instagram", label: "Instagram", baseUrl: "https://instagram.com/" },
  { key: "linkedin", label: "LinkedIn", baseUrl: "https://linkedin.com/in/" },
  { key: "youtube", label: "YouTube", baseUrl: "https://youtube.com/@" },
] as const;
---

{social && (
  <div class="social-links">
    {platforms.map(({ key, label, baseUrl }) => (
      social[key] && (
        <a
          href={baseUrl + social[key]}
          rel="noopener noreferrer"
          target="_blank"
          aria-label={label}
        >
          {label}
        </a>
      )
    ))}
  </div>
)}

Tags Meta SEO

O componente a seguir constrói tags meta de documento e Open Graph a partir das configurações do site:

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

interface Props {
  title?: string;
  description?: string;
  image?: string;
}

const settings = await getSiteSettings();
const {
  title,
  description = settings.tagline,
  image,
} = Astro.props;

const documentTitle = title
  ? `${title} | ${settings.title}`
  : settings.title;
const ogTitle = title ?? settings.title;
---

<title>{documentTitle}</title>
{description && <meta name="description" content={description} />}

<!-- Open Graph -->
<meta property="og:title" content={ogTitle} />
{description && <meta property="og:description" content={description} />}
{image && <meta property="og:image" content={image} />}
{settings.url && <meta property="og:url" content={settings.url + Astro.url.pathname} />}

<!-- Twitter -->
{settings.social?.twitter && (
  <meta name="twitter:site" content={settings.social.twitter} />
)}
<meta name="twitter:card" content={image ? "summary_large_image" : "summary"} />

Formatação de Data

Use as configurações dateFormat e timezone para exibição consistente de datas:

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

interface Props {
  date: string;
}

const { date } = Astro.props;
const dateFormat = await getSiteSetting("dateFormat") || "MMMM d, yyyy";
const timezone = await getSiteSetting("timezone") || "UTC";

// Formatar usando Intl.DateTimeFormat ou uma biblioteca como date-fns
const formatted = new Intl.DateTimeFormat("en-US", {
  timeZone: timezone,
  dateStyle: "long",
}).format(new Date(date));
---

<time datetime={date}>{formatted}</time>

API de Administração

Busque configurações programaticamente com uma requisição GET:

GET /_emdash/api/settings

A resposta é um objeto JSON das configurações:

{
	"title": "Meu Site EmDash",
	"tagline": "Um CMS moderno",
	"logo": {
		"mediaId": "med_123",
		"url": "/_emdash/api/media/file/abc123"
	},
	"postsPerPage": 10,
	"dateFormat": "MMMM d, yyyy",
	"timezone": "America/New_York",
	"social": {
		"twitter": "@handle",
		"github": "username"
	}
}

Atualizar configurações (atualizações parciais suportadas):

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

{
  "title": "Novo Título do Site",
  "tagline": "Slogan atualizado"
}

Apenas os campos fornecidos são alterados. Os campos omitidos mantêm seus valores atuais.

Referências de Mídia

As configurações logo e favicon armazenam referências de mídia. Quando você as lê, EmDash resolve a propriedade url automaticamente:

const logo = await getSiteSetting("logo");
// {
//   mediaId: "med_123",
//   alt: "Logo do site",
//   url: "/_emdash/api/media/file/abc123"
// }

Ao atualizar via API, forneça apenas o mediaId:

{
	"logo": {
		"mediaId": "med_456",
		"alt": "Novo logo"
	}
}

Referência da API

getSiteSettings()

Busca todas as configurações do site com URLs de mídia resolvidas.

Retorna: Promise<Partial<SiteSettings>>

Retorna um objeto parcial. Valores não definidos são undefined.

getSiteSetting(key)

Busca uma única configuração por chave.

Parâmetros:

  • key — A chave da configuração (por exemplo, "title", "logo", "social")

Retorna: Promise<SiteSettings[K] | undefined>

Type-safe: o tipo de retorno corresponde à chave que você solicita.