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>
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}</>;
}
}
Gets or sets the background color to use.
Gets or sets the amount of bottom activation border to use for the cell content of this column.
Gets or sets the amount of left activation border to use for the cell content for this column.
Gets or sets the amount of right activation border to use for the cell content of this column.
Gets or sets the amount of top activation border to use for the cell content for this column.
Gets the actual background color that will be used.
Gets the actual background color that will be used.
Gets the actual border color that will be used.
Gets the actual error border color that will be used.
Gets the actual color for the last row in the sticky row area.
Gets the actual line break mode which will be used if text is present in the cell.
Gets the actual background color for cells belonging to rows marked as pinned.
Gets or sets the color to use for displaying text.
Gets the actual background color for content that sticks to the top of the grid.
Gets the actual color used for displaying text.
Gets or sets the background color to use.
Gets or sets the background color to use.
Gets or sets the amount of bottom border to use for the cell content of this column.
Gets or sets the amount of left border to use for the cell content for this column.
Gets or sets the amount of right border to use for the cell content of this column.
Gets or sets the amount of top border to use for the cell content for this column.
Called when the style key for a cell is needed. Used for recycling the cell.
Called when the style key for a cell is needed. Used for recycling the cell.
Gets or sets the opacity of the content.
Called when a cell is data binding.
Called when a cell is data binding.
Called when a cell has been data bound.
Called when a cell has been data bound.
Gets or sets the error border color to use.
Gets or sets the horizontal alignment to use for the cell content.
Gets or sets the color for the last row in the sticky row area.
Gets or sets the line breaking mode to use if text is present in the cell.
Gets or sets the background color for cells belonging to rows marked as pinned.
Gets or sets the color to use for displaying text.
Gets or sets the background color for content that sticks to the top of the grid.
Gets or sets the color to use for displaying text.
Gets or sets the vertical alignment to use for the cell content.
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
Base class for various definition types for the grid.