Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ngx-prismic

exportarts71MITdeprecated1.10.1TypeScript support: included

This library has been re-published as @ngx-prismic/client and @ngx-prismic/universal. Please update to use one of these packages. More info at https://github.com/exportarts/ngx-prismic

This project is intended to provide easier integration of prismic.io into Angular Projects.

angular, prismic

readme

ngx-prismic

npm Build Status codecov Quality Gate Status

This project is intended to provide easier integration of prismic.io into Angular Projects.

Work in Progress... More featues and docs are coming in the future.

How to use

This module is built on top of prismic-javascript and prismic-dom as well as angular.

In lib/renderer/ you find helper-functions and models around prismic-dom to generate HTML from the CMS-data. It is intended to grow if a common functionality is needed but not provided by prismic-dom itself.

In lib/universal you find helper methods used in the context of prerendering pages with Angular Universal.

Finally, in lib/prismic-client you find a service built with Angular's HttpClient to query the Prismic API.

Dependency Management

The project in ./lib has several peer-dependencies. Those are installed as dev-dependencies in the main project to have them available during development, but to not have them included in the final package.json.

changelog

4.4.2 (2023-10-05)

4.4.2 (2022-09-19)

Bug Fixes

  • universal: respect additionalOptions when not passing documentIds (1ebff5b)

4.4.1 (2022-09-16)

Bug Fixes

  • preview: correctly check enabled flag (8edb451)

4.4.0 (2022-09-08)

Features

  • client: add utils to get preview ref (b84e3c9)

4.3.0 (2022-09-08)

Features

  • client: add preview utils (d93bf61)

4.2.0 (2022-03-23)

Features

  • universal: add additional config for getRoutes() (48e5a01)

4.1.2 (2021-12-26)

Bug Fixes

  • universal: only resolve docs by id that match the requested document type (5207c53)

4.1.1 (2021-12-26)

Bug Fixes

  • universal: fix id resolver (do not filter by type) (3ea0ff4)

4.1.0 (2021-12-26)

Features

  • universal: add documentIds option for generating routes (4dddf15)

4.0.0 (2021-12-26)

  • deps: remove dependency to prismic-dom and prismic-javascript, use the new libs instead (#365)

3.0.1 (2021-01-10)

Updated dependencies.

3.0.0 (2020-11-24)

chore

BREAKING CHANGES

  • deps: The client and universal libs now require Angular 11+

2.1.0 (2020-08-15)

Bug Fixes

  • http: use HttpClient to allow Interceptors (8629cab)

Features

2.0.1 (2020-07-01)

Maintenance

  • update changelog and README

2.0.0 (2020-06-30)

Code Refactoring

BREAKING CHANGES

1.10.2 (2020-05-24)

Updated dependencies.

1.10.1 (2020-05-03)

Updated dependencies.

1.10.0 (2020-04-18)

Features

1.9.1 (2020-04-01)

Bug Fixes

  • render-html-pipe: handle empty paragraphs (ef5d594)

1.9.0 (2020-03-15)

Bug Fixes

  • remove circular dependency (a73f35a)

Features

  • add missing models for prismic api v2 (eaa2a9b)

1.8.2 (2020-02-21)

Bug Fixes

  • model: update alternate_languages type (fef41cb)

1.8.1 (2019-10-06)

Features

  • prismic-api: call api without follow interceptor chain (8f719e3)

1.8.0 (2019-07-20)

1.7.0 (2019-07-14)

1.6.0 (2019-06-12)

1.5.0 (2019-06-01)

1.4.0 (2019-05-31)

1.3.2 (2019-05-30)

1.3.1 (2019-05-15)

1.3.0 (2019-05-15)

1.2.0 (2019-05-13)

1.1.0 (2019-05-11)

1.0.1 (2019-05-11)

1.0.0 (2019-05-07)

0.14.0 (2019-05-07)

0.13.0 (2019-05-05)

0.12.1 (2019-05-05)

0.12.0 (2019-05-05)

0.11.2 (2019-04-25)

0.11.1 (2019-04-25)

0.11.0 (2019-04-25)

0.10.0 (2019-04-24)

0.9.1 (2019-04-07)

0.9.0 (2019-04-01)

0.8.0 (2019-03-20)

0.7.0 (2019-03-17)

0.6.0 (2019-03-13)

0.5.0 (2019-03-11)

0.4.0 (2019-03-11)

0.3.1 (2019-03-11)

0.3.0 (2019-03-11)

0.2.1 (2019-03-11)

0.2.0 (2019-03-11)

0.1.0 (2019-03-10)