Skip to content

Creating a New Homepage Module

Sam B edited this page May 26, 2020 · 7 revisions

What is a module?

The home page of MyMICDS is composed of different 'modules' (different from Angular Modules). These modules can be moved, resized, and configured to the user's liking. Within the MyMICDS Angular codebase, there's is an internal API to make it easy to create another module.

How to create a home page module

To create a new homepage module*, you first create a Angular component under /src/app/components/modules. Create a new folder following component/class naming conventions, and create the homepage module's styles, templates, and typescript there. Look at existing modules as an example.

After Creating a new module, you'll need to register it in the MyMICDS-SDK repository. You can learn more about making changes to the SDK here. You'll add it to the MyMICDSModuleType enum in /src/libs/modules.ts

If your module takes input from the parent component and/or uses the @Input decorator, you'll have to register that in the MyMICDS-v2 Repository under /src/libs/modules.ts.

Finally, add the module as an option on the home page by editing /src/app/components/modules/module-config.ts in the MyMICDS-v2-Angular repository.

If you are not using an icon from the

TODO add code examples from spec.

Clone this wiki locally