@massds/mayflower-react
Version:
React versions of Mayflower design system UI components
35 lines (34 loc) • 1.03 kB
TypeScript
/**
* SiteLogo module.
* @module @massds/mayflower-react/SiteLogo
* @requires module:@massds/mayflower-assets/scss/01-atoms/site-logo
* @requires module:@massds/mayflower-assets/scss/01-atoms/image
*/
import React from 'react';
import { ImageProps } from '../Image';
export interface SiteLogoProps {
/** The URL for the site */
url?: {
/** The URL for the site root */
domain: string;
};
/** The site logo image to display. */
image?: ImageProps;
/** An optional label to display next to the site logo. */
siteName?: string;
/** The title attribute for the site logo link. */
title?: string;
/** An uninstantiated component for rendering a wrapper around the site logo div. */
Wrapper?: React.ElementType;
}
declare const SiteLogo: {
({ url, image, siteName, title, Wrapper }: SiteLogoProps): any;
defaultProps: {
image: {
alt: string;
width: number;
height: number;
};
};
};
export default SiteLogo;