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 color to use for the actual header selectAllCaption text.
Gets or sets the color to use for the background of the component.
Gets or Sets the property name that contains the values.
Gets or Sets the property name that contains the values.
Gets or sets the checkbox background color when checked.
Gets or sets the checkbox border color when checked.
Gets or sets the checkbox tick color.
Gets or sets the checkbox background color when unchecked.
Gets or sets the checkbox border color when unchecked.
Called when a checkbox is checked or unchecked.
Called when a checkbox is checked or unchecked.
Gets or Sets the property name that contains the values.
Gets or Sets the property name that contains the values.
Gets or Sets the property name that contains the values.
Gets or Sets the property name that contains the values.
Gets or sets whether row hover highlighting is enabled.
Gets the collection responsible for selection in the CheckboxList. Selection is determined by two factors: whether everything is selected or deselected and the values present in this collection. If everything is selected then any items in this collection will be deselected. If everything is deselected then any items in this collection will be selected. The CheckboxList defaults all items as deselected. This state can change when you use the SelectAll and DeselectAll methods.
Gets or sets the primary key to use for the CheckboxList.
Gets or Sets the property name that contains the values.
Gets or sets the color to use when hovering over a grid row.
Gets or sets the scrollbar background color.
Gets or sets the style of scrollbar.
Gets or sets the search background color.
Gets or sets the search border color.
Gets or sets the search icon color.
Gets or Sets the property name that contains the values.
Gets or sets the search text color.
Gets or sets the text style.
Gets / sets the caption of the "Select All" checkbox.
Gets or sets the color to use for the "Select All" label.
Called when the SelectAll checkbox is checked or unchecked.
Called when the SelectAll checkbox is checked or unchecked.
Called when an item is added.
Called when an item is added.
Called when an item is removed.
Called when an item is removed.
Gets or Sets the property name that contains the values.
Gets or sets whether the filter input is visible.
Gets / sets whether the "Select all" checkbox is visible.
Gets or sets the color to use for the text of the component.
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
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.
If using the new style context, re-declare this in your class to be the
React.ContextType
of yourstatic contextType
. Should be used with type annotation or static contextType.