Referencia de la API

`Astro` global

El objeto global Astro está disponible en todos los contextos en los archivos .astro. Tiene las siguientes funciones:

`Astro.glob()`

Astro.glob() es una forma de cargar archivos locales en la configuración de su página estática.

---
const posts = await Astro.glob('../pages/post/*.md'); // devuelve un array de artículos encontrados en ./src/pages/post/*.md
---

<div>
{posts.slice(0, 3).map((post) => (
  <article>
    <h2>{post.frontmatter.title}</h2>
    <p>{post.frontmatter.description}</p>
    <a href={post.url}>Read more</a>
  </article>
))}
</div>

.glob() solo toma un parámetro: la URL relativa de los archivos locales que te gustaría importar. Es asíncrono y devuelve un array con las exportaciones de los archivos coincidentes.

.glob() no puede tomar variables o strings que las interpolen, ya que no son analizables de manera estática. (Consulta la guía de solución de problemas para una solución alternativa.) Esto se debe a que Astro.glob() es un wrapper de la función import.meta.glob() de Vite.

También puedes utilizar import.meta.glob() directamente en tu proyecto de Astro. Es posible que quieras hacer esto cuando:

Necesitas esta característica en un archivo que no sea .astro, como una ruta API. Astro.glob() solamente está disponible en archivos .astro, mientras que import.meta.glob() es accesible en todo el proyecto.
No necesitas cargar cada archivo de inmediato. import.meta.glob() puede devolver funciones que importan el contenido del archivo, en vez de devolver el contenido en sí. Ten en cuenta que esta importación incluye todos los estilos y scripts de cualquier archivo importado. Estos serán agrupados y agregados a la página, ya sea que un archivo sea utilizado realmente o no. Esta decisión se toma mediante análisis estático, no en tiempo de ejecución.
Quieres acceder a la ruta de cada archivo. import.meta.glob() devuelve un map de la ruta del archivo a su contenido, mientras que Astro.glob() devuelve una lista de contenido.
Quieres pasar múltiples patrones; por ejemplo, quieres añadir un “patrón negativo” que filtra ciertos archivos. import.meta.glob() opcionalmente puede tomar un array de strings globales en vez de un solo string.

Lee más en la documentación de Vite.

Archivos Markdown

Los archivos Markdown tienen la siguiente interfaz:

export interface MarkdownInstance<T extends Record<string, any>> {
  /* Cualquier dato especificado en el frontmatter de YAML del archivo */
  frontmatter: T;
  /* La ruta del archivo */
  file: string;
  /* La ruta en donde se renderizará este archivo */
  url: string | undefined;
  /* Componente de Astro que renderizará el contenido del archivo */
  Content: AstroComponent;
  /* Función que devuelve un array de elementos h1...h6 del archivo */
  getHeadings(): Promise<{ depth: number; slug: string; text: string }[]>;
}

Opcionalmente, puedes proporcionar un tipo para la variable de frontmatter usando un tipo genérico de TypeScript.

---
interface Frontmatter {
  title: string;
  description?: string;
}
const posts = await Astro.glob<Frontmatter>('../pages/post/*.md');
---

<ul>
  {posts.map(post => <li>{post.frontmatter.title}</li>)}
</ul>

Archivos Astro

Los archivos Astro tienen la siguiente interfaz:

export interface AstroInstance {
  default: AstroComponent;
}

Otros archivos

Otros archivos pueden tener varias interfaces diferentes, pero Astro.glob() acepta un genérico de TypeScript si sabes exactamente qué tipo contiene un archivo no reconocido.

---
interface CustomDataFile {
  default: Record<string, any>;
}
const data = await Astro.glob<CustomDataFile>('../data/**/*.js');
---

`Astro.props`

Astro.props es un objeto que contiene cualquier valor que haya sido pasado como atributo de componente. Los componentes de plantilla para archivos .md y .mdx reciben valores de frontmatter como props.

---
const { title, date } = Astro.props;
---
<div>
  <h1>{title}</h1>
  <p>{date}</p>
</div>

---
import Heading from '../components/Heading.astro';
---
<Heading title="Mi Primer Artículo" date="09 Ago 2022" />

Aprende acerca de cómo se manejan las props en las Plantillas de Markdown y MDX.

Aprende cómo añadir definiciones de tipos de TypeScript para tus props.

`Astro.params`

Astro.params es un objeto que contiene los valores de segmentos de ruta dinámica que coincidan con esta petición.

En builds estáticos, esto serán los params devueltos por getStaticPaths() usados para prerrenderizar rutas dinámicas.

En builds SSR, esto puede ser cualquier valor que coincida con los segmentos de la ruta en el patrón de la ruta dinámica.

---
export function getStaticPaths() {
  return [
    { params: { id: '1' } },
    { params: { id: '2' } },
    { params: { id: '3' } }
  ];
}

const { id } = Astro.params;
---
<h1>{id}</h1>

Ver también: params

`Astro.request`

Astro.request es un objeto Request estándar. Se puede utilizar para obtener la url, headers, method e incluso el cuerpo de la solicitud.

<p>Recibí una solicitud {Astro.request.method} en "{Astro.request.url}".</p>
<p>Encabezados de solicitud recibidos:<code>{JSON.stringify(Object.fromEntries(Astro.request.headers))}</code>

Ver también: Astro.url

`Astro.response`

Astro.response es un objeto estándar ResponseInit. Tiene la siguiente estructura.

status: El código numérico de estado de la respuesta, p. ej. 200.
statusText: El mensaje de estado asociado con el código de estado, p. ej. 'OK'.
headers: Una instancia de Headers que puedes usar para establecer las cabeceras HTTP de la respuesta.

Astro.response se utiliza para establecer el status, statusText y headers de la respuesta de una página.

---
if(condition) {
  Astro.response.status = 404;
  Astro.response.statusText = 'Not found';
}
---

O para establecer un header:

---
Astro.response.headers.set('Set-Cookie', 'a=b; Path=/;');
---

`Astro.cookies`

Agregado en: astro@1.4.0

Astro.cookies contiene utilidades para leer y manipular cookies.

Tipo: (key: string, options?: CookieGetOptions) => AstroCookie

Consigue la cookie como un objeto AstroCookie, que contiene el value y funciones de utilidad para convertir la cookie a tipos no string.

`has`

Tipo: (key: string) => boolean

Si esta cookie existe. Si la cookie ha sido establecida a través de Astro.cookies.set() esto devolverá true, de lo contrario revisará las cookies en Astro.request.

`set`

Tipo: (key: string, value: string | number | boolean | object, options?: CookieSetOptions) => void

Configura la cookie key al valor dado. Esto intentará convertir el valor de la cookie a un string. Las opciones proveen maneras de establecer características de la cookie, como maxAge o httpOnly.

`delete`

Tipo: (key: string, options?: CookieDeleteOptions) => void

Marca la cookie como eliminada. Una vez que una cookie es eliminada, Astro.cookies.has() devolverá false y Astro.cookies.get() devolverá un AstroCookie con un value de undefined. Las opciones permiten establecer el domain y path de la cookie a eliminar.

`headers`

Tipo: () => Iterator<string>

Consigue los valores de cabecera para Set-Cookie que serán enviados con la respuesta.

`AstroCookie`

Obtener una cookie mediante Astro.cookies.get() retorna un tipo AstroCookie. Posee la siguiente estructura.

`value`

Tipo: string | undefined

El valor de la string sin procesar de la cookie.

`json`

Tipo: () => Record<string, any>

Analiza el valor de la cookie a través de JSON.parse(), devolviendo un objeto. Lanza un error si el valor de la cookie no es un JSON válido.

`number`

Tipo: () => number

Analiza el valor de la cookie como un número. Devuelve NaN si no es un número válido.

`boolean`

Tipo: () => boolean

Convierte el valor de la cookie a un booleano.

`CookieGetOptions`

Agregado en: astro@4.1.0

Conseguir una cookie también permite especificar opciones a través de la interfaz CookieGetOptions:

`decode`

Tipo: (value: string) => string

Permite personalizar cómo se deserializa una cookie en un valor.

`CookieSetOptions`

Agregado en: astro@4.1.0

Configurar una cookie a través de Astro.cookies.set() permite pasar un CookieSetOptions para personalizar cómo se serializa la cookie.

`domain`

Tipo: string

Especifica el dominio. Si no se establece un dominio, la mayoría de los clientes interpretarán que se aplica al dominio actual.

`expires`

Tipo: Date

Especia la fecha en la que la cookie expirará.

`httpOnly`

Tipo: boolean

Si es verdadero, la cookie no será accesible del lado del cliente.

`maxAge`

Tipo: number

Especifica un número, en segundos, para el cual la cookie es válida.

`path`

Tipo: string

Especifica una subruta del dominio en la que se aplica la cookie.

`sameSite`

Tipo: boolean | 'lax' | 'none' | 'strict'

Especifica el valor de la cabecera de cookie SameSite.

`secure`

Tipo: boolean

Si es verdadero, la cookie solo se establece en sitios https.

`encode`

Tipo: (value: string) => string

Permite personalizar cómo se serializa una cookie.

`Astro.redirect()`

Astro.redirect() te permite redireccionar a otra página. Una página (no un componente hijo) debe return (devolver) el resultado de Astro.redirect() para que la redirección ocurra.

---
import { isLoggedIn } from '../utils';
const cookie = Astro.request.headers.get('cookie');
// Si el usuario no está logueado, redirígelo a la página de login
if (!isLoggedIn(cookie)) {
  return Astro.redirect('/login');
}
---

`Astro.canonicalURL`

La URL canónica de la página actual.

`Astro.url`

Agregado en: astro@1.0.0-rc

Un objeto URL construido a partir del valor actual de la string URL Astro.request.url. Útil para interactuar con propiedades individuales de la URL de la solicitud, como la ruta o el origen.

Equivalente a hacer new URL (Astro.request.url).

<h1>La URL actual es: {Astro.url}</h1>
<h1>El nombre de la ruta URL actual es: {Astro.url.pathname}</h1>
<h1>El origen de la URL actual es: {Astro.url.origin}</h1>

También puedes usar Astro.url para crear nuevas URL pasándola como argumento a new URL().

---
// Ejemplo: construye una URL canónica usando tu dominio de producción
const canonicalURL = new URL(Astro.url.pathname, Astro.site);
// Ejemplo: construye una URL para metaetiquetas SEO usando tu dominio actual
const socialImageURL = new URL('/images/preview.png', Astro.url);
---
<link rel="canonical" href={canonicalURL} />
<meta property="og:image" content={socialImageURL} />

`Astro.clientAddress`

Agregado en: astro@1.0.0-rc

Especifica la dirección IP de la solicitud. Esta propiedad solo está disponible cuando se compila para SSR (renderizado en el servidor) y no debe usarse para sitios estáticos.

---
const ip = Astro.clientAddress;
---

<div>Tu dirección IP es: <span class="address">{ ip }</span></div>

`Astro.site`

Astro.site devuelve una URL generada desde site en su configuración de Astro. Si siteno esta definido en tu configuración Astro, Astro.site no estará definido.

`Astro.generator`

Agregado en: astro@1.0.0

Astro.generator es una manera conveniente de agregar una etiqueta <meta name="generator"> con tu versión actual de Astro. Responde al formato "Astro v1.x.x".

<html>
  <head>
    <meta name="generator" content={Astro.generator} />
  </head>
  <body>
    <footer>
      <p>Built with <a href="https://astro.build">{Astro.generator}</a></p>
    </footer>
  </body>
</html>

`Astro.slots`

Astro.slots contiene funciones de utilidad para modificar los hijos en slots de un componente Astro.

`Astro.slots.has()`

Tipo: (slotName: string) => boolean

Puedes verificar si el contenido para un slot específico existe usando Astro.slots.has(). Esto puede ser útil cuando quieres envolver el contenido del slot, pero solo quieres renderizar los elementos envueltos cuando se esté usando el slot.

---
---
<slot />

{Astro.slots.has('more') && (
  <aside>
    <h2>More</h2>
    <slot name="more" />
  </aside>
)}

`Astro.slots.render()`

Tipo: (slotName: string, args?: any[]) => Promise<string>

Puedes renderizar de forma asíncrona el contenido de un slot a un string de HTML usando Astro.slots.render().

---
const html = await Astro.slots.render('default');
---
<Fragment set:html={html} />

Astro.slots.render() opcionalmente acepta un segundo argumento: un array de parámetros que se enviarán a cualquier función hija. Esto puede ser útil para componentes de utilidad personalizados.

Por ejemplo, este componente <Shout /> convierte su prop message en mayúsculas y la pasa al slot predeterminado:

---
const message = Astro.props.message.toUpperCase();
let html = '';
if (Astro.slots.has('default')) {
  html = await Astro.slots.render('default', [message]);
}
---
<Fragment set:html={html} />

Una función callback pasada como hijo de <Shout /> recibirá el parámetro message en mayúsculas:

---
import Shout from "../components/Shout.astro";
---
<Shout message="slots!">
  {(message) => <div>{message}</div>}
</Shout>

<!-- renderiza como <div>SLOTS!</div> -->

`Astro.self`

Astro.self permite llamar recursivamente a los componentes de Astro. Este comportamiento te permite renderizar un componente de Astro desde dentro de sí mismo utilizando <Astro.self> en la plantilla del componente. Esto puede ser útil para iterar sobre grandes data stores y estructuras de datos anidadas.

---
const { items } = Astro.props;
---
<ul class="nested-list">
  {items.map((item) => (
    <li>
      <!-- Si hay una estructura de datos anidada renderizamos `<Astro.self>` -->
      <!-- y podemos pasar props a través de la llamada recursiva -->
      {Array.isArray(item) ? (
        <Astro.self items={item} />
      ) : (
        item
      )}
    </li>
  ))}
</ul>

Este componente podría usarse así:

---
import NestedList from './NestedList.astro';
---
<NestedList items={['A', ['B', 'C'], 'D']} />

Y renderizaría este HTML:

<ul class="nested-list">
  <li>A</li>
  <li>
    <ul class="nested-list">
      <li>B</li>
      <li>C</li>
    </ul>
  </li>
  <li>D</li>
</ul>

`Astro.locals`

Astro.locals es un objeto que contiene cualquier valor del objeto context.locals de un middleware. Utiliza esto para acceder a los datos devueltos por el middleware en tus archivos .astro.

---
const title = Astro.locals.welcomeTitle();
const orders = Array.from(Astro.locals.orders.entries());
---
<h1>{title}</h1>
<ul>
    {orders.map(order => {
        return <li>{/* hacer algo con cada pedido */}</li>
    })}
</ul>

Contexto del Endpoint

Las funciones de Endpoint reciben un objeto de contexto como primer parámetro. Posee muchas de las propiedades del objeto global Astro.

import type { APIContext } from 'astro';

export function GET(context: APIContext) {
  // ...
}

`context.locals`

context.locals es un objeto utilizado para almacenar y acceder a información arbitraria durante el ciclo de vida de una petición.

Las funciones de middleware pueden leer y escribir los valores de context.locals:

import type { MiddlewareResponseHandler } from 'astro';
export const onRequest: MiddlewareResponseHandler = ({ locals }, next) => {
  if (!locals.title) {
    locals.title = "Título por defecto";
  }
  return next();
}

Los endpoints de la API sólo pueden leer información de context.locals.:

import type { APIContext } from 'astro';

export function GET({ locals }: APIContext) {
  return {
    body: locals.title // "Título por defecto"
  }
}

Ver también: Astro.locals

`context.params`

context.params es un objeto que contiene los valores de los segmentos de la ruta dinámica que coincidan con esta petición.

En builds estáticos, esto serán los params devueltos por getStaticPaths() usados para prerrenderizar rutas dinámicas.

En builds SSR, esto puede ser cualquier valor que coincida con los segmentos de la ruta en el patrón de la ruta dinámica.

import type { APIContext } from 'astro';

export function getStaticPaths() {
  return [
    { params: { id: '1' } },
    { params: { id: '2' } },
    { params: { id: '3' } }
  ];
}

export function GET({ params }: APIContext) {
  return {
    body: JSON.stringify({ id: params.id }),
  };
}

Ver también: params

`context.props`

context.props es un objeto que contiene las props pasadas desde getStaticPaths(). Como getStaticPaths() no se utiliza durante la generación en SSR (server-side rendering), context.props solamente está disponible en builds estáticos.

import type { APIContext } from 'astro';

export function getStaticPaths() {
  return [
    { params: { id: '1' }, props: { author: 'Blu' } },
    { params: { id: '2' }, props: { author: 'Erika' } },
    { params: { id: '3' }, props: { author: 'Matthew' } },
  ];
}

export function GET({ props }: APIContext) {
  return {
    body: JSON.stringify({ author: props.author }),
  };
}

Ver también: Transferencia de datos con props

`context.request`

Un objeto Request estándar. Puede ser usado para obtener la url, headers, method y también el body de la petición.

import type { APIContext } from 'astro';

export function GET({ request }: APIContext) {
  return {
    body: `Hola ${request.url}`,
  };
}

Ver también: Astro.request

`context.cookies`

context.cookies contiene utilidades para leer y manipular cookies.

Ver también: Astro.cookies

`context.url`

Un objeto URL generado desde el valor actual de la string URL context.request.url.

Ver también: Astro.url

`context.clientAddress`

Especifica la dirección IP de la petición. Esta propiedad solamente está disponible durante la generación en SSR (server-side rendering) y no debe ser utilizado en sitios estáticos.

import type { APIContext } from 'astro';

export function GET({ clientAddress }: APIContext) {
  return {
    body: `Tu dirección IP es: ${clientAddress}`,
  };
}

Ver también: Astro.clientAddress

`context.site`

context.site devuelve una URL generada desde el site en tu configuración de Astro. Si no está definido, devolverá una URL generada desde localhost.

Ver también: Astro.site

`context.generator`

context.generator es una manera conveniente de indicar la versión de Astro que esté corriendo tu proyecto. Posee el formato "Astro v1.x.x".

import type { APIContext } from 'astro';

export function GET({ generator, site }: APIContext) {
  const body = JSON.stringify({ generator, site });
  return new Response(body);
}

Ver también: Astro.generator

`context.redirect()`

context.redirect() devuelve un objeto Response que te permite redirigir al usuario a otra página. Esta función solamente está disponible durante la generación en SSR (server-side rendering) y no debe ser utilizado en sitios estáticos.

import type { APIContext } from 'astro';

export function GET({ redirect }: APIContext) {
  return redirect('/login', 302);
}

Ver también: Astro.redirect()

`getStaticPaths()`

Si una página usa parámetros dinámicos en el nombre del archivo, ese componente necesitará exportar una función getStaticPaths().

Esta función es necesaria porque Astro es un creador de sitios estáticos. Eso significa que todo su sitio se construye con anticipación. Si Astro no sabe generar una página en el momento de la creación, sus usuarios no la verán cuando visiten tu sitio.

---
export async function getStaticPaths() {
  return [
    { params: { /* requerido */ }, props: { /* opcional */ } },
    { params: { ... } },
    { params: { ... } },
    // ...
  ];
}
---
<!-- Tu maquetado HTML aquí. -->

La función getStaticPaths() debe devolver un array de objetos para determinar qué rutas serán prerenderizadas por Astro.

También puede ser usado en endpoints de archivo estáticos para enrutamiento dinámico.

`params`

La key params de cada objeto devuelto le dice a Astro qué rutas construir. Los parámetros devueltos deben corresponder con los parámetros dinámicos y los parámetros comodín definidos en la ruta de archivo de su componente.

Los params están codificados en la URL, por lo que solo se admiten strings como valores. El valor de cada objeto params debe coincidir con los parámetros utilizados en el nombre de la página.

Por ejemplo, supongamos que tienes una página en src/pages/posts/[id].astro. Si exportas getStaticPaths desde esta página y devuelves lo siguiente para las rutas:

---
export async function getStaticPaths() {
  return [
    { params: { id: '1' } },
    { params: { id: '2' } },
    { params: { id: '3' } }
  ];
}

const { id } = Astro.params;
---
<h1>{id}</h1>

Luego, Astro generará estáticamente posts/1, posts/2 y posts/3 en el momento de la compilación.

Transferencia de datos con `props`

Para pasar datos adicionales a cada página generada, también puedes establecer un valor props en cada objeto de ruta devuelto. A diferencia de params, props no están codificados en la URL y, por lo tanto, no están limitados a solamente strings.

Por ejemplo, suponiendo que generas páginas basadas en datos obtenidos de una API remota. Puedes pasar el objeto de datos completo al componente de página dentro de getStaticPaths:

---
export async function getStaticPaths() {
  const data = await fetch('...').then(response => response.json());

  return data.map((post) => {
    return {
      params: { id: post.id },
      props: { post },
    };
  });
}

const { id } = Astro.params;
const { post } = Astro.props;
---
<h1>{id}: {post.name}</h1>

También puedes pasar un array regular, que puede ser útil al generar o agregar una lista conocida de rutas.

---
export async function getStaticPaths() {
  const posts = [
    {id: '1', category: "astro", title: "API Reference"},
    {id: '2', category: "react", title: "Creating a React Counter!"}
  ];
  return posts.map((post) => {
    return {
      params: { id: post.id },
      props: { post }
    };
  });
}
const {id} = Astro.params;
const {post} = Astro.props;
---
<body>
  <h1>{id}: {post.title}</h1>
  <h2>Categoría: {post.category}</h2>
</body>

Luego, Astro generará estáticamente posts/1 y posts/2 en el momento de la compilación usando el componente de página en pages/posts/[id].astro. La página puede hacer referencia a estos datos usando Astro.props:

`paginate()`

La paginación es un caso de uso común para los sitios web que Astro admite de forma nativa a través de la función paginate(). paginate() generará automáticamente un array para devolver desde getStaticPaths() que creará una URL para cada página de la colección paginada. El número de página se pasará como un parámetro, y los datos de la página se pasarán como una prop page.

export async function getStaticPaths({ paginate }) {
  // Carga tus datos con fetch(), Astro.glob(), etc.
  const response = await fetch(`https://pokeapi.co/api/v2/pokemon?limit=150`);
  const result = await response.json();
  const allPokemon = result.results;

  // Devuelve una colección paginada de rutas para todos los artículos.
  return paginate(allPokemon, { pageSize: 10 });
}

// Si se configuró correctamente, La prop de la página ahora tiene todo lo que
// necesita para renderizar una página (mira la siguiente sección).
const { page } = Astro.props;

paginate() asume un nombre de archivo [page].astro o [...page].astro. El parámetro page se convierte en el número de página en la URL:

/posts/[page].astro generaría las URL /posts/1, /posts/2, /posts/3, etc.
/posts/[...page].astro generaría las URL /posts, /posts/2, /posts/3, etc.

paginate() tiene los siguientes argumentos:

pageSize - El numero de artículos mostrados por página
params - Envía parámetros adicionales para la creación rutas dinámicas
props - Envía props adicionales para que estén disponibles en cada página

La prop de paginación `page`

La paginación pasará una prop page a cada página renderizada que represente una sola página de datos en la colección paginada. Esto incluye los datos que ha paginado (page.data), así como los metadatos de la página (page.url, page.start, page.end, page.total, etc.). Estos metadatos son útiles para cosas como un botón “Página siguiente” o un mensaje “Mostrando 1-10 de 100”.

`page.data`

Tipo: Array

Array de datos devueltos de data() para la página actual.

`page.start`

Tipo: number

Índice del primer elemento en la página actual, comenzando en 0. (p. ej. si pageSize: 25, esto sería 0 en la página 1, 25 en la página 2, etc.)

`page.end`

Tipo: number

Índice del último elemento en la página actual.

`page.size`

Tipo: number

Indica cuantos hay elementos por página.

`page.total`

Tipo: number

El número total de elementos en todas las páginas.

`page.currentPage`

Tipo: number

El número de página actual, comenzando en 1.

`page.lastPage`

Tipo: number

El número total de páginas.

`page.url.current`

Tipo: string

Consigue la URL de la página actual (útil para URLs canónicas).

`page.url.prev`

Tipo: string | undefined

Consigue la URL de la página anterior (será undefined si está en la página 1).

`page.url.next`

Tipo: string | undefined

Consigue la URL de la página siguiente (será undefined si no hay más páginas).

`import.meta`

Todos los módulos ESM incluyen una propiedad import.meta. Astro agrega import.meta.env a través de Vite.

import.meta.env.SSR se puede usar para saber cuándo se renderiza en el servidor. A veces, es posible que desees una lógica diferente, por ejemplo, un componente que solo debe representarse en el cliente:

export default function () {
  return import.meta.env.SSR ? <div class="spinner"></div> : <FancyComponent />;
}

Imágenes (`astro:assets`)

getImage()

La función getImage() está diseñada para generar imágenes destinadas a ser utilizadas en algún lugar que no sea directamente en HTML, por ejemplo, en una Ruta de API. También te permite crear tu propio componente <Image /> personalizado.

getImage() recibe un objeto de opciones con las mismas propiedades que el componente Image (excepto alt).

---
import { getImage } from "astro:assets";
import myBackground from "../background.png"
const optimizedBackground = await getImage({src: myBackground, format: 'avif'})
---
<div style={`background-image: url(${optimizedBackground.src});`}></div>

Devuelve un objeto con las siguientes propiedades:

{
  options: {...} // Parámetros originales pasados
  src: "https//..." // Ruta de la imagen generada
  attributes: {...} // Atributos HTML adicionales necesarios para renderizar la imagen (width, height, style, etc..)
}

Colecciones de Contenido (`astro:content`)

Agregado en: astro@2.0.0

Las colecciones de contenido ofrecen APIs para configurar y consultar tus documentos Markdown o MDX en src/content/. Para obtener características y ejemplos de uso, consulta nuestra guía de colecciones de contenido.

`defineCollection()`

defineCollection() es una utilidad para configurar una colección en un archivo src/content/config.*.

import { z, defineCollection } from 'astro:content';
const blog = defineCollection({
  type: 'content',
  schema: z.object({
    title: z.string(),
    permalink: z.string().optional(),
  }),
});
// Expone tu colección definida a Astro
// con el export `collections`
export const collections = { blog };

Esta función acepta las siguientes propiedades:

`type`

Agregado en: astro@2.5.0

Tipo: 'content' | 'data'
Por defecto: 'content'

type es un string que define el tipo de entradas almacenadas dentro de una colección:

'content' - para formatos de creación de contenido como Markdown (.md), MDX (.mdx) o Markdoc (.mdoc)
'data' - para formatos de datos únicamente como JSON (.json) o YAML (.yaml)

`schema`

Type: TSchema extends ZodType

El schema es un objeto de Zod opcional para configurar el tipo y la forma del frontmatter del documento para una colección. Cada valor debe usar un validador de Zod.

Consulta la guía de Colección de Contenido para ejemplos de uso.

`reference()`

Tipo: (collection: string) => ZodEffects<ZodString, { collection, id: string } | { collection, slug: string }>

La función reference() se utiliza en la configuración del contenido para definir una relación, o “referencia” de una colección a otra. Esta función acepta el nombre de la colección y valida el identificador/es de entrada especificados en el frontmatter o archivo de datos del contenido.

Este ejemplo define referencias desde un autor de blog a la colección authors y a un arreglo de publicaciones relacionadas en la misma colección blog:

import { defineCollection, reference, z } from 'astro:content';
const blog = defineCollection({
  type: 'content',
  schema: z.object({
    // Hace referencia a un único autor de la colección `authors` mediante el campo `id`.
    author: reference('authors'),
    // Hace referencia a un arreglo de publicaciones relacionadas de la colección `blog` mediante el campo `slug`.
    relatedPosts: z.array(reference('blog')),
  })
});
const authors = defineCollection({
  type: 'data',
  schema: z.object({ /* ... */ })
});
export const collections = { blog, authors };

Consulta la guía de Content Collection para ver un ejemplo de uso.

`getCollection()`

Type: (collection: string, filter?: (entry: CollectionEntry<collection>) => boolean) => CollectionEntry<collection>[]

getCollections() es una función que recupera una lista de entradas de colección de contenido por nombre de colección.

Regresa todos los elementos en la colección por defecto, y acepta una función opcional filter para reducir por propiedades de entrada. Esto te permite consultar solo algunos elementos en una colección basándose en id, slug, o valores de frontmatter a través del objeto data.

---
import { getCollection } from 'astro:content';
// Obtiene todas las entradas de `src/content/blog/`
const allBlogPosts = await getCollection('blog');
// Solo regresa artīculos con `draft: true` en el frontmatter
const draftBlogPosts = await getCollection('blog', ({ data }) => {
  return data.draft === true;
});
---

Consulta la sección de guía de getCollection() para ejemplos de uso completo.

`getEntry()`

Agregado en: astro@2.5.0

Tipos:

(collection: string, contentSlugOrDataId: string) => CollectionEntry<collection>
({ collection: string, id: string }) => CollectionEntry<collection>
({ collection: string, slug: string }) => CollectionEntry<collection>

getEntry() es una función que recupera una única entrada de una colección mediante el nombre de la colección y ya sea el id de la entrada (para colecciones type: 'data') o el slug de la entrada (para colecciones type: 'content'). getEntry() también se puede utilizar para obtener las entradas referenciadas y acceder a las propiedades data, body o render():

---
import { getEntry } from 'astro:content';
// Obtiene `src/content/blog/enterprise.md`
const enterprisePost = await getEntry('blog', 'enterprise');
// Obtiene `src/content/captains/picard.yaml`
const picardProfile = await getEntry('captains', 'picard');
// Obtener el perfil referenciado por `data.captain`
const enterpriseCaptainProfile = await getEntry(enterprise.data.captain);
---

Consulta la guía de “Colecciones de Contenido” para ver ejemplos de consulta de entradas de colecciones.

`getEntries()`

Agregado en: astro@2.5.0

Tipos:

(Array<{ collection: string, id: string }>) => Array<CollectionEntry<collection>>
(Array<{ collection: string, slug: string }>) => Array<CollectionEntry<collection>>

getEntries() es una función que recupera múltiples entradas de una misma colección. Esto es útil para devolver un arreglo de entradas referenciadas para acceder a sus propiedades asociadas data, body y render().

---
import { getEntries } from 'astro:content';
const enterprisePost = await getEntry('blog', 'enterprise');
// Obtener las publicaciones relacionadas referenciadas por `data.relatedPosts`
const enterpriseRelatedPosts = await getEntries(enterprisePost.data.relatedPosts);
---

`getEntryBySlug()`

Tipo: (collection: string, slug: string) => CollectionEntry<collection>

getEntryBySlug() is a function that retrieves a single collection entry by collection name and entry slug.

---
import { getEntryBySlug } from 'astro:content';
const enterprise = await getEntryBySlug('blog', 'enterprise');
---

Consulta la guía Content Collection para ver un ejemplo de uso.

Tipo de Entrada de la Colección

Las funciones de consulta, incluyendo getCollection(), getEntry() y getEntries(), devuelven entradas con el tipo CollectionEntry. Este tipo está disponible como una utilidad desde astro:content:

import type { CollectionEntry } from 'astro:content';

// Ejemplo: Recibe una entrada de `src/content/blog/` como props
type Props = CollectionEntry<'blog'>;

Una CollectionEntry<TCollectionName> es un objeto con los siguientes valores:

`id`

Disponible para: type: 'content' and type: 'data' collections
Tipos de ejemplo:

colecciones de contenido: 'entry-1.md' | 'entry-2.md' | ...
colecciones de datos: 'author-1' | 'author-2' | ...

Un identificador único que usa la ruta de archivo relativa a src/content/[collection]. Enumera todos los posibles valores de cadena basados en las rutas de archivo de entrada de colección. Ten en cuenta que las colecciones definidas como type: 'content' incluyen la extensión de archivo en su ID, mientras que las colecciones definidas como type: 'data' no lo hacen.

`collection`

Disponible para: type: 'content' and type: 'data' collections
Tipo de ejemplo: 'blog' | 'authors' | ...

El nombre de una carpeta de nivel superior en src/content/ en la cual se encuentran las entradas. Este es el nombre utilizado para hacer referencia a la colección en tu esquema y en las funciones de consulta.

`data`

Disponible para: tipo: 'content' y tipo: collecciones 'data'
Tipo: CollectionSchema<TCollectionName>

Un objeto de propiedades de frontmatter inferidas de su esquema de colección (ver referencia de defineCollection()). Por defecto es any si no es configurado un esquema.

`slug`

Disponible para: type: 'content' collections only
Tipo de ejemplo: 'entry-1' | 'entry-2' | ...

Un slug listo para ser utilizado en una URL para documentos Markdown o MDX. Por defecto, se genera a partir del id sin la extensión de archivo, pero se puede modificar estableciendo la propiedad slug en el frontmatter del archivo.

`body`

Disponible para: tipo: 'content' solo colecciones Tipo: string

Un string que contiene el cuerpo sin compilar del documento Markdown o MDX.

`render()`

Disponible para: type: 'content' solo colecciones Tipo: () => Promise<RenderedEntry>

Una función para compilar un documento Markdown o MDX dado para su renderizado. Regresa las siguientes propiedades:

<Content /> - Un componente usado para renderizar el contenido del documento en un archivo Astro.
headings - Una lista generada de encabezados, que refleja la utilidad getHeadings() de Astro en las importaciones de Markdown y MDX.
remarkPluginFrontmatter - El objeto frontmatter es moficado después de aplicar los plugins de remark o rehype ha sido aplicado. Configurado para el tipo any.

---
import { getEntry } from 'astro:content';
const entry = await getEntry('blog', 'entry-1.md');
const {Content, headings, remarkPluginFrontmatter} = await entry.render();
---

Ver la guía de renderizado de contenido de entrada para ejemplos de uso completo.

Otros tipos de colecciones de contenido

El módulo astro:content también exporta los siguientes tipos para su uso en tu proyecto Astro:

`CollectionKey`

Una unión de strings de todos los nombres de colecciones definidos en tu archivo src/content/config.*. Este tipo puede ser útil al definir una función genérica que acepta cualquier nombre de colección.

import type { CollectionKey, getCollection } from 'astro:content';

async function getCollection(collection: CollectionKey) {
  return getCollection(collection);
}

`ContentCollectionKey`

Una unión de strings de todos los nombres de colecciones con type: 'content' definidos en tu archivo src/content/config.*.

`DataCollectionKey`

Una unión de strings de todos los nombres de colecciones con type: 'data' definidos en tu archivo src/content/config.*.

`SchemaContext`

El objeto context que defineCollection utiliza para dar forma a la función de schema. Este tipo puede ser útil al construir esquemas reutilizables para múltiples colecciones.

Incluye la siguiente propiedad:

image - El helper de esquema image() que te permite utilizar imágenes locales en colecciones de contenido.

import type { SchemaContext } from 'astro:content';

export const imageSchema = ({ image }: SchemaContext) =>
    z.object({
        image: image(),
        description: z.string().optional(),
    });

const blog = defineCollection({
  type: 'content',
  schema: ({ image }) => z.object({
    title: z.string(),
    permalink: z.string().optional(),
    image: imageSchema({ image })
  }),
});

Middleware (`astro:middleware`)

Agregado en: astro@2.6.0

El middleware te permite interceptar las peticiones y respuestas e inyectar comportamientos dinámicos cada vez que una página o un endpoint está a punto de ser renderizado. Para obtener características y ejemplos de uso, consulta nuestra guía de middleware.

`onRequest()`

Una función exportada requerida de src/middleware.js que se llamará antes de renderizar cada página o ruta de API. Acepta dos argumentos opcionales: context y next(). onRequest() debe devolver una Response: ya sea directamente, o llamando a next().

export function onRequest (context, next) {
    // intercepta los datos de respuesta de una petición
    // opcionalmente, transforma la respuesta
    // regresa una respuesta directamente o el resultado de llamar a `next()`
    return next();
};

`next()`

Una función que intercepta (lee y modifica) la Response de una Request o llama al siguiente middleware en la cadena y devuelve una Response. Por ejemplo, esta función podría modificar el cuerpo HTML de una respuesta.

Esto es un argumento opcional de onRequest(), y puede proporcionar la Response requerida devuelta por el middleware.

`sequence()`

Una función que acepta funciones de middleware como argumentos y las ejecutará en el orden en que se pasan.

import { sequence } from "astro:middleware";

async function validation(_, next) {...}
async function auth(_, next) {...}
async function greeting(_, next) {...}

export const onRequest = sequence(validation, auth, greeting);

`createContext()`

Una API de bajo nivel para crear un APIContext para ser pasado a una función onRequest() de middleware de Astro.

Esta función puede ser utilizada por integraciones/adaptadores para ejecutar programáticamente el middleware de Astro.

`trySerializeLocals()`

Una API de bajo nivel que toma cualquier valor y trata de devolver una versión serializada (un string) de él. Si el valor no se puede serializar, la función lanzará un error en tiempo de ejecución.

Componentes incorporados

Astro incluye varios componentes integrados que puedes usar en tus proyectos. Todos los componentes integrados están disponibles en archivos .astro a través de import {} from 'astro:components';.

`<Code />`

---
import { Code } from 'astro:components';
---
<!-- Resaltado de sintaxis de algún código JavaScript. -->
<Code code={`const foo = 'bar';`} lang="js" />
<!-- Opcional: personaliza tu tema. -->
<Code code={`const foo = 'bar';`} lang="js" theme="dark-plus" />
<!-- Opcional: habilita css wrap -->
<Code code={`const foo = 'bar';`} lang="js" wrap />
<!-- Opcional: salida de código en línea -->
<p>
  <Code code={`const foo = 'bar';`} lang="js" inline />
  will be rendered inline.
</p>

Este componente proporciona resaltado de sintaxis para bloques de código en el momento de la compilación (no incluye JavaScript del lado del cliente). El componente funciona internamente con Shiki y es compatible con todos los temas populares y lenguajes de programación. Además, puedes agregar temas y lenguajes de programación personalizados modificando theme y lang respectivamente.

`<Fragment />`

Un componente utilizado con las directivas set:* para representar contenido HTML sin elementos de envoltura adicionales:

---
const htmlString = '<p>Contenido HTML en bruto</p>';
---
<Fragment set:html={htmlString} />

Consulta más información sobre el uso de fragmentos en la sintaxis de Astro.

`<Prism />`

Para usar el componente resaltador Prism, primero instala el paquete @astrojs/prism:

npm install @astrojs/prism

pnpm install @astrojs/prism

yarn add @astrojs/prism

---
import { Prism } from '@astrojs/prism';
---
<Prism lang="js" code={`const foo = 'bar';`} />

Este componente proporciona resaltado de sintaxis específico con el lenguaje de programación para bloques de código al aplicar las clases CSS de Prism. Ten en cuenta que debes proporcionar una hoja de estilo Prism CSS (o traer la tuya propia) para que aparezca el resaltado de sintaxis. Consulta la sección de configuración de Prism para obtener más detalles.

Consulta la lista de idiomas admitidos por Prism donde puedes encontrar el alias correspondiente de un idioma. ¡Y también puedes mostrar tus bloques de código Astro con lang="astro"!

`<Image />`

---
// Importa el componente Image y la imagen
import { Image } from 'astro:assets';
import myImage from "../assets/my_image.png"; // La imagen es 1600x900
---
<!-- `alt` es obligatorio en el componente Image -->
<Image src={myImage} alt="Una descripción de mi imagen." />

<!-- Salida -->
<!-- La imagen está optimizada y se aplican atributos adecuados -->
<img
  src="/_astro/my_image.hash.webp"
  width="1600"
  height="900"
  decoding="async"
  loading="lazy"
  alt="Una descripción de mi imagen."
/>

Propiedades

src (requerido)
alt (requerido)
width y height (requerido para imágenes public/ y remotas)
format
quality
densities
widths

Además de las propiedades mencionadas anteriormente, el componente <Image /> acepta todas las propiedades aceptadas por la etiqueta HTML <img>.

Mira más en la guía de imágenes.

`<Picture />`

Agregado en: astro@3.3.0

Utiliza el componente integrado <Picture /> de Astro para mostrar una imagen responsiva con varios formatos y/o tamaños.

---
import { Picture } from 'astro:assets';
import myImage from "../assets/my_image.png"; // La imagen es 1600x900
---
<!-- `alt` es obligatorio en el componente Image -->
<Picture src={myImage} formats={['avif', 'webp']} alt="Una descripción de mi imagen." />

<!-- Salida -->
<picture>
  <source srcset="/_astro/my_image.hash.avif" type="image/avif" />
  <source srcset="/_astro/my_image.hash.webp" type="image/webp" />
  <img
    src="/_astro/my_image.hash.png"
    width="1600"
    height="900"
    decoding="async"
    loading="lazy"
    alt="Una descripción de mi imagen."
  />
</picture>

Mira más en la guía de imágenes.

Propiedades

<Picture /> acepta todas las propiedades del componente <Image />, además de las siguientes:

`formats`

Un array de formatos de imagen para usar en las etiquetas <source>. De forma predeterminada, esto está configurado como ['webp'].

`fallbackFormat`

Formato que se utilizará como valor de respaldo para la etiqueta <img>. De forma predeterminada, se establece en .png para imágenes estáticas, .gif para imágenes animadas y .svg para archivos SVG.

`pictureAttributes`

Un objeto de atributos que se agregarán a la etiqueta <picture>. Utiliza esta propiedad para aplicar atributos al propio elemento <picture>. Los atributos aplicados directamente al componente <Picture /> se aplicarán al elemento <img> interno, excepto aquellos utilizados para la transformación de la imagen.

`<Content />`

Un componente genérico utilizado para representar el contenido de una entrada de colección de contenido.

Primero, consulta una o varias entradas utilizando getCollection() o getEntry(). Entonces, la función entry.render() puede devolver el componente <Content /> para utilizarlo en una plantilla de archivo .astro.

---
import { getEntry } from 'astro:content';
const entry = await getEntry('blog', 'post-1');
const { Content } = await entry.render();
---
<p>Publicado el: {entry.data.published.toDateString()}</p>
<Content />

`<ViewTransitions />`

Opta por utilizar view transitions en páginas individuales importando y agregando el componente de enrutamiento <ViewTransitions /> en la etiqueta <head> de cada página deseada.

---
import { ViewTransitions } from 'astro:transitions';
---
<html lang="es">
  <head>
    <title>Mi página de inicio</title>
    <ViewTransitions />
  </head>
  <body>
    <h1>¡Bienvenido a mi página web!</h1>
  </body>
</html>

Mira más acerca de cómo controlar el enrutador y añadir directivas de transición a elementos de página y componentes.

`<Debug />`

---
import { Debug } from 'astro:components';
const serverObject = {
  a: 0,
  b: "string",
  c: {
    nested: "object"
  }
}
---
<Debug {serverObject} />

Este componente proporciona una forma de inspeccionar valores en el lado del cliente, sin JavaScript.

Referencia de la API

Astro global

Astro.glob()

Archivos Markdown

Archivos Astro

Otros archivos

Astro.props

Astro.params

Astro.request

Astro.response

Astro.cookies

has

set

delete

headers

AstroCookie

value

json

number

boolean

CookieGetOptions

decode

CookieSetOptions

domain

expires

httpOnly

maxAge

path

sameSite

secure

encode

Astro.redirect()

Astro.canonicalURL

Astro.url

Astro.clientAddress

Astro.site

Astro.generator

Astro.slots

Astro.slots.has()

Astro.slots.render()

Astro.self

Astro.locals

Contexto del Endpoint

context.locals

context.params

context.props

context.request

context.cookies

context.url

context.clientAddress

context.site

context.generator

context.redirect()

getStaticPaths()

params

Transferencia de datos con props

paginate()

La prop de paginación page

page.data

page.start

page.end

page.size

page.total

page.currentPage

page.lastPage

page.url.current

page.url.prev

page.url.next

import.meta

Imágenes (astro:assets)

getImage()

Colecciones de Contenido (astro:content)

defineCollection()

type

schema

reference()

getCollection()

getEntry()

getEntries()

getEntryBySlug()

`Astro` global

`Astro.glob()`

`Astro.props`

`Astro.params`

`Astro.request`

`Astro.response`

`Astro.cookies`

`has`

`set`

`delete`

`headers`

`AstroCookie`

`value`

`json`

`number`

`boolean`

`CookieGetOptions`

`decode`

`CookieSetOptions`

`domain`

`expires`

`httpOnly`

`maxAge`

`path`

`sameSite`

`secure`

`encode`

`Astro.redirect()`

`Astro.canonicalURL`

`Astro.url`

`Astro.clientAddress`

`Astro.site`

`Astro.generator`

`Astro.slots`

`Astro.slots.has()`

`Astro.slots.render()`

`Astro.self`

`Astro.locals`

`context.locals`

`context.params`

`context.props`

`context.request`

`context.cookies`

`context.url`

`context.clientAddress`

`context.site`

`context.generator`

`context.redirect()`

`getStaticPaths()`

`params`

Transferencia de datos con `props`

`paginate()`

La prop de paginación `page`

`page.data`

`page.start`

`page.end`

`page.size`

`page.total`

`page.currentPage`

`page.lastPage`

`page.url.current`

`page.url.prev`

`page.url.next`

`import.meta`

Imágenes (`astro:assets`)

Colecciones de Contenido (`astro:content`)

`defineCollection()`

`type`

`schema`

`reference()`

`getCollection()`

`getEntry()`

`getEntries()`

`getEntryBySlug()`

`id`

`collection`

`data`

`slug`

`body`

`render()`