# @prismicio/snippets
[![npm version][npm-version-src]][npm-version-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
[![License][license-src]][license-href]
[Prismic][prismic] snippets for VS Code, Vim, Sublime, and IntelliJ.
- 📐 Template quickly Prismic data in React and Vue.js;
- 🏗 Scaffold common Prismic structures in a blink: slices, resolvers, and more;
- 🈂 JavaScript and TypeScript friendly.
## Install
### VS Code
Install extension from [VS Code Marketplace][vs-code-marketplace-src].
### Vim
Install extension using [coc.nvim][coc-nvim-src].
```
:CocInstall prismic-snippets coc-snippets
```
### Sublime
Install package from [Package Control][sublime-package-control-src].
### IntelliJ
Intall plugin from [JetBrains Marketplace][jetbrains-marketplace-src].
## Documentation
Every snippets are prefixed with `prismic(...)`. There are two categories of snippets: **templating snippets** and **scaffolding snippets**.
### Templating snippets
**React & Vue**
- `prismicText`: Yields a ready-to-use `` component
- `prismicRichText`: Yields a ready-to-use `` component
- `prismicLink`: Yields a ready-to-use `` component
- `prismicSliceZone`: Yields a ready-to-use `` component
- `prismicGroup`: Yields a ready-to-use Group field/Slice repeatable template
**React only**
- `prismicProvider`: Yields a ready-to-use `` component
- `prismicToolbar`: Yields a ready-to-use `` component
**Vue only**
- `prismicImage`: Yields a ready-to-use `` component
- `prismicEmbed`: Yields a ready-to-use `` component
### Scaffolding snippets
**React & Vue**
- `prismicSliceScaffold`: Yields a ready-to-use Slice components scaffold
- `prismicSliceSimulatorScaffold`: Yields a ready-to-use Slice Simulator scaffold
**JavaScript & TypeScript**
- `prismicRouteResolverScaffold`: Yields a ready-to-use Route Resolver scaffold
- `prismicLinkResolverScaffold`: Yields a ready-to-use Link Resolver scaffold
- `prismicHTMLSerializerScaffold`: Yields a ready-to-use HTML Serializer scaffold
---
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
[changelog]: ./CHANGELOG.md
[contributing]: ./CONTRIBUTING.md
[vs-code-marketplace-src]: https://marketplace.visualstudio.com/items?itemName=prismicio.prismic-snippets
[coc-nvim-src]: https://github.com/neoclide/coc.nvim
[sublime-package-control-src]: https://packagecontrol.io/packages/Prismic.io%20snippets
[jetbrains-marketplace-src]: https://plugins.jetbrains.com/plugin/18884-prismic-io-snippets
[forum-question]: https://community.prismic.io
[repo-bug-report]: https://github.com/prismicio/prismic-snippets/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio/prismic-snippets/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio/prismic-snippets/pulls
[npm-version-src]: https://img.shields.io/npm/v/prismic-snippets/latest.svg
[npm-version-href]: https://npmjs.com/package/prismic-snippets
[github-actions-ci-src]: https://github.com/prismicio/prismic-snippets/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/prismicio/prismic-snippets/actions?query=workflow%3Aci
[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/prismic-snippets.svg
[license-href]: https://npmjs.com/package/prismic-snippets