Prismic DOM 3.0.0-alpha

The DOM kit takes care of injecting helper methods inside your Vue.js application. It's built on top of the Prismic DOM package.

Configuration

No configuration is available so far for the DOM kit. It inherits directly from top-level options provided to the plugin.

interface DOMOptions {}

interface PrismicPluginOptions {
    /* ... */
    dom?: DOMOptions;
}

const prismic = createPrismic({
    /* ... */
    dom: {},
});

const prismic = createPrismic({
    /* ... */
    dom: false,
});

Methods

asText

The asText method allows you to serialize a rich text field into a plain text string:

this.$prismic.asText(doc.richtext);

Arguments	Type	Required	Default	Description
richText	RichTextField	Yes		Rich text field to serialize
joinString	string	No	" " (single space)	String used to join serialized paragraphs

asHtml

The asHtml method allows you to serialize a rich text field into an HTML string:

this.$prismic.asHtml(doc.richtext);

this.$prismic.asHtml(doc.richtext, anotherLinkResolver, anotherHtmlSerializer);

Arguments	Type	Required	Default	Description
richText	RichTextField	Yes		Rich text field to serialize
linkResolver	LinkResolver	No	The link resolver provided to @prismicio/vue or its default one	Link resolver to use when resolving links inside the provided field
htmlSerializer	HtmlSerializer<string>	No	The HTML serializer provided to @prismicio/vue or its default one	HTML serializer to use when serializing the provided field

asLink

The asLink method allows you to resolve a link field into an href value:

this.$prismic.asLink(doc.link);

this.$prismic.asLink(doc.link, anotherLinkResolver);

Arguments	Type	Required	Default	Description
link	LinkField	Yes		Link field to resolve
linkResolver	LinkResolver	No	The link resolver provided to @prismicio/vue or its default one	Link resolver to use when resolving the provided link field

asDate

The asDate method allows you to parse a date field into a Date object:

this.$prismic.asDate(doc.date);

Arguments	Type	Required	Default	Description
date	DateField	Yes		Date field to parse