shripal17 / dart_scorm

Easily integrate SCORM APIs in your flutter/dart web app

scorm

A simple package which lets you conveniently consume SCORM 1.2/20004 APIs in your dart/flutter web app. Also handles finding of the SCORM 'API' object in the current or opener's view hierarchy.

This opens a new scope for Dart/Flutter Web: Beautiful, interactive course content creation

Installation

Refer here

Getting Started

1. import package:scorm/scorm.dart;
2. Before doing anything, you need to first find the SCORM API using ScormAPI.findApi, returns status whether SCORM API was found.
3. If the API is not found, other methods will return false/null
4. Use other methods like initialize, setValue, getValue, commit, finish, etc. according to your needs.
5. BONUS: Utility methods for SCORM

Example

The example app is deployed at https://scorm-dart.web.app

A complete example to run a Flutter web app as a SCORM package can be found in the example folder

To test it in LMS platforms, just build release version of the example app and create a zip file of the example/build/web folder.

See example/web/imsmanifest.xml for the resources declaration.

TLDR

• The flutter app can be run in an iframe with the example/web/flutter-app.html as src
• example/web/flutter-app.js creates a custom HTMLElement for testing, which is used in example/web/index.html
• example/web/index.html contains simplify-scorm for emulation of the SCORM API

References

Official SCORM Docs

Create SCORM Package from scratch

License

---

Copyright 2021 Shripal Jain

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

dart_scorm's Issues

Usage on mobile app

Hi,

There's any way to make this plugin works on a flutter app (Android/iOS) and not only a Flutter Web App ?

Thank in advance

ScormAPI.findApi() always returns false

cloned and run the example app. But still getting the false on ScormAPI.findApi()

Error: Not found: 'dart:js' and Error: Not found: 'dart:html' and Error: Type 'JsObject' not found.

Error: Not found: 'dart:js' and Error: Not found: 'dart:html' and Error: Type 'JsObject' not found on scorm.api file.

when running the app.

tried replacing with import 'package:js/js.dart'; and import 'package:html/dom.dart';
but the Error: Type 'JsObject' still persists.

is this package compatible with flutter 2 onwards?

tried on Stable 2.0.6, 2.0.0, 1.22.6, and 1.17.1
and Beta 2.2.0-10.3.pre

same errors on 2.2.0-10.3.pre, 2.0.6, and 2.0.0
wont work on 1.22.6, and 1.17.1, says require higher flutter sdk version

null Saftey

Are there any plans to migrate to a version that supports null safety

Web Only?

Does this package only work for web, or will it also work for Android/iOS apps?