qti3-item-player-vue3 0.1.0 → 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Amp-up.io, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -76,9 +76,6 @@ npm run build
 
 ## Usage
 
-The [Demo TestRunner](https://github.com/amp-up-io/qti3-item-player-controller) is a good way to get familiar with QTI 3 Player usage.  Specifically, please see the [TestRunner.vue](https://github.com/amp-up-io/qti3-item-player-controller/blob/main/src/views/TestRunner.vue) sub-component.
-
-
 ### 1. Import QTI 3 Player and QTI 3 Player CSS
 
 ```js
@@ -228,9 +225,14 @@ QTI 3 Player triggers a `notifyQti3ItemReady` event upon completion of the Playe
  * @description Event handler for the QTI3Player component's 'notifyQti3ItemReady'
  * event.  This event is fired upon completion of the qti-assessment-item
  * component's loading of XML.
+ * The inner qti-assessment-item component is passed in the event.
+ * @param {Component} item - the qti-assessment-item component itself
  */
-handleItemReady () {
+handleItemReady (item) {
   console.log('QTI 3 Item XML is loaded and rendered!  The latest "attempt" has officially begun.')
+  // The item argument is the qti-assessment-item component
+  // with all exposed properties and methods.
+  this.item = item
 }
 ```
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -248,7 +250,7 @@ After item XML is loaded and an attempt has begun, a test controller may retriev
 
 * **suspendAttempt**
 
-    This performs response validation (if `validateResponses: true`) and produces the state of all item variables.  _No response processing is executed._  Typical use is when `submissionMode: "simultaneous"`.
+  This performs response validation (if `validateResponses: true`) and produces the state of all item variables.  _No response processing is executed._  Typical use is when `submissionMode: "simultaneous"`.
 
 The `endAttempt` and `suspendAttempt` methods may take a considerable amount of time to complete.  QTI 3 Player triggers the `notifyQti3EndAttemptCompleted` and `notifyQti3SuspendAttemptCompleted` events, respectively, upon completion of an `endAttempt` or a `suspendAttempt` method call.
 
@@ -705,6 +707,7 @@ The QTI3 Item Player 2022-2024 development roadmap includes all features and cap
 - [x] Support for Interaction "Review" Status
 - [x] Improved Audio Player
 - [x] Improved Video Player
+- [ ] Update Quill.js to version 2.x
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -721,7 +724,7 @@ Distributed under the MIT License. See `LICENSE` for more information.
 
 ## Built With
 
-The QTI3 Item Player is built with the Vue.js (v2.6) framework.
+The QTI3 Item Player is built with the Vue 3.4 (v3.4.34) framework and Vite.
 
 * [Vue.js](https://vuejs.org/)
 
@@ -734,7 +737,7 @@ The QTI3 Item Player is built with the Vue.js (v2.6) framework.
 
 Paul Grudnitski - paul.grudnitski@amp-up.io
 
-Project Link: [https://github.com/amp-up-io/qti3-item-player](https://github.com/amp-up-io/qti3-item-player)
+Project Link: [https://github.com/amp-up-io/qti3-item-player-vue3](https://github.com/amp-up-io/qti3-item-player-vue3)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -743,10 +746,10 @@ Project Link: [https://github.com/amp-up-io/qti3-item-player](https://github.com
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
 
-This component would not be possible were it not for a fortuitous decision by the aQTI Task Force (the original name of the QTI 3 Working Group) - meeting at CITO headquarters in Arnhem, NE, January 2015 - to make the aQTI / QTI 3 specification "web component friendly".  
+This component would not be possible were it not for a fortuitous decision by the aQTI Task Force (the original name of the QTI 3 Working Group) - meeting at CITO headquarters in Arnhem, NE, January 2015 - to make the aQTI / QTI 3 specification "web component friendly".
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 
-[license-shield]: https://img.shields.io/github/license/amp-up-io/qti3-item-player?label=License&style=for-the-badge
-[license-url]: https://github.com/amp-up-io/qti3-item-player/blob/main/LICENSE
+[license-shield]: https://img.shields.io/github/license/amp-up-io/qti3-item-player-vue3?label=License&style=for-the-badge
+[license-url]: https://github.com/amp-up-io/qti3-item-player-vue3/blob/main/LICENSE