Bitsmist Frameworks
Docs » SettingOrganizer

SettingOrganizer

Inherit:Organizer

Overview

SettingOrganizer manages basic settings such as the component's name and path. SettingOrganizer is called before any other organizers are called.

Organizing

At the initialization stage, it chains the component's settings property to global settings if “settings.useGlobalSettings” is set to True.

At the organizing stage, it loads settings passed via parameters and stores them as component settings. It also loads settings from an external setting file if specified, and load settings from tag attribute if exists.

Sections

  • settings

Timings

  • beforeStart

Tag Attributes

Some component settings can be specified in tag attributes. Tag attributes have higher priority than settings.

bm-settingref

Type:String

A URL to the component setting file. The setting file will be loaded asynchronously.

bm-settings

Type:String

Settings in JSON format. These settings are merged into the component's settings as if they are placed in the “settings” section.

Extended properties

settings

Type:Store Inject:Component get

Returns a Store class that holds settings for the component.

Previous Next

© 2019-2023 Masaki Yasutake

Bitsmist Frameworks

Table of Contents

Table of Contents

  • SettingOrganizer
    • Overview
    • Organizing
    • Tag Attributes
      • bm-settingref
      • bm-settings
    • Extended properties
      • settings

GENERAL

  • Overview
  • Installation
  • Create a sample component

COMPONENT

  • Loading
  • Settings
  • Events
  • Extending with organizers

REFERENCE - COMPONENT

  • Component

REFERENCE - ORGANIZER

  • EventOrganizer
  • LoaderOrganizer
  • OrganizerOrganizer
  • SettingOrganizer
  • StateOrganizer
  • TemplateOrganizer

REFERENCE - STORE

  • Store
  • ChainableStore

REFERENCE - UTILITY

  • AjaxUtil
  • ClassUtil
  • Util