Skip to content

Commit

Permalink
feat!: update @prismicio/vue (#194)
Browse files Browse the repository at this point in the history
- `htmlSerializer` option is now called `richTextSerializer`
- The module now looks for `~/app/prismic/richTextSerializer` by  default instead of `~/app/prismic/htmlSerializer`

Co-authored-by: lihbr <lihbr@users.noreply.github.com>
  • Loading branch information
lihbr and lihbr authored Jun 2, 2023
1 parent 0306171 commit 55996a4
Show file tree
Hide file tree
Showing 12 changed files with 1,063 additions and 1,228 deletions.
16 changes: 0 additions & 16 deletions docs/content/2.guides/2.advanced/3.html-serializer.md

This file was deleted.

16 changes: 16 additions & 0 deletions docs/content/2.guides/2.advanced/3.rich-text-serializer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Rich Text Serializer
description: ''
---

You can make the module use a [Rich Text Serializer](https://prismic.io/docs/core-concepts/html-serializer?utm_campaign=devexp&utm_source=nuxt3doc&utm_medium=doc). To do so, export one from `~/app/prismic/richTextSerializer`:

```javascript [~/app/prismic/richTextSerializer.[jt]s]
export default {
paragraph: ({ children }) => `<p class="fooBar">${children}</p>`,
}
```

::alert{type="info"}
The default path (`~/app/prismic/richTextSerializer`) can be changed with the `richTextSerializer` option. See the [module configuration](/configuration#richtextserializer) ->
::
14 changes: 7 additions & 7 deletions docs/content/3.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This module is essentially a drop-in integration of `@prismicio/vue` plugin, fin

::alert{type="warning"}

&nbsp;`client`, `linkResolver`, and `htmlSerializer` options are replaced, see below.
&nbsp;`client`, `linkResolver`, and `richTextSerializer` options are replaced, see below.

::

Expand Down Expand Up @@ -55,17 +55,17 @@ prismic: {
}
```

## `htmlSerializer`
## `richTextSerializer`

- Type: `string`
- Default: `~/app/prismic/htmlSerializer`
- Default: `~/app/prismic/richTextSerializer`

Path to an optional file exporting a [HTML Serializer](https://prismic.io/docs/core-concepts/html-serializer?utm_campaign=devexp&utm_source=nuxt3doc&utm_medium=doc) for the module to use.

```javascript [nuxt.config.[jt]s]
prismic: {
// Will import the HTML Serializer from `~/prismicHTMLSerializer.js` when available
htmlSerializer: '~/prismicHTMLSerializer.js'
// Will import the HTML Serializer from `~/prismicRichTextSerializer.js` when available
richTextSerializer: '~/prismicRichTextSerializer.js'
}
```

Expand Down Expand Up @@ -103,7 +103,7 @@ prismic: {
type PrismicModuleOptions = PrismicPluginOptions & {
client?: string;
linkResolver?: string;
htmlSerializer?: string;
richTextSerializer?: string;
preview?: string | false;
toolbar?: boolean;
}
Expand All @@ -115,7 +115,7 @@ type PrismicModuleOptions = PrismicPluginOptions & {
{
client: '~/app/prismic/client',
linkResolver: '~/app/prismic/linkResolver',
htmlSerializer: '~/app/prismic/htmlSerializer',
richTextSerializer: '~/app/prismic/richTextSerializer',
injectComponents: true,
preview: '/preview',
toolbar: true
Expand Down
Loading

0 comments on commit 55996a4

Please sign in to comment.