prismicio / prismic-svelte

Svelte components and helpers to fetch and present Prismic content
https://prismic.io/docs/technical-reference/prismicio-svelte
Apache License 2.0
21 stars 6 forks source link

feat!: refresh components #11

Closed angeloashmore closed 1 year ago

angeloashmore commented 1 year ago

Types of changes

Description

This PR refreshes @prismicio/svelte and its components.

Breaking changes

<PrismicRichText>: Custom components do not need to be wrapped in a function.

<!-- Before -->
<PrismicRichText
  field={document.data.richTextField}
  components={{
    heading1: () => Heading1
  }}
/>

<!-- After -->
<PrismicRichText
  field={document.data.richTextField}
  components={{
    heading1: Heading1
  }}
/>

<PrismicRichText>: Function-based components prop is no longer supported.

Use a map-based components prop instead.

<!-- Before -->
<PrismicRichText
  field={document.data.richTextField}
  components={(type) => {
    if (type === "heading1") {
      return Heading1
    }
  }}
/>

<!-- After -->
<PrismicRichText
  field={document.data.richTextField}
  components={{
    heading1: Heading1
  }}
/>

<PrismicLink>: Link resolvers are not longer supported.

Use a route resolver configured in @prismicio/client instead.

<!-- Before -->
<PrismicLink
  field={document.data.linkField}
  linkResolver={linkResolver}
>
  Click me!
</PrismicLink>

<!-- after -->
<PrismicLink field={document.data.linkField}>
  Click me!
</PrismicLink>

Checklist:

🐿️

codecov-commenter commented 1 year ago

Codecov Report

Merging #11 (070b975) into master (93a1b59) will increase coverage by 41.87%. Report is 76 commits behind head on master. The diff coverage is 91.87%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@             Coverage Diff             @@
##           master      #11       +/-   ##
===========================================
+ Coverage   50.00%   91.87%   +41.87%     
===========================================
  Files           1       11       +10     
  Lines           2      603      +601     
===========================================
+ Hits            1      554      +553     
- Misses          1       49       +48     
Files Changed Coverage Δ
src/PrismicRichText/DefaultComponent.svelte 42.85% <42.85%> (ø)
src/PrismicRichText/Serialize.svelte 77.77% <77.77%> (ø)
src/PrismicText.svelte 87.93% <87.93%> (ø)
src/lib/devMsg.ts 90.00% <90.00%> (ø)
src/PrismicEmbed.svelte 100.00% <100.00%> (ø)
src/PrismicImage.svelte 100.00% <100.00%> (ø)
src/PrismicLink.svelte 100.00% <100.00%> (ø)
src/PrismicRichText/PrismicRichText.svelte 100.00% <100.00%> (ø)
src/SliceZone/SliceZone.svelte 100.00% <100.00%> (ø)
src/SliceZone/TodoComponent.svelte 100.00% <100.00%> (ø)
... and 1 more
haroldao commented 1 year ago

@angeloashmore I think it would be great to update the doc and mention that we don't need to add a custom linkResolver function to have eveything running correctly :)