Skip to main content
Version: 0.9.0-beta.2

Class: MonacoEditor

molecule.component.MonacoEditor

Hierarchy

Constructors

constructor

new MonacoEditor(props)

Parameters

NameType
propsany

Overrides

PureComponent<IMonacoEditorProps\>.constructor

Defined in

src/components/monaco/index.tsx:40

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

see https://reactjs.org/docs/context.html

Inherited from

PureComponent.context

Defined in

node_modules/@types/react/index.d.ts:469


monacoDom

Private monacoDom: HTMLDivElement

The dom element of editor container

Defined in

src/components/monaco/index.tsx:36


monacoInstance

Private monacoInstance: undefined | IStandaloneCodeEditor

The instance of monaco

Defined in

src/components/monaco/index.tsx:32


monacoService

Private Readonly monacoService: IMonacoService

Defined in

src/components/monaco/index.tsx:38


props

Readonly props: Readonly<IMonacoEditorProps> & Readonly<Object>

Inherited from

PureComponent.props

Defined in

node_modules/@types/react/index.d.ts:494


refs

refs: Object

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Index signature

[key: string]: ReactInstance

Inherited from

PureComponent.refs

Defined in

node_modules/@types/react/index.d.ts:500


state

state: Readonly<Object>

Inherited from

PureComponent.state

Defined in

node_modules/@types/react/index.d.ts:495


contextType

Static Optional contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number;
const Ctx = React.createContext<MyContext>(0);

class Foo extends React.Component {
static contextType = Ctx;
context!: React.ContextType<typeof Ctx>;
render() {
return <>My context's value: {this.context}</>;
}
}

see https://reactjs.org/docs/context.html#classcontexttype

Inherited from

PureComponent.contextType

Defined in

node_modules/@types/react/index.d.ts:451

Methods

UNSAFE_componentWillMount

Optional UNSAFE_componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

PureComponent.UNSAFE_componentWillMount

Defined in

node_modules/@types/react/index.d.ts:707


UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

NameType
nextPropsReadonly<IMonacoEditorProps>
nextContextany

Returns

void

Inherited from

PureComponent.UNSAFE_componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:739


UNSAFE_componentWillUpdate

Optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

NameType
nextPropsReadonly<IMonacoEditorProps>
nextStateReadonly<Object>
nextContextany

Returns

void

Inherited from

PureComponent.UNSAFE_componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:767


componentDidCatch

Optional componentDidCatch(error, errorInfo): void

Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

Parameters

NameType
errorError
errorInfoErrorInfo

Returns

void

Inherited from

PureComponent.componentDidCatch

Defined in

node_modules/@types/react/index.d.ts:636


componentDidMount

componentDidMount(): void

Returns

void

Overrides

PureComponent.componentDidMount

Defined in

src/components/monaco/index.tsx:45


componentDidUpdate

componentDidUpdate(prevProps): void

Parameters

NameType
prevPropsany

Returns

void

Overrides

PureComponent.componentDidUpdate

Defined in

src/components/monaco/index.tsx:55


componentWillMount

Optional componentWillMount(): void

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns

void

Inherited from

PureComponent.componentWillMount

Defined in

node_modules/@types/react/index.d.ts:693


componentWillReceiveProps

Optional componentWillReceiveProps(nextProps, nextContext): void

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

NameType
nextPropsReadonly<IMonacoEditorProps>
nextContextany

Returns

void

Inherited from

PureComponent.componentWillReceiveProps

Defined in

node_modules/@types/react/index.d.ts:722


componentWillUnmount

Optional componentWillUnmount(): void

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

Returns

void

Inherited from

PureComponent.componentWillUnmount

Defined in

node_modules/@types/react/index.d.ts:631


componentWillUpdate

Optional componentWillUpdate(nextProps, nextState, nextContext): void

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters

NameType
nextPropsReadonly<IMonacoEditorProps>
nextStateReadonly<Object>
nextContextany

Returns

void

Inherited from

PureComponent.componentWillUpdate

Defined in

node_modules/@types/react/index.d.ts:752


forceUpdate

forceUpdate(callback?): void

Parameters

NameType
callback?() => void

Returns

void

Inherited from

PureComponent.forceUpdate

Defined in

node_modules/@types/react/index.d.ts:486


getSnapshotBeforeUpdate

Optional getSnapshotBeforeUpdate(prevProps, prevState): any

Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

Parameters

NameType
prevPropsReadonly<IMonacoEditorProps>
prevStateReadonly<Object>

Returns

any

Inherited from

PureComponent.getSnapshotBeforeUpdate

Defined in

node_modules/@types/react/index.d.ts:672


render

render(): Element

Returns

Element

Overrides

PureComponent.render

Defined in

src/components/monaco/index.tsx:62


setState

setState<K>(state, callback?): void

Type parameters

NameType
Kextends never

Parameters

NameType
statenull | {} | (prevState: Readonly<Object>, props: Readonly<IMonacoEditorProps>) => null | {} | Pick<Object, K> | Pick<Object, K>
callback?() => void

Returns

void

Inherited from

PureComponent.setState

Defined in

node_modules/@types/react/index.d.ts:481


shouldComponentUpdate

Optional shouldComponentUpdate(nextProps, nextState, nextContext): boolean

Called to determine whether the change in props and state should trigger a re-render.

Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

Parameters

NameType
nextPropsReadonly<IMonacoEditorProps>
nextStateReadonly<Object>
nextContextany

Returns

boolean

Inherited from

PureComponent.shouldComponentUpdate

Defined in

node_modules/@types/react/index.d.ts:626