JavaScript

Official JavaScript library.

If you are using JavaScript on the server, refer to the libraries/nodejs page.

Snippets

The JavaScript library is responsible for processing all snippets that meet the established conditions.

The snippets must be inside the HTML <pre><code>...</code></pre> (code) or <pre><samp>...</samp></pre> (output) tags.

Also, as in the rest of the libraries, the HTML <code> and <samp> tags must include the language-NAME class, as indicated on the getting-started/quickstart#snippet-preparation page.

Some HTML special characters must be escaped before being used in the snippet. We recommend using the escape-html library or another solution.

Installation

The library should be included between the HTML <head> and </head> tags and it must contain the defer and the id attributes.

<script defer id="photon_lib" src="https://cdn.jsdelivr.net/npm/photon-js@0.1.3/dist/photon.min.js"></script>

Alternative mode

The library can be also included just before the HTML closing </body> tag, where it does not need those attributes.

<script src="https://cdn.jsdelivr.net/npm/photon-js@0.1.3/dist/photon.min.js"></script>

Usage

To run the library include the following code after the installation tag.

<script>
  document.querySelector('#photon_lib').addEventListener('load', function() {
    photon.setup({ apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' });
    photon.highlight();
  });
</script>

The API key can also be provided through the options object to the highlight function.

<script>
  document.querySelector('#photon_lib').addEventListener('load', function() {
    photon.highlight({ apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' });
  });
</script>

Alternative mode

If the library is placed at the end of the HTML <body> element, include the following code after the installation tag.

<script>
  photon.setup({ apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' });
  photon.highlight();
</script>

Or simply:

<script>
  photon.highlight({ apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' });
</script>

API

setup(options)

Function that accepts as single argument an object with configuration parameters. These parameters affect all calls to the highlight function.

options

  • apiKey: The API key to use for all calls to the highlight function.

highlight(options)

Function that accepts as single argument an object with configuration parameters. These parameters only affect this call to the highlight function.

options

  • apiKey: The API key to use in this specific call.

If you do not provide an API key to the setup function, you must provide it to the highlight function.

Resources