Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: better support for custom <PrismicLink> components using forwardRef() #132

Merged
merged 1 commit into from Mar 9, 2022

Conversation

angeloashmore
Copy link
Member

Types of changes

  • Chore (a non-breaking change which is related to package maintenance)
  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

This PR fixes a regression introduced by #131. Due to the way #131 implemented type-parameter-aware ref forwarding, projects using @prismicio/react could not manually declare a component's displayName property.

This PR also fixes a type bug related to the ref prop. It widens the ref element type to Element to support any valid HTML/SVG/etc. element. Note that an individual <PrismicLink> may not have enough information to determine which component is rendered since custom components can be provided to <PrismicProvider>. Element is the safest option.

Checklist:

  • My change requires an update to the official documentation.
  • All TSDoc comments are up-to-date and new ones have been added where necessary.
  • All new and existing tests are passing.

@codecov-commenter
Copy link

Codecov Report

Merging #132 (4e2e970) into master (127a9ca) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #132   +/-   ##
=======================================
  Coverage   92.67%   92.67%           
=======================================
  Files          16       16           
  Lines         273      273           
  Branches       61       61           
=======================================
  Hits          253      253           
  Misses          5        5           
  Partials       15       15           
Impacted Files Coverage Δ
src/PrismicLink.tsx 96.96% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 127a9ca...4e2e970. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Mar 3, 2022

size-limit report 📦

Path Size
dist/index.js 4.42 KB (0%)
dist/index.cjs 6.3 KB (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants