@caspingus/lt

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Home - Learnosity Toolkit - Docs</title> <meta name="description" content="Documentation for the Learnosity Toolkit JavaScript library." /> <meta name="keywords" content="Learnosity" /> <meta name="keyword" content="Learnosity" /> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <link type="text/css" rel="stylesheet" href="styles/custom.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <input type="text" id="nav-search" placeholder="Search" autofocus autocomplete="on" /> <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/michaelsharman/LT" target="_blank" class="" id="" >Github</a></h2><h3>Modules</h3><ul><li><h3>Items API</h3></li><li><a href="module-Assessment_Activity.html">Activity</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activity">activity</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityId">activityId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activitySubTitle">activitySubTitle</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTags">activityTags</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTemplateId">activityTemplateId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTitle">activityTitle</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.adaptiveType">adaptiveType</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.annotationsConfig">annotationsConfig</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.autoSaveConfig">autoSaveConfig</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.elapsedTime">elapsedTime</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasActivityTemplate">hasActivityTemplate</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAnnotations">hasAnnotations</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAnswerMasking">hasAnswerMasking</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAutoSave">hasAutoSave</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasEvents">hasEvents</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasItemPool">hasItemPool</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasLineReader">hasLineReader</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasResourceItems">hasResourceItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasSections">hasSections</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasShuffledItems">hasShuffledItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasTryAgain">hasTryAgain</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.isAdaptive">isAdaptive</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.isResuming">isResuming</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.itemBank">itemBank</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.itemPool">itemPool</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.maxTime">maxTime</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.region">region</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.resourceItems">resourceItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.sessionId">sessionId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.state">state</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.timeRemaining">timeRemaining</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.totalItems">totalItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.userId">userId</a></li></ul></li><li><a href="module-Assessment_App.html">App</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.annotationsApp">annotationsApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.appInstance">appInstance</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.assessApp">assessApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.eventsApp">eventsApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.init">init</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.questionsApp">questionsApp</a></li></ul></li><li><a href="module-Assessment_Diagnostics.html">Diagnostics</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.diagnostics">diagnostics</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.filterEvent">filterEvent</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.listen">listen</a></li></ul></li><li><a href="module-Assessment_Items.html">Items</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.dynamic">dynamic</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.flag">flag</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isDynamicItem">isDynamicItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isFirstItem">isFirstItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isFlagged">isFlagged</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isItemFullyAttempted">isItemFullyAttempted</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isLastItem">isLastItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isMaskingEnabled">isMaskingEnabled</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.item">item</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemAttemptStatus">itemAttemptStatus</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemByResponseId">itemByResponseId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemElement">itemElement</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemPosition">itemPosition</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemReference">itemReference</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemTags">itemTags</a></li></ul></li><li><a href="module-Assessment_Player.html">Player</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.answerMasking">answerMasking</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.dialog">dialog</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.hideDialog">hideDialog</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.isResponsiveMode">isResponsiveMode</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.isReviewScreen">isReviewScreen</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.lineReader">lineReader</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.navigate">navigate</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.next">next</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.previous">previous</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.review">review</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.submit">submit</a></li></ul></li><li><a href="module-Assessment_Questions.html">Questions</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.hasCheckAnswer">hasCheckAnswer</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.isAutoScorable">isAutoScorable</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.question">question</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionInstance">questionInstance</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionResponse">questionResponse</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionResponseIds">questionResponseIds</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionScore">questionScore</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questions">questions</a></li></ul></li><li><a href="module-Assessment_Sections.html">Sections</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.isFirstItemInSection">isFirstItemInSection</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.isLastItemInSection">isLastItemInSection</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.section">section</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionHasShuffledItems">sectionHasShuffledItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionIndex">sectionIndex</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionItemPosition">sectionItemPosition</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sections">sections</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.totalItemsInSection">totalItemsInSection</a></li></ul></li><li><h3>Author API</h3></li><li><a href="module-Authoring_App.html">App</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.appInstance">appInstance</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.init">init</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.questionEditorApp">questionEditorApp</a></li></ul></li><li><a href="module-Authoring_Diagnostics.html">Diagnostics</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.diagnostics">diagnostics</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.filterEvent">filterEvent</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.listen">listen</a></li></ul></li><li><a href="module-Authoring_Navigation.html">Navigation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Navigation.html#.routingHash">routingHash</a></li></ul></li><li><a href="module-Authoring_Widgets.html">Widgets</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Widgets.html#.type">type</a></li></ul></li><li><h3>Extensions - Items API</h3></li><li><a href="module-Extensions_Assessment_ariaCountOnNav.html">ariaCountOnNav</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_ariaCountOnNav.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_blockGrammarChecks.html">blockGrammarChecks</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_blockGrammarChecks.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_checkAnswerValidation.html">checkAnswerValidation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_checkAnswerValidation.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_columnResizer.html">columnResizer</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_columnResizer.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_contentTabs.html">contentTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_contentTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_disableOnValidate.html">disableOnValidate</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_disableOnValidate.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_essayLimitByCharacter.html">essayLimitByCharacter</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_essayLimitByCharacter.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_hideAlternatives.html">hideAlternatives</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_hideAlternatives.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_hideAlternatives.html#~shuffleArrayWithSeed">shuffleArrayWithSeed</a></li></ul></li><li><a href="module-Extensions_Assessment_keyboardShortcuts.html">keyboardShortcuts</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_keyboardShortcuts.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_magnifier.html">magnifier</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.setupButtons">setupButtons</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.toggle">toggle</a></li></ul></li><li><a href="module-Extensions_Assessment_mcqLabelPrefix.html">mcqLabelPrefix</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_mcqLabelPrefix.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_networkStatus.html">networkStatus</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_networkStatus.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_pageOverlay.html">pageOverlay</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_pageOverlay.html#.halt">halt</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_pageOverlay.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_renderPDF.html">renderPDF</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_renderPDF.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_resetResponse.html">resetResponse</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_resetResponse.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_themes_canvas.html">themes/canvas</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_themes_canvas.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_themes_juniorQuest.html">themes/juniorQuest</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_themes_juniorQuest.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_toggleTimer.html">toggleTimer</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_toggleTimer.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_toggleTimer.html#.toggle">toggle</a></li></ul></li><li><a href="module-Extensions_Assessment_whiteNoise.html">whiteNoise</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_whiteNoise.html#.launchPlayer">launchPlayer</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_whiteNoise.html#.run">run</a></li></ul></li><li><h3>Extensions - Author API</h3></li><li><a href="module-Extensions_Authoring_contentTabs.html">contentTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_contentTabs.html#.addContentTabs">addContentTabs</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_contentTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_createTags.html">createTags</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_createTags.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_dynamicContent.html">dynamicContent</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_dynamicContent.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_essayMaxLength.html">essayMaxLength</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_essayMaxLength.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_imageUploader.html">imageUploader</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_imageUploader.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_languageTextDirection.html">languageTextDirection</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_languageTextDirection.html#.addLanguageAttribute">addLanguageAttribute</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_languageTextDirection.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_nativeTabs.html">nativeTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_nativeTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_renderPDF.html">renderPDF</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_renderPDF.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_singleQuestion.html">singleQuestion</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_singleQuestion.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_ssmlEditor.html">ssmlEditor</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_ssmlEditor.html#.launchSsmlEditor">launchSsmlEditor</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_ssmlEditor.html#.run">run</a></li></ul></li><li><h3>Utils</h3></li><li><a href="module-Utils_Dom.html">Dom</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Dom.html#.waitForElement">waitForElement</a></li></ul></li><li><a href="module-Utils_Logger.html">Logger</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.debug">debug</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.error">error</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.info">info</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.log">log</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.warn">warn</a></li></ul></li><li><a href="module-Utils_Styling.html">Styling</a></li><li><a href="module-Utils_Validation.html">Validation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Validation.html#.hasValue">hasValue</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Validation.html#.isEmptyObject">isEmptyObject</a></li></ul></li></ul> </nav> <div id="main" role="main"> <section class="readme usertext"> <article><h1 id="lt---learnosity-toolkit">LT - Learnosity Toolkit</h1> <p>This is a utility library of helper modules and extensions that may be useful if you're developing with Learnosity APIs.</p> <p>Modules and extensions are separated between Assessment (when using Items API) and Authoring (when using Author API).</p> <p>See <a href="https://michaelsharman.github.io/LT/">documentation here</a>.</p> <h2 id="important">Important</h2> <p>This package is unofficial and wasn't created by Learnosity.</p> <p>No modules contained within:</p> <ul> <li>ever have access to the consumer private key</li> <li>track any usage or personal information</li> </ul> <p>Everything is open source under the MIT license. Feel free to use as you see fit.</p> <h2 id="installation">Installation</h2> <pre class="prettyprint source"><code>npm install @caspingus/lt </code></pre> <h2 id="usage">Usage</h2> <p>From either the assessment or authoring folders, you can import <code>src/core</code> or <code>src/index</code> into your project.</p> <h3 id="core-vs-index">core vs index</h3> <p><strong>Recommendation</strong> - use <code>core</code> in all production settings.</p> <p>The <code>core</code> module contains the LT toolkit only, no extensions. This is the smallest file size (around 12kB for assessment and 5kB for authoring) and may be all you need.</p> <p>If you want 1 or 2 extensions, you can import them manually to keep the overall file size down.</p> <pre class="prettyprint source"><code>import { LT } from '@caspingus/lt/src/assessment/core'; import * as columnResizer from '@caspingus/lt/src/assessment/extensions/accessibility/ux/columnResizer'; </code></pre> <p>The <code>index</code> module contains everything in <code>core</code> along with <em>all</em> extensions except themes. This is the largest file size (around 520kB for assessment and 740kB for authoring) This is useful in development if you want to browse the extensions, but also if you happen to use all the extensions in your project.</p> <pre class="prettyprint source"><code>import { LT } from '@caspingus/lt/src/assessment/index'; </code></pre> <p>^^ Importing <code>index</code> puts all extensions in <code>LT.extensions</code>.</p> <h3 id="src-vs-dist">src vs dist</h3> <p><strong>Recommendation</strong> - use <code>src</code> and have your local build process bundle LT along with your application.</p> <p>As this library will be imported into existing projects, it's recommended to use the <code>src</code> folder and include LT as a part of your build process.</p> <p>In which case, import from the <code>src</code> folder and you're good to go. Another option is to import from <code>dist</code> which has been prod bundled by Webpack, but then you need to exclude this from your build process.</p> <h2 id="initialize">Initialize</h2> <p>Everything is written using ES6 modules. By default we use <code>LT</code> as a variable for the toolkit. If you want to change this, use named imports.</p> <p><code>LT</code> expects to be given the application instance in the <code>readyListener</code>, either Items API or Author API. From there you can call any method you want off the <code>LT</code> object.</p> <h2 id="items-api">Items API</h2> <pre class="prettyprint source"><code>// Declare and set your variable with the Items API LearnosityItems.init() method const itemsApp = LearnosityItems.init(signedConfigObject); // Pass that app instance to the Toolkit constructor import { LT } from '@caspingus/lt/src/assessment/core'; import * as renderPDF from '@caspingus/lt/src/assessment/extensions/ui/renderPDF/index'; LT.init(itemsApp); // Optionally call any extensions you might want renderPDF.run(); // Put individual extensions in the LT object if that makes your life easier LT.extensions = { renderPDF, }; LT.extensions.renderPDF.run(); // Optionally add to the global scope (handy for development) window.LT = LT; </code></pre> <h2 id="usage-examples">Usage examples</h2> <pre class="prettyprint source"><code>import { LT } from '@caspingus/lt/src/assessment/core'; // See if the item was _fully_ attempted LT.isItemFullyAttempted(); // See if we're on the last item in a section LT.isLastItemInSection(); // See the question response object LT.questionResponse(); </code></pre> <h2 id="author-api">Author API</h2> <pre class="prettyprint source"><code>// Declare and set your variable with the Author API LearnosityItems.init() method const authorApp = LearnosityAuthor.init(signedConfigObject); // Pass that app instance to the Toolkit constructor import { LT } from '@caspingus/lt/src/authoring/core'; LT.init(authorApp); // Optionally add to the global scope (for development) window.LT = LT; </code></pre> <h2 id="usage-examples-1">Usage examples</h2> <pre class="prettyprint source"><code>import { LT } from '@caspingus/lt/src/authoring/core'; // Injects a route hash to the URI so SPAs can load to a deep view from a full page refresh. LT.routingHash(); </code></pre> <h1 id="building">Building</h1> <p>You should import from <code>@caspingus/lt/src/*</code> and let your build tool handle minifying and tree shaking etc.</p> <p>Right now, the Authoring extension ssmlEditor requires that css be imported. Here is an example webpack.config:</p> <pre class="prettyprint source"><code>{ module: { rules: [ { test: /\.((c|s[ac])ss)$/i, use: ['style-loader', 'css-loader', 'sass-loader'], }, ], }, }; </code></pre></article> </section> </div> <br class="clear"> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> <script src="scripts/search.js" defer></script> <script src="scripts/collapse.js" defer></script> </body> </html>