API Reference > ui-framework > OIDC > SignIn

SignIn React component. this.props.oidcClient.signIn is called when the "Sign In" button is pressed, then props.onSignedIn is called after sign-in has completed.

Extends

Methods

Name Description
constructor(props: SignInProps): SignIn    
componentDidMount(): void    
componentWillUnmount(): void    
render(): 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<SignInProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<SignInProps>, nextState: Readonly<S>, 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.
componentDidUpdate(prevProps: Readonly<SignInProps>, prevState: Readonly<S>, snapshot?: SS): void Optional NewLifecycle Called immediately after updating occurs.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<SignInProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<SignInProps>, nextState: Readonly<S>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
getSnapshotBeforeUpdate(prevProps: Readonly<SignInProps>, prevState: Readonly<S>): 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<SignInProps>, nextState: Readonly<S>, 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