Quick Start

1. Requirements

Before proceeding, you need to have the latest stable node.js
Recommended environment:
  • node js 20+
  • npm js 10+

2. Installation

Open package folder and install its dependencies. We recommended yarn or npm.
Script Project Folder
Install npm
 
                                      
cd project-folder
npm install
Start
 
                                      
npm run dev or yarn run dev
Build
 
                                      
npm run build or yarn build

3. Color Themes

By default, MaterialM applies the default theme using the activeTheme attribute to define the skin option. You can modify it or add your custom skin as needed in config.ts / config.js file.

By Default we are giving 6 color themes :

Blue_Theme Aqua_Theme Purple_Theme Green_Theme Cyan_Theme Orange_Theme 
                            
activeTheme: "BLUE_THEME",

4. Theming

MaterialM offers both light and dark style options, with the light style set as the default.

By Default we are giving 2 color themes, you just need to change attribute of activeMode in config.ts / config.js file :

light dark 
                            
activeMode: "light",

5. RTL Supported

MaterialM comes with built-in RTL support by default.

To enable RTL direction, add activeDir: "rtl" attribute in the config.ts / config.js file.

ltr rtl 
                            
activeDir: "rtl",