draftMode
draftMode
es una función asíncrona que te permite habilitar y deshabilitar el Modo Borrador, así como verificar si el Modo Borrador está habilitado en un Componente de Servidor.
Referencia
Los siguientes métodos y propiedades están disponibles:
Método | Descripción |
---|---|
isEnabled | Valor booleano que indica si el Modo Borrador está habilitado. |
enable() | Habilita el Modo Borrador en un Manejador de Ruta estableciendo una cookie (__prerender_bypass ). |
disable() | Deshabilita el Modo Borrador en un Manejador de Ruta eliminando una cookie. |
Bueno saber
draftMode
es una función asíncrona que devuelve una promesa. Debes usarasync/await
o la funciónuse
de React.- En la versión 14 y anteriores,
draftMode
era una función síncrona. Para mantener la compatibilidad hacia atrás, aún puedes acceder a ella de forma síncrona en Next.js 15, pero este comportamiento quedará obsoleto en el futuro.
- En la versión 14 y anteriores,
- Se generará un nuevo valor de cookie de bypass cada vez que ejecutes
next build
. Esto asegura que la cookie de bypass no pueda ser adivinada. - Para probar el Modo Borrador localmente sobre HTTP, tu navegador deberá permitir cookies de terceros y acceso al almacenamiento local.
Ejemplos
Habilitando el Modo Borrador
Para habilitar el Modo Borrador, crea un nuevo Manejador de Ruta y llama al método enable()
:
Deshabilitando el Modo Borrador
Por defecto, la sesión del Modo Borrador termina cuando se cierra el navegador.
Para deshabilitar el Modo Borrador manualmente, llama al método disable()
en tu Manejador de Ruta:
Luego, envía una solicitud para invocar el Manejador de Ruta. Si llamas a la ruta usando el componente <Link>
, debes pasar prefetch={false}
para evitar eliminar accidentalmente la cookie durante el prefetch.
Verificando si el Modo Borrador está habilitado
Puedes verificar si el Modo Borrador está habilitado en un Componente de Servidor con la propiedad isEnabled
:
Historial de versiones
Versión | Cambios |
---|---|
v15.0.0-RC | draftMode ahora es una función asíncrona. Hay disponible un codemod. |
v13.4.0 | Se introdujo draftMode . |