CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.9.1 (2024-10-30)

Bug Fixes

• helpers: add missing dir attribute for right-to-left languages (#211) (b5139ec)

2.9.0 (2024-09-27)

2.9.0-alpha.0 (2024-09-10)

Features

• support link text (aeeedcd)
• support React 19 (c06d5c1)

Chore

• release: 2.8.0 (2f15c25)

2.8.0 (2024-05-30)

Features

• support React 19 (c06d5c1)

2.7.4 (2024-03-27)

Bug Fixes

• <TodoSliceComponent /> compat with Slice Mapper (#202) (0fd4313)

2.7.3 (2023-09-18)

Bug Fixes

• resolve TypeScript build error in projects using --isolatedModules (c3628d5)

2.7.2 (2023-08-31)

Bug Fixes

• usePrismicClient(): accept a type parameter to define which documents are supported by the client (e.g. Content.AllDocumentTypes) (#197) (b16e968)

2.7.1 (2023-06-16)

Bug Fixes

• PrismicImage: allow removing Imgix params in React Server Components using null (#188) (2b17327)

2.7.0 (2023-06-13)

Features

• SliceZone: add support for mapped Slice Zones created with @prismicio/client's unstable_mapSliceZone() (#185) (c1e469d)

Bug Fixes

• replace @prismicio/types usage with @prismicio/client v7 (#186) (34649e2)

Chore

• deps: update @prismicio/mock (f30c971)

2.6.2 (2023-05-22)

Bug Fixes

• properly resolve types when using TypeScript's latest module resolution strategy (#182) (27332f5)

2.6.1 (2023-05-09)

Bug Fixes

• SliceZone: restore resolver prop (#181) (e3604d9)
• warn when passing className to <PrismicRichText> or <PrismicText> (#179) (aac1cc7)

Refactor

• remove __PRODUCTION__ and invariant; add tests for development environment (#180) (8f30e6c)

2.6.0 (2023-05-06)

Features

• support React Server Components (#178) (ea0ddf8)

2.6.0-alpha.3 (2023-05-05)

Bug Fixes

• mark @prismicio/client as an optional peer dependency (ebfb24d)

2.6.0-alpha.2 (2023-05-01)

Bug Fixes

• bundle @prismicio/client v7 to prevent npm install issues (fdff6ce)
• update error message for incompatible Server Component APIs (d558c91)

2.6.0-alpha.1 (2023-04-25)

Bug Fixes

• support projects using @prismicio/client v6 (3742685)

2.6.0-alpha.0 (2023-04-24)

Features

• add initial React Server Components experiments (6845370)
• full RSC compatibility (maybe) (935cb40)
• PrismicLink progress (61020b5)
• remove the ability to configure components via @prismicio/react/config (180802a)

Bug Fixes

• PrismicLink: types for rel and internal/external component props (ed75718)
• remove [@ts-expect-error](https://github.com/ts-expect-error) (2b420c0)
• type import issue (fe73dc0)

Refactor

• export non-RSC modules from root (fea9c14)

Chore

• deps: update all dependencies (299b701)
• remove reference to /config entry (57c836f)
• remove references to /config entry (03d47b3)
• remove unused jsdom dependencies (963d21c)
• update Size Limit config to include all exports (ffc7e75)
• use consistent package.json file paths (e901bc0)

2.5.2 (2023-02-17)

Bug Fixes

• PrismicLink: only set target="_blank" when "Open in new window" is checked (#176) (e74b4d6)

2.5.1 (2022-12-19)

Bug Fixes

• make @prismicio/types a regular dependency (b6caa1f)

Chore

• deps: maintain dependencies (f8bc7e4)
• update infrastructure (#168) (7768901)

2.5.0 (2022-08-23)

Features

• use Slice id property to key Slices in <SliceZone> when available (#162) (dd85581)

2.5.0-alpha.1 (2022-08-02)

Refactor

• slice slice_id > id (be245ce)

2.5.0-alpha.0 (2022-07-28)

Features

• support slice id (d066399)

2.4.4 (2022-07-30)

Bug Fixes

• PrismicLink: do not warn about missing field properties if the Link field is empty (#163) (b138472)

2.4.3 (2022-07-21)

Bug Fixes

• type context, components in SliceZoneProps (#159) (edb21ec)

2.4.2 (2022-06-09)

Bug Fixes

• export SliceLikeRestV2 and SliceLikeGraphQL (#156) (fcd7a13)
• prefer warning over throwing when <PrismicLink> is given an invalid prop in development (#157) (4610658)
• support untyped or partially typed Slices in <SliceZone> (#154) (5ca557a)

2.4.1 (2022-05-26)

Bug Fixes

• throw a helpful error if <PrismicText> receives an incorrect field value (#152) (2e4bab0)
• throw when <PrismicLink>'s field or document prop value is missing required properties (#153) (349529e)

2.4.0 (2022-05-25)

Features

• PrismicLink: automatically set target="_blank" rel="noopener noreferrer" when href is external (#147) (add20dd)

Bug Fixes

• do not execute <PrismicToolbar>'s script during happy-dom tests (72aaa1e)
• provide more detailed warning message for <PrismicImage>'s alt, fallbackAlt, width, and pixelDensities props (4eaf529)

Documentation

• fix typo (821e629)
• fix typo (92303a0)

Chore

• fix Happy DOM spelling [skip ci] (9c18562)

2.3.0 (2022-04-15)

Features

• add <PrismicImage> (#140) (7a93f69)

Bug Fixes

• restore default React.AnchorHTMLAttributes props on <PrismicLink> (#146) (e82a394)

2.2.0 (2022-03-31)

Features

• add fallback prop to <PrismicRichText> which is rendered when given an empty field (#135) (1c6eacb)
• support Prismic's GraphQL API in <SliceZone> (#141) (3f774db)

Bug Fixes

• correct types for non-string Link Resolver functions (#142) (50ed2f0)
• support React 18 (#138) (3c09fc3)

Chore

• deps: update dependencies (192bdf6)

2.1.2 (2022-03-09)

Bug Fixes

• better support for custom <PrismicLink> components using forwardRef() (#132) (685b270)

Documentation

• fix typo in <PrismicRichText> TSDoc (#133) (797f7c0)

2.1.1 (2022-03-03)

Bug Fixes

• detect empty Rich Text fields using @prismicio/helpers's isFilled.richText() (#130) (fc0d68c)
• forward refs to <PrismicLink> components (#131) (d7f75ed)

2.1.0 (2022-02-28)

Features

• provide a fallback string to <PrismicText> (#126) (e2fb4fc)

Chore

• deps: update dependencies (f426bb6)
• update license (ce32036)

Documentation

• add with-typescript example (#127) (b95fe41)

2.0.6 (2022-02-05)

Bug Fixes

• remove ESM package.json declaration (fixes 'Element' is not exported from '@prismicio/richtext') (#122) (6fab9d5)

Refactor

• remove type-fest dependency (#121) (27c502f)

2.0.5 (2022-01-28)

Chore

• ensure an entry file is available for React Native (f65ae5d)

2.0.4 (2022-01-28)

Bug Fixes

• automatically assign keys to custom <PrismicRichText> components (#118) (9e609f6)

Chore

• add Size Limit support (473d3fe)
• add Size Limit to CI workflow (a7a34d0)
• deps: update dependencies (3a902c6)
• support React Native's Metro bundler (9659a5a)

2.0.3 (2022-01-14)

Bug Fixes

• correct pascalCase type (cf66443)
• resolve lint error in PrismicToolbar (d0a366a)
• use .mjs module exports (c485fc1)
• use pascalCase Slice type for <SliceZone> resolver (#109) (a2f2c23)

Chore

• deps: update @prismicio/client dev dependency (382a2a9)
• deps: update dependencies (f1bb443)
• lint .tsx files (ad91234)

2.0.2 (2021-12-16)

Bug Fixes

• use correct toolbar URL (new=true) (8de749c)

Chore

• remove incorrect CHANGELOG entry (60967b8)

2.0.1 (2021-12-16)

Bug Fixes

• compose <PrismicRichText> components with <PrismicProvider> components (e2d1af4)

Documentation

• remove [@beta](https://github.com/beta) tag from installation command [skip ci] (0957770)
• update docs link [skip ci] (8bf355e)

Chore

• add github issue and pull request templates (25f2d4f)
• deps: update dependencies (b3dbec1)

Refactor

• simplify Rich Text serializer composition (0904a3e)
• use React.ElementType over string | React.ComponentType (19094f6)

2.0.0 (2021-12-03)

2.0.0-beta.9 (2021-12-03)

Bug Fixes

• cancel client requests on hook cleanup (2c91305)
• prevent infinite loops in client hooks due to object arguments (4858113)
• re-run hook on argument changes (4b2da91)

2.0.0-beta.8 (2021-12-03)

Features

• re-export Element from @prismicio/richtext (ae79fd6)

Bug Fixes

• inject Prismic Toolbar only once (aa14cbd)
• re-run client hooks on parameter changes (1fd3dad)
• restore default link component types (9d6f366)
• use Link Resolver from context in usePrismicPreviewResolver (ed44fa6)

Chore

• deps: maintain dependencies (fc35a26)
• deps: update dependencies (05b9d33)

2.0.0-beta.7 (2021-11-23)

Bug Fixes

• render Slices in the correct order in <SliceZone> (#104) (ffc4d4a)

2.0.0-beta.6 (2021-11-22)

Features

• add resolver prop to SliceZone for backwards compatibility with next-slicezone (#103) (cfdcfb1)

Chore

• add jsdocSeparateTagGroups option (c0ab73e)
• update ignore files (68dc008)

2.0.0-beta.5 (2021-11-20)

Bug Fixes

• identify package as side-effect free (3e3e009)

Refactor

• resolve hook lint warning (6ff01a8)

2.0.0-beta.4 (2021-11-20)

Features

• add usePrismicPreviewResolver (4e64de2)

Bug Fixes

• infer type of internal/external Link component (891140f)
• omit required LinkProps from PrismicLink (4ea3128)

Refactor

• rename hooks.ts to clientHooks.ts (28d4a73)

2.0.0-beta.3 (2021-11-19)

Features

• rename useAllPrismicDocuments to useAllPrismicDocumentsDangerously (22d63fe)
• treat @prismicio/client as an optional peer dependency (0e0b0b5)

2.0.0-beta.2 (2021-11-04)

Features

• support nullish fields in PrismicRichText and PrismicText (7b6f73f), closes #99

Bug Fixes

• support null PrismicLink target and rel props (850d9a8)

Documentation

• update installation command with beta tag (a08ac53)

Chore

• add github issue and pull request templates (25f2d4f)
• remove outdated README comment (75b4e3e)
• update dependencies (3542673)

2.0.0-beta.1 (2021-11-01)

Features

• add *BySomeTags and *ByEveryTag hooks (7faa6b3)

Refactor

• use universal Error object in client hooks (c02a557)

Chore

• deps: update dependencies (49878fd)
• prepare for beta release (8f6cb34)

2.0.0-alpha.6 (2021-10-09)

Features

• add usePrismicDocumentsByUIDs and useAllPrismicDocumentsByUIDs (3a25db8)
• support intrinsic props from link components (ab82e96)

Bug Fixes

• add keys to rendered Rich Text components (b0300d3)
• export PrismicText (87457bf)
• looser SliceZoneComponents type to support non-const slice_type (c227fec)
• move @prismicio/client and @prismicio/helpers to peer dependencies (91a9381)
• only pass external props to rendered PrismicLink component (1f9d9a5)
• render Rich Text line breaks as
  (4eaa6dd)
• use string union over enum for hook states (fef36bc)

Documentation

• update PrismicToolbar description (1a96dd6)

Refactor

• reorganize PrismicLink (9dfc9b9)

Chore

• add @prismicio/client and @prismicio/helpers as devDependencies (672454f)
• update dependencies (c342721)
• update package-lock.json (b8abf23)

2.0.0-alpha.5 (2021-09-27)

Bug Fixes

• export PrismicProvider props type (848cd7d)

Chore

• deps: maintain dependencies (7437659)
• update template config (8d63067)

2.0.0-alpha.4 (2021-09-15)

Bug Fixes

• allow undefined SliceZone slices and components (a44bebf)
• proper PrismicRichText serializer fallbacks (ca1d37a)

2.0.0-alpha.3 (2021-08-23)

Features

• render PrismicLink using a document (0768280)

Bug Fixes

• wording on TODOSliceComponent warning (8abfc9a)

Documentation

• add tsdocs for hooks (0b1a610)

2.0.0-alpha.2 (2021-08-03)

Features

• support document type on client hooks (0a0427b)

Bug Fixes

• rename PrismicHookState to PrismicClientHookState (8047f8b)

Chore

• add react as a dev dependency for tests (9bac238)

Refactor

• increase test coverage by restructuring (84c5cde)

2.0.0-alpha.1 (2021-08-02)

Bug Fixes

• move react to a peer dependency (17d9f08)

Chore

• remove private label (8bafde4)

2.0.0-alpha.0 (2021-08-02)

Features

• add SliceZone component (1e13c98)
• complete implementation (530be7d)
• export PrismicHookState (8058fe1)
• export updated types (4eb4973)
• initial v2 commit (c666519)
• refine SliceZone types and TODOSliceComponent (0728187)

Bug Fixes

• accept provider children (629180d)
• allow href, target overrides in PrismicLink (b0037f5)
• better internal url detection (10d5dc3)
• more specific SliceZone types (a4d5a2d)
• safely polyfill process.env (75d70c7)
• stricter href/field prop types for PrismicLink (5dec44a)
• use more correct internalLinkComponent/externalLinkComponent type (281e27c)
• use production over development for optimization checks (b466791)

Documentation

• add documentation to all exports (ba15a01)
• add examples (4984832)
• fix typo (32c20bc)
• link to React (3a083ca)
• rename with-provider example to with-global-configuration (7fc834f)
• update README (41539a8)

Refactor

• move hook reducer into hook factory file (b06e831)
• organize types and hooks (5add30b)
• use map for default PrismicRichText serializer (0ba98f0)