@prismicio/slice-simulator-react

@prismicio/slice-simulator-react

Preview and develop Prismic slices fast with minimal configuration.

• 🛠  Minimal configuration;
• 🖥  Preview and develop slices locally;
• 🈂  Compatible with React.

Install

npm install @prismicio/slice-simulator-react

Then create a page for Slice Simulator:

// e.g. ~/pages/slice-simulator.jsx
import { SliceSimulator } from "@prismicio/slice-simulator-react";
import SliceZone from "next-slicezone";

import state from "../.slicemachine/libraries-state.json";
import resolver from  "../sm-resolver";

const SliceSimulatorPage = () => (<SliceSimulator
	// The `sliceZone` prop should be a function receiving slices and rendering them using your `SliceZone` component.
	sliceZone={({ slices }) => <SliceZone slices={slices} resolver={resolver} />}
	state={state}
/>);

export default SliceSimulatorPage;

Slice Simulator props

prop	type	description
sliceZone	function	A function that receives slices and renders them using a <SliceZone /> component.
state	object	The libraries state.
zIndex	number	The z-index of Slice Simulator, defaults to 100.
background	string	The background color of Slice Simulator, defaults to #ffffff.
className	string	Class names to apply to the Slice Simulator component.

Troubleshooting

⚠  In case of issue with HMR / For full HMR support

If you're having trouble with HMR, or would like full HMR support, you can try updating your Slice Simulator page as follow:

// e.g. ~/pages/slice-simulator.jsx
import * as React from "react";
import { SliceSimulator } from "@prismicio/slice-simulator-react";
import SliceZone from "next-slicezone";

import _state from "../.slicemachine/libraries-state.json";
import resolver from  "../sm-resolver";

const SliceSimulatorPage = () => {
	const [state, setState] = React.useState(_state);

	// If using Webpack, add the following mounted hook for full HMR support:
	if (module.hot) {
		// Path should be the same as your libraries state import
		module.hot.accept("../.slicemachine/libraries-state.json", () => {
			setState(_state);
		});
	}

	// If using Vite, add the following mounted hook for full HMR support:
	// if (import.meta.hot) {
	// 	// Path should be the same as your libraries state import
	// 	import.meta.hot.accept("../.slicemachine/libraries-state.json", (m) => {
	// 		setState(m.default);
	// 	});
	// }
	
	return (<SliceSimulator
		// The `sliceZone` prop should be a function receiving slices and rendering them using your `SliceZone` component.
		sliceZone={({ slices }) => <SliceZone slices={slices} resolver={resolver} />}
		state={state}
	/>);
}

export default SliceSimulatorPage;

Documentation

To discover what's new on this package check out the changelog. For full documentation, visit the official Prismic documentation.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed CONTRIBUTING.md document.

License

   Copyright 2013-2022 Prismic <[e-mail]> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.