Skip to content
This repository was archived by the owner on Aug 18, 2023. It is now read-only.

Commit 9933f32

Browse files
committed
readme
1 parent 68b521c commit 9933f32

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ The following props can be passed to the component.
6666
| `blocks` | Yes | Block content retrieved from Sanity. | Array |
6767
| `serializers` | No | Any custom serializers you want to use. See below. | Object |
6868

69-
## Serializer Prop
69+
## Serializers
7070

71-
Serializers are the functions used for rendering block content. They can be defined as a string (e.g. `div`) or a Vue Component. This package comes with default serializers for rendering basic block content, you can pass a `serializer` prop to override or extend the defaults. Any object passed will be merged with the default serializers object.
71+
Serializers are the functions used for rendering block content. They can be defined as a string or a Vue Component. This package comes with default serializers for rendering basic block content, you can pass a `serializer` prop to override or extend the defaults.
7272

7373
| Property | Description |
7474
| ----------- | -------------------------------------- |
@@ -79,9 +79,9 @@ Serializers are the functions used for rendering block content. They can be defi
7979
| `listItem` | Serializer for list items. |
8080
| `hardBreak` | Serializer for hard breaks. |
8181

82-
## Using Component Serializers
82+
## Component Serializers
8383

84-
The most common use case is defining serializers for custom block types and marks, using the `types` and `marks` serializer properties. For example, if you have a block of `_type` `custom`, you can add a property to the `serializers.types` object with the key `custom` and a value of the Vue component that should serialize blocks of that type.
84+
The most common use case is defining serializers for custom block types and marks, using the `types` and `marks` serializer properties. For example, if you have a block of type `custom`, you can add a property to the `serializers.types` object with the key `custom` and a value of the Vue component that should serialize blocks of that type.
8585

8686
When using a custom Vue component as a serializer, all properties of the block or mark object (excluding `_key` and `_type`) will be passed as [props](https://v3.vuejs.org/guide/component-props.html).
8787

0 commit comments

Comments
 (0)