UNPKG

@massds/mayflower-react

Version:

React versions of Mayflower design system UI components

38 lines (37 loc) 1.49 kB
import { FooterLinksProps } from '../FooterLinks'; import { SocialLinksProps } from '../SocialLinks'; export interface FooterProps { /** `@molecules/FooterLinks` */ footerLinks: FooterLinksProps; /** Whether to display or visually hiding footer nav headings */ showNavHeading?: boolean; /** `@molecules/SocialLinks` */ socialLinks: SocialLinksProps; /** A floating button on the lower right corner which onClick takes user to the top of the page. */ backToTopButton?: boolean; /** Adds footer logo. (Defaults to matching Mass.gov) <br /> * `src:` logo image source url <br /> * `domain:` The URL for the site root <br /> * `title:` The title of the logo link */ footerLogo?: { src: string; domain?: string; title?: string; }; /** Adds footer info section. (Defaults to matching Mass.gov) <br /> * `copyright:` Bolded copyright info starting with © <br /> * `description:` Descriptive info below copyright <br /> * `privacyPolicy:` A link to the privacy policy page of the site */ footerText?: { copyright?: string; description?: string; privacyPolicy?: { text?: string; url?: string; }; }; } declare const Footer: ({ footerLinks, socialLinks, footerText: { copyright, description, privacyPolicy }, footerLogo: { domain, title, src }, showNavHeading, backToTopButton }: FooterProps) => any; export default Footer;