@gpa-gemstone/react-interactive
Version:
Interactive UI Components for GPA products
53 lines (52 loc) • 1.47 kB
TypeScript
import * as React from 'react';
import { Application } from '@gpa-gemstone/application-typings';
interface IProps {
/**
* Root path for all routes
*/
HomePath: string;
/**
* Default sub-path to navigate to when landing on HomePath
*/
DefaultPath: string;
/**
* Optional logo URL to display in the top navigation bar
*/
Logo?: string;
/**
* Callback function used when user clicks "Sign out"
*/
OnSignOut?: () => void;
/**
* Optional version string used in sidebar footer
*/
Version?: string;
/**
* List of user roles used for access control and conditional route rendering
*/
UserRoles?: Application.Types.SecurityRoleName[];
/**
* Allows toggling of the sidebar collapse/expand functionality
*/
AllowCollapsed?: boolean;
/**
* Optional JSX to be rendered on the top navigation bar
*/
NavBarContent?: React.ReactNode;
/**
* Flag to hide sidebar completely
*/
HideSideBar?: boolean;
/**
* Optional flag that disables modern navigation and layout, defaulting to false
*/
UseLegacyNavigation?: boolean;
}
interface IApplicationRefs {
mainDiv: HTMLDivElement | null;
navBarDiv: HTMLDivElement | null;
}
declare const _default: React.ForwardRefExoticComponent<IProps & {
children?: React.ReactNode | undefined;
} & React.RefAttributes<IApplicationRefs>>;
export default _default;