API Reference > ui-components > PropertyEditors > ToggleEditor

ToggleEditor<SS> Class

Beta

ToggleEditor React component that is a property editor with checkbox input

Extends

Implements

Methods

Name Description
getPropertyValue(): Promise<PropertyValue | undefined>    
getValue(): boolean    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<PropertyEditorProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<PropertyEditorProps>, nextState: Readonly<ToggleEditorState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<PropertyEditorProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<PropertyEditorProps>, nextState: Readonly<ToggleEditorState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
getSnapshotBeforeUpdate(prevProps: Readonly<PropertyEditorProps>, prevState: Readonly<ToggleEditorState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate.
shouldComponentUpdate(nextProps: Readonly<PropertyEditorProps>, nextState: Readonly<ToggleEditorState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Defined in

Last Updated: 08 January, 2020