@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
70 lines (69 loc) • 2.67 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 { EmbeddedFlowComponentV2 as EmbeddedFlowComponent } from '@asgardeo/browser';
/**
* Result of heading extraction from flow components
*/
export interface HeadingExtractionResult {
heading: EmbeddedFlowComponent | null;
subheading: EmbeddedFlowComponent | null;
}
/**
* Complete result of authentication component heading extraction
*/
export interface AuthComponentHeadingsResult {
title: string;
subtitle: string;
componentsWithoutHeadings: EmbeddedFlowComponent[];
headingComponents: HeadingExtractionResult;
}
/**
* Extracts heading and subheading components from authentication flow components
* and provides resolved title/subtitle text with fallback logic.
*
* This utility helps maintain consistent heading extraction across authentication
* components (SignIn, SignUp, etc.) by identifying heading components within the
* flow structure and providing clean fallback behavior.
*
* @param components - Array of flow components to search
* @param flowTitle - Title from flow context (highest priority)
* @param flowSubtitle - Subtitle from flow context (highest priority)
* @param defaultTitle - Default title fallback (lowest priority)
* @param defaultSubtitle - Default subtitle fallback (lowest priority)
* @returns Object with resolved title and subtitle text, plus filtered components
*
* @example
* ```typescript
* const result = getAuthComponentHeadings(
* components,
* flowTitle,
* flowSubtitle,
* t('signin.heading'),
* t('signin.subheading')
* );
*
* // Use resolved titles
* <Card.Title>{result.title}</Card.Title>
* <Typography>{result.subtitle}</Typography>
*
* // Render filtered components (without headings)
* renderComponents(result.componentsWithoutHeadings);
* ```
*/
declare const getAuthComponentHeadings: (components: EmbeddedFlowComponent[], flowTitle?: string, flowSubtitle?: string, defaultTitle?: string, defaultSubtitle?: string) => AuthComponentHeadingsResult;
export default getAuthComponentHeadings;