Material UI

Adds Material UI theme Provider to BlueRain.

Usage

Run the following command in the plugin directoy:

npm i --save @blueeast/bluerain-plugin-material-ui

Then in your boot function, pass the plugin like this:

import BR from '@blueeast/bluerain-os';
import MaterialUiPlugin from '@blueeast/bluerain-plugin-material-ui';

BR.boot({
    plugins: [MaterialUiPlugin]
})

Components

None.

Filters

This plugin provides complete flexibility to modify the material ui theme. This is done by providing various filter hooks.

material-ui.theme

This hook gives the ability to modify the plugin configurations.

Parameters:

Name

Type

Description

theme

Object

Custom Theme

Returns:

Name

Type

Description

theme

Object

Custom Theme

Example:

This example customizes the theme to make the AppBar color red.

import BR from '@blueeast/bluerain-os';

BR.Filters.add(
    'material-ui.theme',
    function CustomTheme(theme) {
        return Object.assign({}, theme, {
            appBar: {
                color: 'red'
            }
        })
    }
);

API

MaterialUiPlugin

Extends Plugin

Material UI Plugin

Properties

  • pluginName string "MaterialUiPlugin"

  • slug string "material-ui"

Last updated