Class Config<Cfg>

Creates an instance of the ~Config class.

Does exactly the same as #set:KEY_VALUE with one exception – passed configuration extends existing one, but does not overwrite already defined values.

This method is supposed to be called by plugin developers to setup plugin's configurations. It would be rarely used for other needs.

Does exactly the same as #set:CONFIG_OBJECT with one exception – passed configuration extends existing one, but does not overwrite already defined values.

This method is supposed to be called by plugin developers to setup plugin's configurations. It would be rarely used for other needs.

Gets the value for a configuration entry.

config.get( 'name' );
Copy

Deep configurations can be retrieved by separating each part with a dot.

config.get( 'toolbar.collapsed' );
Copy

Iterates over all top level configuration names.

Set configuration values.

It also accepts setting a "deep configuration" by using dots in the name. For example, 'resize.width' sets the value for the width configuration in the resize subset.

config.set( 'resize.width', 500 );
Copy

It accepts both a name/value pair or an object, which properties and values will be used to set configurations. See #set:CONFIG_OBJECT.

Set configuration values.

It accepts an object, which properties and values will be used to set configurations.

config.set( {
	width: 500
	toolbar: {
		collapsed: true
	}
} );

// Equivalent to:
config.set( 'width', 500 );
config.set( 'toolbar.collapsed', true );
Copy

Passing an object as the value will amend the configuration, not replace it.

config.set( 'toolbar', {
	collapsed: true,
} );

config.set( 'toolbar', {
	color: 'red',
} );

config.get( 'toolbar.collapsed' ); // true
config.get( 'toolbar.color' ); // 'red'
Copy

It accepts both a name/value pair or an object, which properties and values will be used to set configurations. See #set:KEY_VALUE.