Static Optional contextIf 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}</>;
}
}
https://react.dev/reference/react/Component#static-contexttype
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>
Static showShow toolbar.
Optional shouldCalled 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.
Optional componentOptional getRuns 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.
Optional componentCalled immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Optional snapshot: anyOptional componentCalled 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.
16.3, use componentDidMount or the constructor instead; will stop working in React 17
Optional UNSAFE_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.
16.3, use componentDidMount or the constructor instead
Optional componentCalled 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.
16.3, use static getDerivedStateFromProps instead; will stop working in React 17
Optional UNSAFE_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.
16.3, use static getDerivedStateFromProps instead
Optional componentCalled 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.
16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
Optional UNSAFE_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.
16.3, use getSnapshotBeforeUpdate instead
Get a reference to an array with object designers.
Finds a paint object designer by its unique identifier.
The matching designer if found, otherwise undefined.
The unique identifier of the paint object designer.
Call this method to create paint layer.
Toggle active paint tool.
Optional toolKey: PaintToolTypeOptional. Tool type.
Optional checked: booleanOptional. Checked state.
Called when paint object property changed.
Optional dirty: booleanSerializes and downloads the current command stack as a JSON file. If the browser supports the File System Access API, a native "Save as..." dialog will be used (user can edit the filename). Otherwise the method falls back to creating a Blob and triggering a download via an anchor element (with an optional prompt).
Resolves when the download/save operation is initiated or completed.
When serialization or file writing fails.
Options for export. objectsOnly: true will attempt to export only object-related commands.
Opens a file dialog to load commands from a JSON file
Promise resolving with loaded commands
Serializes an array of paint commands to a JSON string
JSON string representing the command stack
When invalid commands are provided
Array of paint commands to serialize
Deserializes a JSON string to an array of paint commands
Array of reconstructed paint commands
When the data cannot be deserialized
JSON string containing serialized commands
Gets the paint layer containing the HTML canvas for drawing the image.
Selected tool type.
Pencil color.
Pencil size.
Brush size.
Eraser size.
Clone Stamp size.
Font size.
Pencil opacity.
Brush opacity.
Eraser opacity.
Clone Stamp opacity.
Font opacity.
Brush hardness.
Eraser hardness.
Clone Stamp hardness.
Font name.
Italic font style.
Bold font style.
Max possible crop width.
Max possible crop height.
Natural aspect ratio.
Use the original image as source while applying edits.
Use the original image as source while applying edits.
Tool size.
Tool hardness.
Tool opacity.
Paint tools toolbar panel.