Reactium
  • Quick Start
  • Discuss
  • Approach
    • Architecture
    • DDD Introduction
    • Domain Model
  • Reactium App Foundation
    • Reactium Guides
      • Creating a Simple Single Page Web App (SPA)
      • Creating a Sassy Style Sheet
      • Reactium Core
      • Reactium + Actinium (APIs)
      • Reactium + REST
      • Plugin Module Guide
      • Animating React Routes
      • Reactium in Production
    • Reactium Domain Model
      • Basic Domain Model
      • Runtime Domain Model
      • Buildtime Domain Model
    • Reactium SDK
      • Reactium SDK Reference
    • Updating Reactium
  • Installing Foundations
    • Before You Install
    • Install Reactium
    • Install Actinium
  • Reactium API Foundation (Actinium)
    • Actinium Core
    • Setting up your User
    • Actinium SDK
      • Actinium SDK Reference
    • Actinium Domain Model
    • Extending
    • Updating
    • Live Query
  • Reactium Toolkit
    • Overview
    • Installation
    • Configuration
    • Customization
    • Creating Elements
      • Sidebar Elements
      • Toolbar Elements
      • Documentation Elements
    • Components
      • Sidebar
      • MenuLink
      • Element
      • Code
      • Markdown
      • Icon
    • Toolkit SDK
Powered by GitBook
On this page
  1. Reactium Toolkit

Configuration

PreviousInstallationNextCustomization

Last updated 4 years ago

You can modify the default behavior of the Toolkit by overriding the configuration object:

Property

Type

Description

brand

Node

String or component used to display the brand name

info

Node

String or component used to display version info

titlebar

String

Text used in the Titlebar of the browser

sidebar

Object

Sidebar configuration object

sidebar.collapsed

Boolean

Collapsed state of the Sidebar. Default: true

sidebar.position

String

Position of the Sidebar. Default: left

sidebar.width

Number

Width of the Sidebar when expanded. Default: 320

{
    brand: 'Reactium',
    info: 'Toolkit version %ver',
    titlebar: 'Reactium | Toolkit',
    sidebar: {
        collapsed: true,
        position: Reactium.Toolkit.Sidebar.position.left,
        width: 320,
    },
};

Note: The initial Sidebar configuration is overridden by user preferences.

/MyPlugin/reactium-hooks.js
import Reactium from 'reactium-core/sdk'; 

Reactium.Plugin.register('MyPlugin').then(() => {
    // Ensure the toolkit plugin is available
    if (!Reactium.Toolkit) return;
    
    // Override sidebar width
    Reactium.Toolkit.setConfig('sidebar.width', 480);
});

The exposes a read-only property for the configuration object:

Reactium.Toolkit.config
import React from 'react'; 
import Reactium from 'reactium-core/sdk';

const MyComponent = () => {
    const config = Reactium.Toolkit.config; 
    
    console.log(config); 
    
    return <div>My Plugin</div>;
};

Toolkit SDK