Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Moodle App Remote Themes Upgrade Guide

From MoodleDocs
Revision as of 11:58, 8 September 2021 by Noel De Martin 2 (talk | contribs) (Clean up (a lot of the removed content has been moved to the main "Moodle App Remote Themes" page))
Moodle App

Upgrade from previous versions:

For user documentation see Moodle Mobile


In the following guide, you will find some examples to migrate your styles from an older version to work with the Ionic 5 Moodle App (starting at version 3.9.5). You will find tables where each row is a migration to do; the left part is the old code and the right part the new one.

We recommend that you keep your old CSS rules for older versions (see Before starting the migration), by doing so users who are still using Moodle App 3.9.4 and earlier will see the same styling you had until now.

Before starting the migration

  1. Remove all styles using ionic classes ending with -wp (Windows Phone is not supported, therefore it’s not necessary to specify it).
  2. Check the theme file, where most variables are specified.
  3. As in the previous version, do not use any Saas variables (the ones starting with $). But now you can use CSS custom properties (the ones starting with --).
  4. We recommend prepending all CSS rules with body.ionic5 in order to make them only available for Ionic 5, and prepending the old ones with body:not(.ionic5) for the previous versions of the Moodle App (3.9.4, 3.9.3, and so on).
  5. Be aware that example rules may differ from your CSS, which could be more specific.

How to upgrade my theme

You can follow the same process that is documented in the Moodle App Remote Themes page.

Make sure to read it in order to understand how to style your application for newer versions of the app. If you're upgrading your styles, it is likely that the documentation has been updated since you read it.

Colors

The main color in the app is Moodle Orange, but you can now change it by using the --brand-color variable. This will probably reduce the CSS you are applying right now, but this only covers the main color.

For other colors, check out the colors section in the main documentation.

Header toolbar

On the header toolbar, we’ve added a bottom border that you can disable.

Border width and color (new)

ion-header ion-toolbar {
    --core-header-toolbar-border-width: 2px; /* Use 0 to disable it */
    --core-header-toolbar-border-color: yellow;
}

Background

.toolbar-background-md,
.toolbar-background-ios {
    background: red;
}

ion-header ion-toolbar {
    --core-header-toolbar-background: red;
}

Text and buttons

.toolbar-title-md,
.toolbar-title-ios {
    color: red;
}

ion-header ion-toolbar {
    --core-header-toolbar-color: red;
}

.toolbar-title-md,
.toolbar-title-ios {
    font-weight: normal;
}

ion-header ion-toolbar.in-toolbar h1,
ion-header ion-toolbar.in-toolbar h2 {
    font-weight: normal;
}

Bottom tab bar (main menu)

Background

.tabs-md .tabbar,
.tabs-ios .tabbar {
    background: red;
}

ion-tab-bar.mainmenu-tabs {
    --core-bottom-tabs-background: red;
    --core-bottom-tabs-background-selected: transparent;
}

Tab icon color

.tabs-md .tab-button-icon,
.tabs-ios .tab-button-icon {
    color: blue;
}

ion-tab-bar.mainmenu-tabs {
    --core-bottom-tabs-color: blue;
}

Selected tab icon color

tabs-md .tab-button[aria-selected=true] .tab-button-icon,
.tabs-ios .tab-button[aria-selected=true] .tab-button-icon {
    color: red;
}

ion-tab-bar.mainmenu-tabs {
    --core-bottom-tabs-color-selected: red;
}

Badge color and text

core-ion-tabs .tab-badge.badge {
    color: white;
    background: red;
}

ion-tab-bar.mainmenu-tabs {
    --core-bottom-tabs-badge-text-color: white;
    --core-bottom-tabs-badge-color: red;
}

Top tabs

Tabs background

.core-tabs-bar {
  background-color: red;
}

core-tabs, core-tabs-outlet {
    --core-tabs-background: red;
}

Individual tab background

.core-tabs-bar .tab-slide {
  background-color: red;
}

core-tabs, core-tabs-outlet {
    --core-tab-background: red;
}

Unselected tab styles

.core-tabs-bar .tab-slide {
  color: red;
  border-bottom-color: red;
}

core-tabs, core-tabs-outlet {
    --core-tab-color: red;
}

Selected tab styles

.core-tabs-bar .tab-slide[aria-selected=true]{
   color: red;
   border-bottom-color: red;
   font-weigth: normal;
}

core-tabs, core-tabs-outlet {
    --core-tab-color-active: red;
    --core-tab-border-color-active: red;
    --core-tab-font-weight-active: bold;
}

Items

Items background color

ion-item {
    background: red;
}

body {
    --ion-item-background: red;
}

Item divider background color

.item-divider-md,
.item-divider-ios {
    background: red;
    color: yellow;
}

body {
    --item-divider-background: red;
    --item-divider-color: yellow;
}

Empty divider background

New selector. 
body {
    --spacer-background: red;
}

Progress bar

You can now easily style progress bars. 

core-progress-bar {
    --core-progressbar-height: 8px;
    --core-progressbar-color: red;
    --core-progressbar-text-color: black;
    --core-progressbar-background: white;
}

More page

Icons

The icons in the More page can now easily change their color: 

page-core-mainmenu-more ion-icon {
    color: red;
}

page-core-mainmenu-more {
    --core-more-icon: red;
}

To change a color on a particular icon, you’ll have to use the class of each handler. For example, to change the color of the folder icon on the menu item named Files: 

page-core-mainmenu-more .ion-md-folder,
page-core-mainmenu-more .ion-ios-folder {
    color: red;
}

page-core-mainmenu-more .addon-privatefiles-handler ion-icon {  
    color: red !important;
}

Item border color

page-core-mainmenu-more .item-block.item-ios .item-inner,
page-core-mainmenu-more .item-block.item-md .item-inner {
    border-bottom-color: red;
}

page-core-mainmenu-more {
    --core-more-item-border: red;
}

The dividers background color can now be overridden using --spacer-background: 

page-core-mainmenu-more {
    --spacer-background: blue;
}

Login page

You can now personalize some colors in the Login page, but keep in mind that this only includes the credentials page (the one after you select the site). 

body {
    --core-login-background: red;
    --core-login-text-color: blue;
    --core-login-input-background: green;
    --core-login-input-color: yellow;
}

Calendar page

Calendar page can be personalized. 

body {
    --addon-calendar-event-category-color: purple;
    --addon-calendar-event-course-color: red;
    --addon-calendar-event-group-color: yellow;
    --addon-calendar-event-user-color: blue;
    --addon-calendar-event-site-color: green;
    --addon-calendar-today-border-color: orange;
    --addon-calendar-border-color: gray;
}

Messages page

Message discussion page, including chat activity and comments: 

body {
    --addon-messages-message-bg: white;
    --addon-messages-message-activated-bg: gray-light;
    --addon-messages-message-note-text: gray-dark;
    --addon-messages-message-mine-bg: gray-light;
    --addon-messages-message-mine-activated-bg: gray;
    --addon-messages-discussion-badge: orange;
    --addon-messages-discussion-badge-text: white;
}

You can also make some modifications on the input field: 

body {
    --core-send-message-input-background: gray-light;
    --core-send-message-input-color: black;
}

Full example

This is a full example showcasing how to handle multiple versions: 

/* ----- Ionic 5 styles ----- */

body.ionic5 {
    --core-header-toolbar-background: red;
}

/* Dark mode */
body.ionic5.dark {
    --core-header-toolbar-background: blue;
}

/* iOS only */
html.ios body.ionic5 {
    --core-link-color: green;
}

/* Android only */
html.md body.ionic5 {
    --core-link-color: yellow;
}


/* ----- Ionic 3 styles (legacy) ----- */

body:not(.ionic5) .toolbar-background {
    border-color: #004C9C;
    background: #004C9C;
}

As you can see we recommend to always add body.ionic as an starter of the css selectors, you can also use :root body.ionic5 or even html before body.

Retrieved from "https://docs.moodle.org/dev/index.php?title=Moodle_App_Remote_Themes_Upgrade_Guide&oldid=61250"
Powered by MediaWiki