Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prismicio/prismic-react

React components and hooks to fetch and present Prismic content
https://github.com/prismicio/prismic-react

javascript prismic react typescript

Last synced: about 2 months ago
JSON representation

React components and hooks to fetch and present Prismic content

Awesome Lists containing this project

README 

        
# @prismicio/react



[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]

[![Codecov][codecov-src]][codecov-href]

[![Conventional Commits][conventional-commits-src]][conventional-commits-href]

[![License][license-src]][license-href]



[React][react] components and hooks to fetch and present [Prismic][prismic] content.



- 📝  Display content from Prismic like [Rich Text][prismic-rich-text] and [Link][prismic-link] fields

- 🍡  Render Prismic [Slice Zones][prismic-slices] declaratively with React components

- 🎣  Fetch Prismic content using [React hooks][react-hooks]



## Install



```bash

npm install @prismicio/react

```



## Documentation



To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].



## Contributing



Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!



**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.



**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.



**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.



**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.



For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.



## License



```

   Copyright 2013-2022 Prismic  (https://prismic.io)



   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at



       http://www.apache.org/licenses/LICENSE-2.0



   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.

```



[prismic]: https://prismic.io



[prismic-docs]: https://prismic.io/docs/technical-reference/prismicio-react

[changelog]: /CHANGELOG.md

[contributing]: ./CONTRIBUTING.md

[react]: https://reactjs.org/

[prismic-rich-text]: https://prismic.io/docs/core-concepts/rich-text-title

[prismic-link]: https://prismic.io/docs/core-concepts/link-content-relationship

[prismic-slices]: https://prismic.io/docs/core-concepts/slices

[react-hooks]: https://reactjs.org/docs/hooks-overview.html



[forum-question]: https://community.prismic.io

[repo-bug-report]: https://github.com/prismicio/prismic-react/issues/new?assignees=&labels=bug&template=bug_report.md&title=

[repo-feature-request]: https://github.com/prismicio/prismic-react/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=

[repo-pull-requests]: https://github.com/prismicio/prismic-react/pulls



[npm-version-src]: https://img.shields.io/npm/v/@prismicio/react/latest.svg

[npm-version-href]: https://npmjs.com/package/@prismicio/react

[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/react.svg

[npm-downloads-href]: https://npmjs.com/package/@prismicio/react

[github-actions-ci-src]: https://github.com/prismicio/prismic-react/workflows/ci/badge.svg

[github-actions-ci-href]: https://github.com/prismicio/prismic-react/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-react.svg

[codecov-href]: https://codecov.io/gh/prismicio/prismic-react

[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[conventional-commits-href]: https://conventionalcommits.org

[license-src]: https://img.shields.io/npm/l/@prismicio/react.svg

[license-href]: https://npmjs.com/package/@prismicio/react