Skip to content

Commit 1e477ca

Browse files
authored
Merge pull request #1437 from moodlemobile/app-docs
Mobile app updated docs
2 parents 7c97f2c + 655273b commit 1e477ca

File tree

3 files changed

+66
-1
lines changed

3 files changed

+66
-1
lines changed

general/app/development/plugins-development-guide/api-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ Add new option in the user profile page.
247247
| `type` | `'listitem'` | Visual representation of the option, accepted values are `listitem` and `button`. <br /> <br /> Before 4.4, the accepted values were `newpage` and `communication` (`newpage` was the default). |
248248
| `priority` | `0` | Priority of the handler, higher priority options are displayed first. |
249249
| `ptrenabled` | `true` | Whether to enable the PTR (pull-to-refresh) gesture in the page. |
250+
| `displayinusermenu` | - | Whether to display the option in the user menu (the menu displayed when the user clicks his own avatar at the top-right or top-left). Accepted values are: <ul><li>`no`: don't display the option in user menu.</li><li>`yes`: display the option in user menu. It will also be displayed in user profiles (like course participants) depending on the restrictions.</li><li>`only`: display the option only in user menu and never in user profiles.</li></ul>If not set, the option will be displayed in the user menu depending on the restricted courses and users. <br /> <br /> Only available in 5.1+. |
250251

251252
### CoreCourseFormatDelegate
252253

general/development/policies/accessibility.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The table below provides a history of the accessibility audits performed on the
4242

4343
#### Moodle App
4444

45-
The Moodle App was accredited to meet [WCAG 2.1 Level AA conformance](https://www.webkeyit.com/accessibility-services/accessibility-accreditations/moodle-mobile-app) on 9 May 2023. See [MOBILE-4182](https://moodle.atlassian.net/browse/MOBILE-4182) for more details.
45+
The Moodle App has been accredited to meet WCAG 2.2 Level AA conformance on 7 April 2025. See [MOBILE-4595](https://moodle.atlassian.net/browse/MOBILE-4595) for more details.
4646

4747
#### Moodle Workplace
4848

@@ -95,6 +95,10 @@ An overview of Moodle LMS' conformance with the [WCAG 2.2](https://www.w3.org/TR
9595

9696
An overview of Moodle Workplace's conformance with the [WCAG 2.2](https://www.w3.org/TR/WCAG22/) guidelines can be found in the [accessibility conformance report for Moodle Workplace](https://docs.moodle.org/en/Moodle_Workplace_VPAT#WCAG_2.x_report).
9797

98+
#### Moodle App
99+
100+
An overview of Moodle App's conformance with the [WCAG 2.2](https://www.w3.org/TR/WCAG22/) guidelines can be found in the [Moodle App accessibility conformance report](https://docs.moodle.org/en/Moodle_app_VPAT#WCAG_2.x_report).
101+
98102
<!-- cspell:ignore IAAP -->
99103
<!-- cspell:ignore credly -->
100104

general/development/policies/codingstyle-moodleapp.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,66 @@ export class MyService {
431431

432432
</InvalidExample>
433433

434+
If a constant needs to be used in a component template, it should be declared in the component without "static" because static properties cannot be used in templates. Please notice that the naming convention for non-static properties is camelCase.
435+
436+
<ValidExample title="Good">
437+
438+
```ts
439+
export class MyComponent {
440+
441+
protected readonly myConstant = '...';
442+
443+
}
444+
```
445+
446+
</ValidExample>
447+
448+
<InvalidExample title="Bad">
449+
450+
```ts
451+
452+
export class MyComponent {
453+
454+
protected readonly MY_CONSTANT = '...';
455+
456+
}
457+
```
458+
459+
</InvalidExample>
460+
461+
### Angular Signals
462+
463+
All signals in class properties must be defined as readonly properties to avoid overriding the whole signal by mistake. This includes input signals, computed signals, etc.
464+
465+
<ValidExample title="Good">
466+
467+
```ts
468+
export class MyComponent {
469+
470+
protected readonly myInput = input('...');
471+
protected readonly mySignal = signal('...');
472+
protected readonly myComputed = computed(() => ...);
473+
474+
}
475+
```
476+
477+
</ValidExample>
478+
479+
<InvalidExample title="Bad">
480+
481+
```ts
482+
483+
export class MyComponent {
484+
485+
protected myInput = input('...');
486+
protected mySignal = signal('...');
487+
protected myComputed = computed(() => ...);
488+
489+
}
490+
```
491+
492+
</InvalidExample>
493+
434494
## Angular
435495

436496
### Avoid calling methods in templates

0 commit comments

Comments
 (0)