@eccenca/gui-elements
Version:
GUI elements based on other libraries, usable in React application, written in Typescript.
29 lines (28 loc) • 1.17 kB
TypeScript
import React from "react";
import { HeaderNameProps as CarbonHeaderNameProps } from "@carbon/react";
type SvgDepiction = HTMLElement & SVGElement;
type ImgDepiction = HTMLElement & HTMLImageElement;
export type ApplicationTitleProps = CarbonHeaderNameProps<"a"> & {
/**
application logo, <img>, <svg> or react element
*/
depiction?: ImgDepiction | SvgDepiction | React.ReactNode;
/**
is the application title visually displayed or not
*/
isNotDisplayed?: boolean;
/**
if displayed, is the width aligned with displayed sidebar navigation
*/
isAlignedWithSidebar?: boolean;
/**
is the sidebar navigation currently displayed or not
*/
isApplicationSidebarExpanded: boolean;
/**
native attributes for the anchor HTML element (<a>)
*/
htmlAProps?: React.AnchorHTMLAttributes<HTMLAnchorElement>;
};
export declare const ApplicationTitle: ({ children, className, prefix, href, depiction, isNotDisplayed, isAlignedWithSidebar, isApplicationSidebarExpanded, htmlAProps, ...otherCarbonHeaderNameProps }: ApplicationTitleProps) => React.JSX.Element;
export default ApplicationTitle;