@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
71 lines (70 loc) • 2.06 kB
TypeScript
/**
* Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { ForwardRefExoticComponent, RefAttributes } from 'react';
import { BaseSignInButtonProps } from './BaseSignInButton';
/**
* Props interface of {@link SignInButton}
*/
export type SignInButtonProps = BaseSignInButtonProps & {
/**
* Additional parameters to pass to the `authorize` request.
*/
signInOptions?: Record<string, any>;
};
/**
* SignInButton component that supports both render props and traditional props patterns.
*
* @remarks This component is only supported in browser based React applications (CSR).
*
* @example Using render props
* ```tsx
* <SignInButton>
* {({signIn, isLoading}) => (
* <button onClick={signIn} disabled={isLoading}>
* {isLoading ? 'Signing in...' : 'Sign In'}
* </button>
* )}
* </SignInButton>
* ```
*
* @example Using traditional props
* ```tsx
* <SignInButton className="custom-button">Sign In</SignInButton>
* ```
*
* @example Using component-level preferences
* ```tsx
* <SignInButton
* preferences={{
* i18n: {
* bundles: {
* 'en-US': {
* translations: {
* 'buttons.signIn': 'Custom Sign In Text'
* }
* }
* }
* }
* }}
* >
* Custom Sign In
* </SignInButton>
* ```
*/
declare const SignInButton: ForwardRefExoticComponent<SignInButtonProps & RefAttributes<HTMLButtonElement>>;
export default SignInButton;