Moodle App Customisation
- Moodle App Overview
- Moodle App Development Guide
- Moodle App Plugins Development Guide
- Moodle App Remote Themes
- Moodle App Customisation
- Setting up your development environment
- Using the Moodle App in a browser
- Moodle App Translation
- Moodle App FAQ
- Moodle App Development Process
- Moodle App Release Notes
Upgrade from previous versions:
- See all Moodle App pages
- See pages for Moodle App Ionic 5 (current)
- See pages for Moodle App Ionic 3 (legacy)
- See pages Moodle App Ionic 1 (legacy)
- See pages for Moodle App Phonegap (legacy)
For user documentation see Moodle Mobile
Overview
Moodle Mobile can be customized in different ways:
- Changing the app appearance for your site.
- Adding support in your plugin for the mobile app.
- Configuring how the app should work via Moodle site settings.
- Creating a custom application (with your custom name and icon) based on the Moodle Mobile code.
With the first three options, you are not required to compile or build your custom application. With the last one, you are required to compile and publish your custom app in the stores.
Changing the app appearance for your site
The Mobile app can retrieve your custom styles from your Moodle site. Since it is an HTML5 app, you can safely apply CSS3 styles.
In your Moodle installation, go to Plugins / Web services / Mobile and enter in the mobilecssurl field a valid URL pointing to a CSS file containing your custom styles (theme).
The CSS should be placed inside your Moodle installation (in your custom theme or inside a local plugin)
Once the user is logged in to the app, there is a periodical process that retrieves your remote CSS files for applying your custom styles into the app.
Notice that the first time a user opens the app, he will see the default "orange" style. Your custom styles will be applied once the user has added a site in the app.
Notice that styles come from a site; thus, there is no way to change the initial Add site / Manage account pages styles.
See Moodle Mobile Themes for additional information.
Mobile support for plugins
You can create Moodle plugins to change how the app works. See Mobile support for plugins for complete information.
Creating a custom application
See Moodle Mobile custom apps or The Branded Moodle Mobile App service by Moodle HQ
Building
To build the app you should check use Ionic CLI tools, see: http://ionicframework.com/docs/cli/run.html
Phonegap Build service was discontinued October, 1 2020.
Configuring how the app should work via Moodle site settings
The app can be configured via Moodle site settings. You can disable features, rename strings, add new elements to the main menu or change how log out works in the app. This requires Moodle 3.3 or the [Moodle Mobile additional features plugin].
Please refer to the Configuring the app from your site section on this page: https://docs.moodle.org/en/Moodle_Mobile_guide_for_admins
Testing and developing
Chromium or Google Chrome browser
See Moodle Mobile development using Chrome or Chromium
