@pantheon-systems/pcc-browser-sdk
TypeScript icon, indicating that this package has built-in type declarations

3.5.4-beta.0 • Public • Published

Pantheon Content Cloud SDK for Browsers

A simple and easy to use browser client for the Pantheon Content Cloud API


Requirements

  1. A published Pantheon Content Cloud article
  2. A Pantheon Content Cloud Token. Obtain one from the PCC CLI.

Usage

  1. Add the script tags that load the SDK to your HTML file:
<-- Add this to the <head> of your HTML file or right before the closing </body> tag -->
<script
  src="https://unpkg.com/@pantheon-systems/pcc-browser-sdk@latest/dist/index.js"
  data-site-id="<your PCC Site ID>"
  data-token="<your PCC Token>"
></script>
  1. Add the pcc-article custom element to your HTML file. Place it where you want the article to be rendered.
<pcc-article id="<id of your article>">
  <!-- Add a fallback message here for when the article is loading... -->
  Loading...
</pcc-article>

That's it! You should now see yur article rendered in your browser.

Options

The pcc-article custom element accepts the following attributes:

Attribute Type Required Description
id String Yes The ID of the article you want to render
slug String Yes if id is not provided The slug of the article you want to render
disable-styles Boolean No Disable rendering default styles for the article

Readme

Keywords

none

Package Sidebar

Install

npm i @pantheon-systems/pcc-browser-sdk

Weekly Downloads

231

Version

3.5.4-beta.0

License

none

Unpacked Size

259 kB

Total Files

4

Last publish

Collaborators

  • mel-miller
  • cat.kaethler
  • zzyou
  • cobypear
  • backlineint
  • pantheon-npm