PlasmicLoader options reference

These are the set of options you can pass into a PlasmicLoader plugin invocation in your next.config.js or gatsby-config.js.

These options are also available in the new plasmic-loader.json.

PropDefaultDescription
projectsNone (Only required setting!)An array with the projects to sync.
dirCurrent working directory.The root directory of your project.
plasmicDir.cache/.plasmic (Gatsby)
.plasmic (Next)
Plasmic will sync your plasmic projects to this directory.
pageDirsrc/pages (Gatsby)
pages(Next)
A directory with your existing pages.
watchTrue (in development)
False otherwise.
Listen to changes in your plasmic project and sync them to your codebase.
initArgsPlatform-dependent.Plasmic is able to detect your codebase language (js, tsx) and comes with good defaults for public folder, image assets, css mode and other options. Click here for a full list. To override something, pass an object with the key being plasmic CLI’s flag name and the corresponding value.
substitutionsNoneClick here. for more information regarding component substitution.

Give feedback on this page