Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Vue plugin, components, and composables to fetch and present Prismic content
https://github.com/prismicio/prismic-vue

javascript prismic typescript vue

Last synced: 4 days ago
JSON representation

Vue plugin, components, and composables to fetch and present Prismic content

Host: GitHub
URL: https://github.com/prismicio/prismic-vue
Owner: prismicio
License: apache-2.0
Created: 2018-05-28T16:39:57.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-09-27T12:47:29.000Z (about 2 months ago)
Last Synced: 2024-11-11T03:33:17.261Z (6 days ago)
Topics: javascript, prismic, typescript, vue
Language: TypeScript
Homepage: https://prismic.io/docs/technologies/vuejs
Size: 2.93 MB
Stars: 65
Watchers: 18
Forks: 16
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-prismic - @prismicio/vue - Vue.js development kit. (Ecosystem / Development Kits)

README

        

# @prismicio/vue

[![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]

[Vue][vue] plugin, components, and composables 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 Vue components;

- 🎣  Fetch Prismic content using Vue [composition API][vue-composition] or [vue-options].

## Install

```bash

npm install @prismicio/vue

```

## 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-2023 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/technologies/vuejs

[changelog]: ./CHANGELOG.md

[contributing]: ./CONTRIBUTING.md

[vue]: https://v3.vuejs.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

[vue-composition]: https://v3.vuejs.org/guide/composition-api-introduction.html

[vue-options]: https://v3.vuejs.org/guide/introduction.html

[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/vue-js/16

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

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

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

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

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

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

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

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

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

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

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

[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/vue.svg

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