@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
76 lines (75 loc) • 2.57 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 { HTMLAttributes, ReactNode, RefAttributes, ForwardRefExoticComponent } from 'react';
export type AlertVariant = 'success' | 'error' | 'warning' | 'info';
export interface AlertProps extends HTMLAttributes<HTMLDivElement> {
/**
* The visual variant of the alert that determines color scheme and icon
*/
variant?: AlertVariant;
/**
* Whether to show the default icon for the variant
*/
showIcon?: boolean;
/**
* Alert content
*/
children?: ReactNode;
}
export interface AlertTitleProps extends HTMLAttributes<HTMLHeadingElement> {
/**
* Title content
*/
children?: ReactNode;
}
export interface AlertDescriptionProps extends HTMLAttributes<HTMLParagraphElement> {
/**
* Description content
*/
children?: ReactNode;
}
export declare const useAlertVariant: () => AlertVariant;
/**
* Alert component that displays important information with different severity levels.
*
* @example
* ```tsx
* <Alert variant="success" showIcon>
* <Alert.Title>Success! Your changes have been saved</Alert.Title>
* <Alert.Description>
* This is an alert with icon, title and description.
* </Alert.Description>
* </Alert>
* ```
*/
declare const Alert: ForwardRefExoticComponent<AlertProps & RefAttributes<HTMLDivElement>>;
/**
* Alert title component.
*/
declare const AlertTitle: ForwardRefExoticComponent<AlertTitleProps & RefAttributes<HTMLHeadingElement>>;
/**
* Alert description component.
*/
declare const AlertDescription: ForwardRefExoticComponent<AlertDescriptionProps & RefAttributes<HTMLParagraphElement>>;
export interface AlertComponent extends ForwardRefExoticComponent<AlertProps & RefAttributes<HTMLDivElement>> {
Title: typeof AlertTitle;
Description: typeof AlertDescription;
}
declare const _default: AlertComponent;
export default _default;
export { Alert, AlertTitle, AlertDescription };