This package has been deprecated

Author message:

@prismicio/slice-simulator-vue3 has moved to @slicemachine/adapter-nuxt! No worries, you're safe to stay on @prismicio/slice-simulator-vue3 but it will no longer receive updates nor fixes (excluding security ones). Upgrading to @slicemachine/adapter-nuxt should be seamless for most users, if any doubt check out the documentation: https://prismic.io/docs/technical-reference/slicemachine-adapter-nuxt or reach out to us on our community forum: https://community.prismic.io

@prismicio/slice-simulator-vue3
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

@prismicio/slice-simulator-vue3

npm version npm downloads Github Actions CI Codecov Conventional Commits License

Preview and develop Prismic slices fast with minimal configuration.

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

Install

npm install @prismicio/slice-simulator-vue3

Then create a page for Slice Simulator:

<!-- e.g. ~/pages/slice-simulator.vue -->
<template>
	<SliceSimulator #default="{ slices }">
		<SliceZone :slices="slices" :components="components" />
	</SliceSimulator>
</template>

<script setup>
import { SliceSimulator } from "@prismicio/slice-simulator-vue3";
import { SliceZone } from "@prismicio/vue";

import components from "../../slices/components";
</script>

Slice Simulator props

prop type description
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.

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.vue -->
<template>
	<SliceSimulator :state="state" #default="{ slices }">
		<SliceZone :slices="slices" :components="components" />
	</SliceSimulator>
</template>

<script setup>
import { ref } from "vue";
import { SliceSimulator } from "@prismicio/slice-simulator-vue3";
import { SliceZone } from "@prismicio/vue";

import _state from "../../.slicemachine/libraries-state.json";
import components from "../../slices/components";

const state = ref(_state);

// If using Vite, add the following 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) => {
		state.value = m.default;
	});
}
</script>

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 <contact@prismic.io> (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.

Readme

Keywords

Package Sidebar

Install

npm i @prismicio/slice-simulator-vue3

Weekly Downloads

17

Version

0.1.3

License

Apache-2.0

Unpacked Size

45.4 kB

Total Files

10

Last publish

Collaborators

  • srflp
  • jomifepe
  • bohdan-one
  • paulyvpg
  • ruben-prismic
  • filipeue
  • rafa17
  • levimykel
  • chrrrs
  • xrutayisire
  • boubiyeah
  • dani-mp
  • nvld
  • samuelhorn
  • prismic
  • raph22
  • sre
  • arnaudlewis
  • amaurycahuet
  • michel.chau
  • gholgot
  • odim
  • prismic-ci
  • lihbr
  • bapmrl
  • angeloashmore