@engie-group/fluid-design-system-react
Version:
Fluid Design System React
100 lines (99 loc) • 2.12 kB
TypeScript
import React from 'react';
import { WithHTMLAttributes } from '../../utils/typeHelpers';
import { NJLinkProps } from '../link/NJLink';
export declare const NJFooter: React.ForwardRefExoticComponent<import("../../utils/typeHelpers").HTMLAttributesWithoutComponentProps<"footer", NJFooterOwnProps> & {
/**
* Logo img src
*/
logoPath?: string;
/**
* Logo alternative text
*/
logoAlt?: string;
/**
* Slogan text
*/
sloganText?: string;
/**
* Array of menus, see example below for usage
*/
menuLists?: Array<MenuLinks>;
/**
* Array of links displayed above social links
* `{
* url: string;
* logo:
* {
* path: string;
* alt?: string;
* }
* }`
*/
links?: Array<Links>;
/**
* Array of social links
* `{
* url: string;
* text: string;
* }`
*/
socialLinks?: Array<SocialLinks>;
} & {
children?: React.ReactNode | undefined;
} & React.RefAttributes<HTMLElement>>;
type MenuLinks = {
title: string;
items?: Array<Links>;
};
type SocialLinks = {
url: string;
logo: Img;
};
type Links = Omit<NJLinkProps, 'href' | 'children' | 'variant'> & {
url: string;
text: string;
};
type Img = {
path: string;
alt?: string;
};
type NJFooterOwnProps = React.PropsWithChildren<{
/**
* Logo img src
*/
logoPath?: string;
/**
* Logo alternative text
*/
logoAlt?: string;
/**
* Slogan text
*/
sloganText?: string;
/**
* Array of menus, see example below for usage
*/
menuLists?: Array<MenuLinks>;
/**
* Array of links displayed above social links
* `{
* url: string;
* logo:
* {
* path: string;
* alt?: string;
* }
* }`
*/
links?: Array<Links>;
/**
* Array of social links
* `{
* url: string;
* text: string;
* }`
*/
socialLinks?: Array<SocialLinks>;
}>;
export type NJFooterProps = WithHTMLAttributes<NJFooterOwnProps, 'footer'>;
export {};