RoosterRichTextEditor
@spartanfx/react / index / RoosterRichTextEditor
Class: RoosterRichTextEditor
Extends
default<IRoosterRichTextEditorProps>
Constructors
Constructor
new RoosterRichTextEditor(props): RoosterRichTextEditor;
Parameters
props
Returns
RoosterRichTextEditor
Overrides
MainPaneBase<IRoosterRichTextEditorProps>.constructor
Methods
componentDidCatch()?
optional componentDidCatch(error, errorInfo): void;
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters
error
Error
errorInfo
ErrorInfo
Returns
void
Inherited from
MainPaneBase.componentDidCatch
componentDidMount()
componentDidMount(): void;
Called immediately after a component is mounted. Setting state here will trigger re-rendering.
Returns
void
Overrides
MainPaneBase.componentDidMount
componentDidUpdate()?
optional componentDidUpdate(
prevProps,
prevState,
snapshot?): void;
Called immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Parameters
prevProps
Readonly<P>
prevState
Readonly<S>
snapshot?
any
Returns
void
Inherited from
MainPaneBase.componentDidUpdate
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.
Returns
void
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.componentWillMount
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.
Parameters
nextProps
Readonly<P>
nextContext
any
Returns
void
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.componentWillReceiveProps
componentWillUnmount()
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
Overrides
MainPaneBase.componentWillUnmount
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.
Parameters
nextProps
Readonly<P>
nextState
Readonly<S>
nextContext
any
Returns
void
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.componentWillUpdate
forceUpdate()
forceUpdate(callback?): void;
Parameters
callback?
() => void
Returns
void
Inherited from
MainPaneBase.forceUpdate
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
prevProps
Readonly<P>
prevState
Readonly<S>
Returns
any
Inherited from
MainPaneBase.getSnapshotBeforeUpdate
popout()
popout(): void;
Returns
void
Overrides
MainPaneBase.popout
render()
render(): Element;
Returns
Element
Overrides
MainPaneBase.render
resetEditorPlugin()
resetEditorPlugin(pluginState): void;
Parameters
pluginState
BuildInPluginState
Returns
void
Overrides
MainPaneBase.resetEditorPlugin
setPageDirection()
setPageDirection(isRtl): void;
Parameters
isRtl
boolean
Returns
void
Overrides
MainPaneBase.setPageDirection
setScale()
setScale(scale): void;
Parameters
scale
number
Returns
void
Overrides
MainPaneBase.setScale
setState()
setState<K>(state, callback?): void;
Type Parameters
K
K extends keyof MainPaneBaseState
Parameters
state
| MainPaneBaseState
| ((prevState, props) => MainPaneBaseState | Pick<MainPaneBaseState, K>)
| Pick<MainPaneBaseState, K>
callback?
() => void
Returns
void
Inherited from
MainPaneBase.setState
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
nextProps
Readonly<P>
nextState
Readonly<S>
nextContext
any
Returns
boolean
Inherited from
MainPaneBase.shouldComponentUpdate
toggleContentModelRibbon()
toggleContentModelRibbon(): void;
Returns
void
Overrides
MainPaneBase.toggleContentModelRibbon
toggleDarkMode()
toggleDarkMode(): void;
Returns
void
Overrides
MainPaneBase.toggleDarkMode
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.
Returns
void
Deprecated
16.3, use componentDidMount or the constructor instead
See
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.UNSAFE_componentWillMount
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.
Parameters
nextProps
Readonly<P>
nextContext
any
Returns
void
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.UNSAFE_componentWillReceiveProps
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.
Parameters
nextProps
Readonly<P>
nextState
Readonly<S>
nextContext
any
Returns
void
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
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Inherited from
MainPaneBase.UNSAFE_componentWillUpdate
updateFormatState()
updateFormatState(): void;
Returns
void
Overrides
MainPaneBase.updateFormatState
updateRibbonVisibility()
updateRibbonVisibility(isVisible): void;
Parameters
isVisible
boolean
Returns
void
Overrides
MainPaneBase.updateRibbonVisibility
getInstance()
static getInstance(): MainPaneBase<any>;
Returns
MainPaneBase<any>
Inherited from
MainPaneBase.getInstance
Properties
Required
| Property | Type | Description |
|---|---|---|
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 |
props | Readonly<IRoosterRichTextEditorProps> & Readonly<{ children?: ReactNode; }> | - |
refs | object | Deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs |
state | Readonly<S> | - |
Options
| Property | Type | Description |
|---|---|---|
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 |