Demo project for Prismic.io
It's meant to work with API v2 libs here:
- prismic-javascript is on Github.
- prismic-dom is on Github.
1. Installation
2. Query the content
3. Integrate the content
Embed
Image
Text
Number
Date
Timestamp
Select
Color
StructuredText
WebLink
DocumentLink
ImageLink
FileLink
Separator
Group
GeoPoint
Slices
4. Contribute
5. Implement I18N
6. Manage profiles
7. License
===================================================
Installation
Prismic CLI
- install prismic CLI
npm install -g prismic-cli
- create project with prismic theme:
prismic theme https://github.com/prismicio/prismic-demo
NPM
npm install
Start
npm start
Dev
npm run dev
Query the content
To fetch documents from your repository, you need to fetch the Api data first.
var Prismic = ; Prismic;
All asynchronous calls return ES2015 promises, so alternatively you can use them instead of callbacks.
var Prismic = ; Prismic;
See the developer documentation or the API documentation for more details on how to use it.
Integrate the content
In each case documented below, you will have a snippet of the custom type and another for the code needed to fill the content field into your JS Template.
In these examples we have a doc
parameter corresponding to the fetched prismic document.
Embed
Custom type
"video" : "type" : "Embed"
Template JS
docdatavideoembed_url
Image
Custom type
"photo" : "type" : "Image" "fieldset" : "Image" "config" : "constraint" : "width" : 300 "height" : 300 "thumbnails" : "name" : "Small" "width" : 100 "height" : 100 "name" : "Medium" "width" : 200 "height" : 200 "name" : "Large" "width" : 300 "height" : 300
Template JS
//main viewdocdataphotourldocdataphotoaltdocdataphotowidthdocdataphotoheight //thumbnails => example for small viewdocdataphotosmallurldocdataphotosmallaltdocdataphotosmallwidthdocdataphotosmallheight
Text
Custom type
"title" : "type" : "Text"
Template JS
docdatatitle
Number
Custom type
"count" : "type" : "Text"
Template JS
docdatacount
Date
Custom type
"publication" : "type" : "Date"
Template JS
// date as string from the APIdocdatapublication// date as JS DateDatedocdatapublication
Timestamp
Custom type
"time" : "type" : "Timestamp"
Template JS
// timestamp as string from the APIdocdatatime// timestamp as JS DatetimeDatedocdatatime
Select
Custom type
"gender" : "type" : "Select"
Template JS
docdatagender
Color
Custom type
"background" : "type" : "Color"
Template JS
docdatabackground
RichText
Custom type
"description" : "type" : "StructuredText"
Template JS
RichText //linkResolver must be declare somewhereRichText
WebLink
Custom type
"linktoweb" : "type" : "Link" "config" : "select" : "web"
Template JS
docdatalinktoweburl
DocumentLink
Custom type
"linktodoc" : "type" : "Link" "config" : "select" : "document" "customtypes" : <your-custom-type-id> "tags" : <your-tag>
Template JS
//return url of the document linkdocdatalinktodoc//return url of the document
ImageLink
Custom type
"linktomedia" : "type" : "Link" "config" : "select" : "media"
Template JS
docdatalinktomediaurl
FileLink
Custom type
"linktofile" : "type" : "Link" "config" : "select" : "media"
Template JS
docdatalinktofileurl
Group
Custom type
"feature" : "type" : "Group" "repeat": true //default to true but put explicitly for the example "config" : "field" : "title" : "type" : "Text" "description" : "type" : "StructuredText"
Template JS
docdatafeature
GeoPoint
Custom type
"location" : "type" : "GeoPoint"
Template JS
docdatalatitudedocdatalongitude
Slices
Slice with Group as value The Group value will be put directly as Slice value Custom type
"contentAsSlices" : "fieldset" : "Dynamic page zone..." "type" : "Slices" "config" : "choices" : "slides" : "type" : "Group" //required to display name in slice select in the writing room "fieldset" : "Slides" "config" : "fields" : "illustration" : "type" : "Image" "title" : "type" : "StructuredText"
Template JS
docdatacontentAsSlices
Slice with basic fragment like Text as value The fragment value will be put directly as Slice value Custom type
"contentAsSlices" : "fieldset" : "Dynamic page zone..." "type" : "Slices" "config" : "choices" : "description" : "type" : "StructuredText"
Template JS
doccontentAsSlices
new Slice the new Slice type allow you to create a repeatable area and a non repeatable one.
"contentAsSlices" : "fieldset" : "Dynamic page zone..." "type" : "Slices" "config" : "choices" : "newslice" : "type" : "Slice" "non-repeat": "title": "type": "Text" "repeat": "description": "type" : "StructuredText"
Template JS
doccontentAsSlices
Contribute
Run the project
Install dependencies:
npm install
Run the project in standard mode:
npm start
Run the project in dev mode: (start nodeJS Server + build sass files)
npm run dev
Stylesheets
Stylesheets are written with the preprocessor sass in scss
format.
They are localized in ./assets/stylesheets
.
You must split each slice in a file to simplify modularity and public sharing.
Don't bother to prefix css properties for each browser, it's already done with autoprefixer when you start the project in dev mode.
Javascript
Since there is no complex javascript required yet, you only have one file ./public/javascript/main.js
to interact directly with the DOM and make any js client code.
Slices
How to build a slice named MyDemoSlice
:
- add it's definition in the folder
custom_types
. - create a sass file in
./assets/stylesheets/slices/my-demo-slice.scss
and import it in./assets/stylesheets/style.scss
. - create a pug template in
./views/slices/my-demo-slice.pug
and you can import it from any pug template.
Implement i18n
The localization is implemented out of the box. You got 4 things to check if you wanna customize it:
- i18n.json: It's a configuration file that allow you to declare the list of language that you wanna support in your project in addition to the default language.
- I18NUrl(partialURL?: String) => String: It's a helper to build your URL. You just provide a url and the helper with prefix it with a regex to match the declared language from i18n.json. It's optional so you can provide anything and it will match every i18n URLs. It can be useful for middlewares.
- I18NConfig(request: Request, options?: Object) => String: It's a helper that help you build your queries configuration. It will take a request to get the language automatically but also an optional object with custom options that will be merged all together.
- LinkResolver: Don't forget to update the linkResolver to add the language in the url. There's already an example. you have a property lang in each documentLink.
Manage Profiles
In this demo, you can manage different profiles of users out of the box. It's handled with a basic cookies system. You can just switch profile directly in the footer and it will set a new profile.
How it works?
You must set your profiles in profiles.json
according to the example in this file.
Each time you switch profile from the select in the footer, it create a cookie prismic.profile
with the value of the profile you just selected.
You have now an easy access to the current profile directly from the cookies.
You can access it from the back with the following code:
reslocalsPrismicProfilescurrent
You can also access the list of all profiles:
reslocalsPrismicProfilesprofiles
But also the default profile:
reslocalsPrismicProfilesdefault
And finally you can access the same PrismicProfiles
object from the client in window.PrismicProfiles
. It contains exactly the same thing.
License
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013-2017 Prismic.io (http://prismic.io).
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.