Readonly propsStatic 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}</>;
}
}
Determines whether the end user can inner dock another pane in this one. Defaults to true.
Determines whether the end user is allowed to close the pane. Defaults to true.
Determines whether the end user is allowed to dock the pane. Defaults to true.
Determines whether the end user is allowed to make the pane floating. Defaults to true.
Determines whether the end user is allowed to maximize the pane.
Determines whether the end user is allowed to pin/unpin the pane. Defaults to true.
The slot attribute's value of the content element.
Determines whether a pane is disabled. Defaults to false.
Marks that a content pane can be docked only inside a document host.
The slot attribute's value of the floating header element. If not set, the headerId property value is used.
The text header of the content pane. Even if header slot templates are used, the text header is used for aria label.
The slot attribute's value of the content pane header element. If not set, the header property value is used.
Determines whether a pane is hidden in the UI. Defaults to false.
The id of the pane. If not set the Dock Manager generates it automatically.
Determines whether a content pane is maximized or not. Defaults to false.
Determines whether a content pane is pinned or not. Defaults to true.
The size of the pane relative to its sibling panes' sizes. Defaults to 100.
The slot attribute's value of the tab header element. If not set, the header property value is used.
The type of the pane.
The slot attribute's value of the unpinned header element. If not set, the header property value is used.
The desired unpinned location of the content pane. If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. If there is no document host, the default location is left.
The absolute size of the pane in an unpinned state. Defaults to 200.
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 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 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
Optional componentOptional 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 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 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 componentOptional 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 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.
Static _create
If using the new style context, re-declare this in your class to be the
React.ContextTypeof yourstatic contextType. Should be used with type annotation or static contextType.