- Preparing search index...
- The search index is not available
@unologin/next
- useLogin<DefaultOptions, LoginOptionsType>(defaultOptions?: DefaultOptions): CallbackWithState<CallbackWithState<((...args: DefaultOptions extends LoginOptions ? [] | [LoginOptionsType] : [LoginOptionsType]) => Promise<void>), {
loading: boolean;
}>, {
open: boolean;
}>
-
Type Parameters
-
DefaultOptions extends Partial<LoginOptions> = {}
-
LoginOptionsType = Partial<LoginOptions> & Omit<LoginOptions, keyof DefaultOptions>
Parameters
-
Optional defaultOptions: DefaultOptions
Returns CallbackWithState<CallbackWithState<((...args: DefaultOptions extends LoginOptions ? [] | [LoginOptionsType] : [LoginOptionsType]) => Promise<void>), {
loading: boolean;
}>, {
open: boolean;
}>
Returns a stateful function to initiate the unologin login flow.
The
loginfunction returns aPromise.The
Promisewill resolve after successful login.The
Promisewill reject otherwise.Example
Returns
Asynchronous function to initiate login flow.