Publishing and Importing Projects
Publishing a Plasmic project enables you to reuse the components, styles, and images you’ve made in other projects.
- Edit the components, tokens, icons, and other assets in your project.
- When you’re ready to share your work, publish the project.
- Everyone that has view access to your project can now import the assets and use them in other projects. Imported assets are read-only snapshots and listed in the corresponding left panels, such as the Components and Style Tokens panels.
- You can continue to edit on your original upstream project without affecting the other downstream projects. Your edits will only become visible to others when you publish a new version. (All versions are visible in a detailed version history.)
- Collaborators are notified of the new version and can choose to update their imports to the latest published version.
- Consistent versions for imported projects: If a project appears in multiple places in a dependency tree, then they must be at the same exact version number. This ensures that we have consistent designs across the project (e.g. all buttons in a page look the same).
- Published versions share the same permissions as projects: Only collaborators with view-access to your project can import published versions.
- No circular dependencies: If Project A depends on Project B, Project B cannot depend on Project A anywhere in its dependency tree.
When you publish your project, you allow collaborators to use your project assets in other projects.
- Navigate to the “Published versions” tab in the left pane. Here, you can see a list of all versions you have published in the past.
- Click on the “Publish project” action button at the top.
- Optionally, enter a description to describe what work had been done since the last version. This summarizes for downstream consumers what has changed.
You may notice the version numbers like 0.1.2. These are automatically calculated by Plasmic and primarily hold meaning when developers sync components down to code. See Versioned Sync for more details.
All project versions will show up on the “Published versions” panel on the left in reverse chronological order.
You can view any project version by clicking on the entry. This will load a read-only snapshot of the project from that moment in time.
- Changes in read-only mode will not be saved
- You can return to edit mode either by clicking on the action button in the alert banner or reloading the studio
Now that you’ve published a version, let’s navigate to another project that might want to use the published assets.
- Navigate to the “Imported projects” pane on the left side in the target project
Import the project by entering its project ID to the dialog.
- The project ID can be found in the project’s URL e.g. 9pr9hBu15oVRTwBRL9Gnwi from https://studio.plasmic.app/projects/9pr9hBu15oVRTwBRL9Gnwi
Imported assets will now show up along side your local assets, which can be used in your designs.
Project assets that you import will not change unless you explicitly update them. You can check for updates in the “Imported projects” left tab. When the project has a newer version available, you should see an alert icon next to the dependency.
Click on the alert icon to update to the newest version.