Index

JavaScript development kit for prismic.io

Build Status

Getting started

Install the kit

You can find downloadable versions of the kit on our release page: https://github.com/prismicio/javascript-kit/releases.

You can install a stable version using npm:

npm install prismic.io

Or using bower:

bower install prismic.io

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal.

Get started using the kit

Also on our prismic.io developer's portal, on top of our full documentation, you will:

Using the kit

Kit's detailed documentation

To get a detailed documentation of the JavaScript kit's variables and methods, please check out the prismic.io JS kit's documentation.

Specific JS kit syntax

The "Kits and helpers" section of our API documentation is largely based on the JS kit, so there are not many differences:

  • The submit() function takes a callback, which expects two parameters: a potential error, and the object of class Documents you can use.
  • For security reasons, non-type-dependent fragments actually get written document.getId(), document.getSlug(), ... rather than document.id, document.slug, ...
  • This is not a difference but a confirmation: asHtml() expects a ctx object that has a linkResolver closure and maybeRef string as its attributes.

Knowing all that, here is typical code written with the JavaScript kit:

  • A typical API object instantiation looks like this: Prismic.Api(url, callback)
  • A typical querying looks like this: api.form('everything').query('[[:d = at(document.type, "product")]]').ref(ref).submit(callback)
  • A typical fragment manipulation looks like this: doc.getImageView('article.image', 'icon').getUrl()
  • A typical fragment serialization to HTML looks like this: doc.getStructuredText('article.body').asHtml(ctx)

Changelog

Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.

Contribute to the kit

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.

Install the kit locally

You can simply execute this JavaScript kit with a web browser, but before committing, we kindly ask you to run the gulp command (it will make sure all tests still pass, and concatenate/minify your changes).

To install gulp and other required packages: install Node.js and npm, and then run this from your kit's repository, as an administrator:

npm install -g gulp
npm install

Test

Please write tests in test/test.js for any bugfix or new feature, following the very simple QUnit syntax, if you need to test with a real Prismic.io repository. Otherwise use test/unit.js for unit testing features.

Execute the tests either by opening test/test.html or test/unit.html in a browser, or by using Gulp:

  • gulp jshint will run jshint to check for syntax errors or bad practice in the code
  • gulp test will run jshint, all the tests and display the result on your shell
  • gulp test:int will run all integration tests (the ones from test/test.html)
  • gulp test:unit will run all unit tests (the ones from test/unit.html)

If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Documentation

Please document any new feature or bugfix using the JSDoc syntax. You don't need to generate the documentation, we'll do that.

If you feel an existing area of code is lacking documentation, feel free to write it; but please do so on its own branch and pull-request.

If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Licence

This software is licensed under the Apache 2 license, quoted below.

Copyright 2013 Zengularity (http://www.zengularity.com).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.