FocusTrap<SS> Class

Beta  

Trap Focus in container while trap is active.

Extends

  • Component<Props, State>

Methods

Name Description
constructor(props: Props): FocusTrap    
componentDidUpdate(prevProps: Props, prevState: State): void    
componentWillUnmount(): void    
isFocusable(element: HTMLElement): boolean    
render(): null | Element    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, 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.
componentDidMount(): void Optional ComponentLifecycle Called immediately after a component is mounted.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component<Props, State>  
getSnapshotBeforeUpdate(prevProps: Readonly<Props>, prevState: Readonly<State>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
setState<K extends undefined>(state: (prevState: Readonly<State>, props: Readonly<Props>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<Props, State>  
shouldComponentUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Inherited properties

Name Type Inherited from Description
context any Component<Props, State> If using the new style context, re-declare this in your class to be the
contextType Static undefined | Context<any> Component<Props, State> If set, this.context will be set at runtime to the current value of the given Context.
props Readonly<Props> & Readonly<{ children?: ReactNode }> Component<Props, State>  
refs [key: string]: ReactInstance Component<Props, State>  
state Readonly<State> Component<Props, State>  

Defined in

Last Updated: 13 June, 2024