1.2.0 • Published 1 year ago

@artevelde-uas/canvas-lms-better-left-menu-plugin v1.2.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

Canvas LMS Better Left Menu Plug-in

Plugin for the Canvas LMS theme app that adds several options to improve the left menu.

npm.io npm.io npm.io

Features

This plug-in fixes the following issues with the left menu:

  • The scrollbar on the menu will adjust it's height to fill the available screen height.
  • The tooltips will display on the right hand side so they don't overlap with the other links in the menu.

The following configurable options are available:

  • Hide the scrollbar or have it only appear on hover.
  • Switch back to the classic menu styles (with current selection background in primary color).
  • Use a thinner version of the scrollbar.
  • Reset the scrollbar on page scroll or when the menu is expanded.

Installation

Using NPM:

npm install @artevelde-uas/canvas-lms-better-left-menu-plugin

Using Yarn:

yarn add @artevelde-uas/canvas-lms-better-left-menu-plugin

Usage

Just import the plug-in and add it to the Canvas app:

import { run, addPlugin } from '@artevelde-uas/canvas-lms-app';
import betterLeftMenuPlugin from '@artevelde-uas/canvas-lms-better-left-menu-plugin';

addPlugin(betterLeftMenuPlugin, {
    classicStyles: true,
    thinScrollbar: true,
    showScrollbar: 'hover',
    resetOnScroll: true
});

run();

Options

NameTypeDefaultDescription
showScrollbar{String\|Boolean}trueDetermines whether the scrollbar should be shown or not, or only on hover (possible values: true, 'hover' or false).
thinScrollbar{Boolean}falseUse a thin scrollbar.
classicStyles{Boolean}falseUse the classic menu styles (with current selection background in primary color).
resetOnScroll{Boolean}falseDetermines whether the scrollbar should be reset on scroll or when the menu is expanded.
1.2.0

1 year ago

1.1.0

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago