https://github.com/cassproject/cass-viewer

Example application showing the browsing and selection of competencies.
https://github.com/cassproject/cass-viewer

Last synced: about 1 year ago
JSON representation

Example application showing the browsing and selection of competencies.

• Host: GitHub
• URL: https://github.com/cassproject/cass-viewer
• Owner: cassproject
• License: apache-2.0
• Created: 2017-06-13T19:02:48.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-12-23T22:25:21.000Z (over 4 years ago)
• Last Synced: 2025-02-07T04:41:27.062Z (over 1 year ago)
• Language: JavaScript
• Size: 11 MB
• Stars: 0
• Watchers: 9
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/cassproject/cass-viewer.svg?branch=master)](https://travis-ci.org/cassproject/cass-viewer)

# cass-viewer

Competency and Skills Service -- Framework Explorer

View competency frameworks and navigate them with an easy to use, non-technical interface.

# Features

 * View a competency framework and see the nested hierarchy in an interactive graphical "bubble" display.

 * Switch to the list view and see more details about the framework.

 * Customizable - Change the default behavior of the cass-viewer via post messages.

 * Unbranded and open source - Carries no branding information, allowing you to use it easily and without concern.

# Try it out

cass-viewer is available for use in default installations as part of the Framework Explorer.

# Integration

Integrate the cass-viewer into your website by nesting it into an iframe on your website.

```html

    document.getElementsByTagName("iframe")[0].setAttribute("src", "cass-viewer/index.html");

```

# URL Parameters

To ensure the iframe is passing the correct origin, pass the origin into the iframe using a URL parameter, `origin=window.location.origin`.

# Post Messages

CASS can operate using credentials and signals provided by the parent site. These credentials are passed into the iframe via a message, in order to avoid transmitting them over HTTP. Wait for a `{message:"waiting"}` message to be posted from the iframe.

```javascript

$("iframe").ready(function () {

    $(window).on("message", function (event) {

        if (event.originalEvent.data.message == "waiting") {

            //Initialize the server and identity

        }

    });

});

```

## Setting the server

You must set the server and the identity to be used when accessing the server. 

```javascript

$("iframe")[0].contentWindow.postMessage(JSON.stringify({

    action: "initIdentity",

    serverParm: selectedServer,

    nameParm: loggedInIdentityName,

    pemParm: loggedInPpkPem

}), window.location.origin);

```