This repository contains an example theme for illustrative purposes only. It should not be installed and used, but referenced and copied in creating your own theme.
The example implements both the /server/theme/ and /client/component/
portions of the custom Theme. The /client/component/ portion includes examples
of Tui (Vue) component overrides at a page and smaller component level, as well as CSS
variable and SCSS overrides and extensions. The /server/theme/ portion
includes the PHP config and an example of Mustache template overriding used
throughout Totara Learn.
The /server/theme/ portion is licensed under GPLv3, while the
/client/component/ portion has a proprietary license - please see relevant
file headers for detail.
Automation can be set up via custom scripts, since there are two locations to
add code to, this example however simply provides the correct directory naming
structure for both /server/theme/ and /client/component/ portions.
Steps:
- Copy the example
/server/theme/exampleinto the/server/theme/directory within your Totara 13 codebase - Copy the example
/client/component/theme_exampleinto the/client/component/directory within your Totara codebase. - Rename all references of
exampletoyourthemenamein directory names, file names and file contents, for example method and variable names. - Follow
npmsetup instructions in/readme.mdwithin the root directory of your Totara 13 codebase
Documentation is available on the Totara public developer documentation website, covering architectural goals, technology stack and more detail on custom themes. Improvements and feedback are welcome, both for this example and the public developer documentation, please submit your feedback to the Totara Support team.