Pular para o conteúdo

Configurações do Site

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

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

src/layouts/Base.astro
---
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>

O EmDash fornece estas configurações principais:

interface SiteSettings {
// Identity
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)
}

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.

astro title="src/components/Header.astro"
---
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>
astro title="src/components/SocialLinks.astro"
---
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>
)}
astro title="src/components/SEO.astro"
---
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 pageTitle = title
? `${title} | ${settings.title}`
: settings.title;
---
<title>{pageTitle}</title>
{description && <meta name="description" content={description} />}
<!-- Open Graph -->
<meta property="og:title" content={pageTitle} />
{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"} />

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

astro title="src/components/PostDate.astro"
---
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";
// Formate 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>

Busque configurações de forma programática:

GET /_emdash/api/settings

Resposta:

{
"title": "My EmDash Site",
"tagline": "A modern CMS",
"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"
}
}

Atualize configurações (atualizações parciais são 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. Campos omitidos mantêm seus valores atuais.

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

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

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

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

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.

Busca uma única configuração por chave.

Parâmetros:

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

Retorna: Promise<SiteSettings[K] | undefined>

Tipagem segura: o tipo de retorno corresponde à chave que você solicita.