vTeacher Integrator

This library was generated for the purpose of integrating the vTeacher service into angular web applications.

Overview

vTeacher is an elibrary service that provides materials and resources for students and teachers in academic institutions.

Installation

$npm install vteacher without adding it to the package.json

$npm install --save vteacher adds it to the package.json

Usage

Import the module in your .module file.

import { VteacherModule } from "vteacher";

Add the module to your imports array.

imports: [...VteacherModule.forRoot('pubVT_xxxxxxxxxxxxxxxxxxx')]

In your .html file, add <vteacher-viewer></vteacher-viewer>, it has a set of attributes that can be used to specify the material to be displayed.

Attributes

| Attribute | Type | Description | Required | | --------------- | ------- | ------------------------------------------------------------ | -------- | | token | string | The vTeacher public token used to authenticate your access to the service. | True | | curriculum | string | The vTeacher curriculum string for the type of educational curriculum to be displayed. | True | | classID | string | The vTeacher id string of the class whose content is to be displayed. | True | | school | string | The school id pre-registered on the vTeacher dashboard. | True | | subjectID | string | The vTeacher id string of the subject to be displayed. | True | | userID | string | The unique id of the user using the service. | True | | height | string | CSS attribute to specify the height of the viewer. Default: 92vh | False | | hasMaterialIcon | boolean | Indicates if the parent application has Angular Material Package already in use. Default: true | False | | theme | object | VTeacherTheme object that contains properties for the viewer's theme. Default: Light theme | False |

Triggers

| Trigger | Response | | ------- | ------------------------------------------------------------ | | exit | Returns a boolean value indicating that the viewer should be closed |

Example

<vteacher-viewer classID='j1' subjectID='eng35' curriculum="ngn" school="sapmas" userID="user_1" (exit)="close($event)"></vteacher-viewer>

Further help

To get more information on the service, visit our Developers page.