MMapContext

The MMapContext class creates a context that components can provide or read.

The most common way to transfer information from a parent component to a child component is via props. However, if a tree has a complex structure of components or multiple components need the same information, transferring props can become cumbersome and inconvenient. Context enables a parent component to make some information available to any component in the tree below it without explicitly transferring it via props.

MMapContext doesn't contain any information. It determines which context is read or provided by other components. The context provider is the MMapContextProvider class.

MMapContextProviderMMapContextProvider

MMapContextProvider is a context provider for MMap, allowing the input of the context and its value.

Usage exampleUsage example

const mapContextProvider = new MMapContextProvider({context: SomeMapContext, value: {your: 'value'}});
map.addChild(mapContextProvider);

class SomeContextConsumer extends mappable.MMapEntity<{}> {
   constructor() {
       super({});
   }

   _onAttach() {
     const value = this._consumeContext(SomeMapContext);
     console.log(value); // {your: 'value'}
   }
}

mapContextProvider.addChild(new SomeContextConsumer());

<MMapContextProvider context={SomeMapContext} value={{your: 'value'}}>
    <MMapContainer>
        <MMapContainer>
            <SomeContextConsumer />
        <MMapContainer>
    </MMapContainer>
</MMapContextProvider>

ConstructorConstructor

new MMapContextProvider<T>(props, options?)

Constructor parametersConstructor parameters

Inherited from MMapGroupEntity.constructor.

new MMapContextProvider<T>(props, children?, options?)

Constructor parametersConstructor parameters

Inherited from MMapGroupEntity.constructor.

PropsProps

MMapContextProviderProps<T>: Object

ParametersParameters

MethodsMethods

addChildaddChild

addChild(child, index?): MMapContextProvider<T>

ParametersParameters

ReturnsReturns

MMapContextProvider<T>

Inherited fromInherited from

MMapGroupEntity.addChild

removeChildremoveChild

removeChild(child): MMapContextProvider<T>

ParametersParameters

ReturnsReturns

MMapContextProvider<T>

Inherited fromInherited from

MMapGroupEntity.removeChild

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

ReturnsReturns

void

Inherited fromInherited from

MMapGroupEntity.update