Skip to content

elearning-evolve/canvas-custom-changes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

Canvas Custom Changes

Custom UI rebranding for Canvas LMS using:

  • config/locales/en-x-custom.yml
  • public/javascripts/canvas-workbook-saved.js

This setup is designed to avoid changing Canvas core Ruby/ERB files.

What This Customization Does

1 Locale-based text changes (en-x-custom.yml)

Main terminology updates include:

  • Quizzes -> Fellow Workbooks
  • Modules -> Mentor Materials
  • Files -> Artifacts
  • Teacher/teachers -> Mentor/mentors
  • Student/students -> Fellow/fellows

Examples:

  • "Take the Quiz" -> "Begin Workbook"
  • "Resume Quiz" -> "Resume Workbook"
  • "Submit Quiz" -> "Submit your Workbook"
  • Quiz statistics labels switched to workbook wording
  • Many related quiz/module/file labels and messages are overridden

2 Theme JavaScript changes (canvas-workbook-saved.js)

This script handles UI text generated by frontend JavaScript (which is not always controlled by en-x-custom.yml):

  • "Quiz saved ..." -> "Workbook saved ..."
  • Files search placeholder from "Search for files" -> "Search for Workbooks"

Why JS Is Needed

Some Canvas frontend strings are loaded from JS translation bundles (commonly en.json) instead of reading from en-x-custom.yml directly. Because of this, a small theme JS helper is used for those specific labels.

Deployment (Live Site)

A Server file

Copy locale file to Canvas:

  • config/locales/en-x-custom.yml

B Locale registration

Ensure custom locale is registered in config/locales/locales.yml so it appears in language settings.

C Theme JS upload

In Canvas Theme Editor, upload/select:

  • canvas-workbook-saved.js

This should be attached as the account theme JavaScript file.

D Language selection

Set language to your custom locale (English Custom / en-x-custom) at account/user level as needed.

E Restart and refresh

  • Restart app processes after locale file updates
  • Hard refresh browser after theme updates

Notes

  • This repository keeps customizations isolated to custom locale + theme JS.
  • No Canvas core helper/view/controller edits are required for this approach.

About

Custom UI changes in Canvas LMS to adapt it for rebranding and customization

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors