@withleaf/leaf-link-react/index.d.ts

Leaf Link - React

declare module '@withleaf/leaf-link-react' {
    import React from 'react';

    /*Props for the Authentication component.*/
    export interface AuthenticationProps {
        /*Flag indicating whether dark mode is enabled.*/
        isDarkMode: boolean;

        /*The name of the company.*/
        companyName: string;

        /*URL or path to the company's logo image.*/
        companyLogo: string;

        /*The name of the authentication provider.*/
        providerName: string;

        /*URL or path to the authentication provider's logo image.*/
        providerLogo: string;

        /*Information regarding the leaf user.*/
        leafUser: string;

        /*API key used for authentication.*/
        apiKey: string;

        /*Optional - Flag or object related to geofolia settings (specify further as needed).*/
        geofolia?: boolean;
    }

    /**
     * Authentication component responsible for rendering the authentication UI with theming support.
     * It dynamically changes the theme based on the isDarkMode prop and includes various elements
     * like company and provider logos.
     *
     * @param isDarkMode - Flag indicating whether dark mode is enabled.
     * @param companyName - The name of the company.
     * @param companyLogo - URL or path to the company's logo image.
     * @param providerName - The name of the authentication provider.
     * @param providerLogo - URL or path to the authentication provider's logo image.
     * @param leafUser - Information regarding the leaf user ID.
     * @param apiKey - API key used for authentication.
     * @param geofolia - Optional - Flag or object related to geofolia settings (specify further as needed).
     * @returns Authentication widget component.
     *
     * @see https://www.npmjs.com/package/@withleaf/leaf-link-react
     * @version 1.5.1
     */
    export const Authentication: React.FC<AuthenticationProps>;
}