@artevelde-uas/canvas-lms-app v1.15.0

App for building custom JS & CSS for Canvas LMS themes

Using this application you can easily create plug-ins that add/modify functionality of the Canvas LMS UI.

This package provides the following functionality to make it easier to rapidly develop plug-ins:

• Auth: Simple functions to determine enrollment type (etc).
• DOM: Functions to detect if certain elements are added/removed.
• I18n: Enables easy localization (using i18next framework).
• Messages: Functions to add messages and notifications.
• Router: Allows to run plug-in code only on certain pages while recieving all the parameters as variables. Also lets you create URLs based on routes.
• Theme: A slightly modified theme to be used by Instructure UI components

Installation

Using NPM:

npm install @artevelde-uas/canvas-lms-app

Using Yarn:

yarn add @artevelde-uas/canvas-lms-app

Usage

Just import the Canvas app and your plug-ins and add them to the app:

import { run, addPlugin } from '@artevelde-uas/canvas-lms-app';
import somePlugin from '@some-org/plugin';

addPlugin(somePlugin);

run();

For more information see 'How to set up your project'.