prendus-question-elements
v0.15.4
Published
Fully embeddable custom HTML elements for Prendus questions.
Downloads
31
Readme
Prendus Question Elements
Fully embeddable custom HTML elements for questions made with AssessML. Use these elements in any web platform project, including Web Components, Polymer, SkateJS, React, Vue.js, Angular, Ember.js, and Vanilla.
Demos
Multiple choice
Multiple select
Fill in the blank
Essay
Code
Variables
Math symbols
Images
Graphs
Solution
Installation
To use in your own project:
npm install prendus-question-elements
# Eventually the bower commands below will disappear, but until we can fully support npm, sorry
bower install polymer --save
bower install paper-tabs --save
bower install juicy-ace-editor --save
bower install iron-pages --save
bower install wysiwyg-e --save
bower install paper-toast --save
bower install paper-dialog --save
bower install paper-input --save
bower install paper-button --save
bower install iron-icon --save
bower install paper-tooltip --save
To work on locally:
git clone https://github.com/Prendus/prendus-question-elements
cd prendus-question-elements
npm install
npm run test-window
Use
The elements are written in TypeScript, and there is no build process. You will have to implement your own build process to consume them. We use Zwitterion.
Import the Web Components polyfill for cross-browser compatibility:
...
<head>
<script src="[path to bower_components]/webcomponentsjs/webcomponents-lite.js"></script>
</head>
...
Import the element that you would like to use:
<link rel="import" href="[path to node_modules]/prendus-question-elements/prendus-view-question.html">
<link rel="import" href="[path to node_modules]/prendus-question-elements/prendus-edit-question.html">
Then use the element wherever you would like:
<prendus-view-question question-id="cj4os7mld6kq4017073x00cjt"></prendus-view-question>
<prendus-edit-question question-id="cj4os7mld6kq4017073x00cjt"></prendus-edit-question>
API
prendus-view-question
Properties
questionId: string
The Prendus question ID for this question. Providing this property will automatically load the question from the Prendus database.
question: Question
A question object can be used to provide the text and code of a question directly instead of loading it from the Prendus database. Any Question passed in must have the following interface:
interface Question {
readonly text: string;
readonly code: string;
}
prendus-edit-question
Properties
questionId: string
The Prendus question ID for this question. Providing this property will automatically load the question from the Prendus database.
question: string
A question object can be used to provide the text and code of a question directly instead of loading it from the Prendus database. Any Question passed in must have the following interface:
interface Question {
text: string;
code: string;
}
user: User
A Prendus user. This user (along with the userToken) is necessary to enforce many of the permissions on the questions. Any user passed in must have the following interface:
interface User {
id: string;
}
userToken: string
The Graphcool JSON Web Token associated with a user. This token (along with the user) is necessary to enforce many of the permissions on the questions.
noSave: boolean
Whether or not to execute API calls to save the question to the database on changes to the question text or code.