draftMode
draftMode
est une fonction asynchrone qui vous permet d'activer et de désactiver le Mode Brouillon, ainsi que de vérifier si le Mode Brouillon est activé dans un Composant Serveur.
Référence
Les méthodes et propriétés suivantes sont disponibles :
Méthode | Description |
---|---|
isEnabled | Une valeur booléenne indiquant si le Mode Brouillon est activé. |
enable() | Active le Mode Brouillon dans un gestionnaire de route en définissant un cookie (__prerender_bypass ). |
disable() | Désactive le Mode Brouillon dans un gestionnaire de route en supprimant un cookie. |
Bon à savoir
draftMode
est une fonction asynchrone qui renvoie une promesse. Vous devez utiliserasync/await
ou la fonctionuse
de React.- Dans la version 14 et antérieures,
draftMode
était une fonction synchrone. Pour assurer la compatibilité ascendante, vous pouvez toujours y accéder de manière synchrone dans Next.js 15, mais ce comportement sera déprécié à l'avenir.
- Dans la version 14 et antérieures,
- Une nouvelle valeur de cookie de contournement sera générée à chaque exécution de
next build
. Cela garantit que le cookie de contournement ne peut pas être deviné. - Pour tester le Mode Brouillon localement via HTTP, votre navigateur devra autoriser les cookies tiers et l'accès au stockage local.
Exemples
Activation du Mode Brouillon
Pour activer le Mode Brouillon, créez un nouveau Gestionnaire de Route et appelez la méthode enable()
:
Désactivation du Mode Brouillon
Par défaut, la session du Mode Brouillon se termine lorsque le navigateur est fermé.
Pour désactiver manuellement le Mode Brouillon, appelez la méthode disable()
dans votre Gestionnaire de Route :
Envoyez ensuite une requête pour invoquer le Gestionnaire de Route. Si vous appelez la route en utilisant le composant <Link>
, vous devez passer prefetch={false}
pour éviter de supprimer accidentellement le cookie lors du préchargement.
Vérification de l'activation du Mode Brouillon
Vous pouvez vérifier si le Mode Brouillon est activé dans un Composant Serveur avec la propriété isEnabled
:
Historique des versions
Version | Modifications |
---|---|
v15.0.0-RC | draftMode est désormais une fonction asynchrone. Un codemod est disponible. |
v13.4.0 | Introduction de draftMode . |