@element-public/react-footer NPM

Footer

Description

The Footer provides a container in which navigation, copyrights, and help can be organized.

See live demos on storybook

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-footer @element-public/themes

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:

@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:

npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Notes

The Footer component is normally placed at the bottom of the page to display things such as lists, links, buttons and copyrights. The created component provides functionality to create custom lists, buttons with icons, and text for copyrights. Using the Footer is a good way to organize navigation, special links, icons, and contact information.

Footer Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
themeColor	string	'surface'	false	Color of the Footer.Accepted Values: transparent, surface, surface-variant, primary, primary-variant, primary-50, primary-100, primary-200, primary-300, primary-400, primary-500, primary-600, primary-700, primary-800, primary-900, secondary, secondary-variant, secondary-50, secondary-100, secondary-200, secondary-300, secondary-400, secondary-500, secondary-600, secondary-700, secondary-800, secondary-900, danger, danger-variant, danger-50, danger-100, danger-200, danger-300, danger-400, danger-500, danger-600, danger-700, danger-800, danger-900, ancillary-100, ancillary-200, ancillary-300, ancillary-400, ancillary-500, ancillary-600, ancillary-700, ancillary-800, ancillary-900
useContentMaxWidth	boolean	false	false	If true the footer's content will have a max width according to your theme's breakpoints.

Footer Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for Footer content

Footer Bottom Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
lgCols	string\|number	'3'	false	How many columns to create for the large breakpoint.
mdCols	string\|number	'1'	false	How many columns to create for the medium breakpoint.
smCols	string\|number	'1'	false	How many columns to create for the small breakpoint.
themeColor	string	'surface'	false	Color of the Footer Bottom.Accepted Values: transparent, surface, surface-variant, primary, primary-variant, primary-50, primary-100, primary-200, primary-300, primary-400, primary-500, primary-600, primary-700, primary-800, primary-900, secondary, secondary-variant, secondary-50, secondary-100, secondary-200, secondary-300, secondary-400, secondary-500, secondary-600, secondary-700, secondary-800, secondary-900, danger, danger-variant, danger-50, danger-100, danger-200, danger-300, danger-400, danger-500, danger-600, danger-700, danger-800, danger-900, ancillary-100, ancillary-200, ancillary-300, ancillary-400, ancillary-500, ancillary-600, ancillary-700, ancillary-800, ancillary-900

Footer Bottom Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for Footer content
copyrightContent	React.ReactNode	null	false	The center content of the FooterBottom component.
footerIcons	React.ReactNode	null	false	Expects one or more FooterIcons, will accept any valid components or markup.
links	React.ReactNode	null	false	A container for common links.

Footer Bottom Content Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.

Footer Bottom Content Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for FooterBottom content.

Footer Bottom Group Props

Name	Type	Default	Required	Description
alignment	string	undefined	false	Content alignment.Accepted Values: start, center, end
className	string	undefined	false	The css class name to be passed through to the component markup.
gap	string	'standard'	false	The spacing between items.Accepted Values: none, dense, standard, airy
lgColSpan	string\|number	'1'	false	How many columns to span the large breakpoint when customizing Footer Bottom columns.
margin	string	'standard'	false	The top and bottom spacing around the group component.Accepted Values: none, dense, standard, airy
mdColSpan	string\|number	'1'	false	How many columns to span the medium breakpoint when customizing Footer Bottom columns.
smColSpan	string\|number	'1'	false	How many columns to span the small breakpoint when customizing Footer Bottom columns.
style	object	null	false	Passthrough style object.

Footer Bottom Group Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for FooterBottom content.

Footer Bottom Wrapper Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
themeColor	string	'surface'	false	Color of the Footer Bottom.Accepted Values: transparent, surface, surface-variant, primary, primary-variant, primary-50, primary-100, primary-200, primary-300, primary-400, primary-500, primary-600, primary-700, primary-800, primary-900, secondary, secondary-variant, secondary-50, secondary-100, secondary-200, secondary-300, secondary-400, secondary-500, secondary-600, secondary-700, secondary-800, secondary-900, danger, danger-variant, danger-50, danger-100, danger-200, danger-300, danger-400, danger-500, danger-600, danger-700, danger-800, danger-900, ancillary-100, ancillary-200, ancillary-300, ancillary-400, ancillary-500, ancillary-600, ancillary-700, ancillary-800, ancillary-900

Footer Bottom Wrapper Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	Content to be rendered inside the Footer Bottom. Accepts any valid markup.

Footer Col Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
lgColSpan	string\|number	'1'	false	How many columns to span the large breakpoint when customizing Footer Bottom columns.
mdColSpan	string\|number	'1'	false	How many columns to span the medium breakpoint when customizing Footer Bottom columns.
smColSpan	string\|number	'1'	false	How many columns to span the small breakpoint when customizing Footer Bottom columns.
tag	string\|React.ElementType	'div'	false	By default a div will be rendered, this allow another tag to be used instead. A block type component is suggested.
title	string	undefined	false	The header title of the content in footer.

Footer Col Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for FooterCol content

Footer Content Props

Name	Type	Default	Required	Description
gap	string	'64px'	false	Gap between the columns and the pixels. Must be a valid css gap declaration for css display grid
lgCols	string\|number	undefined	false	How many columns to create for the large breakpoint.
mdCols	string\|number	undefined	false	How many columns to create for the medium breakpoint.
smCols	string\|number	'1'	false	How many columns to create for the small breakpoint.
themeColor	string	null	false	Color of the Footer.Accepted Values: transparent, surface, surface-variant, primary, primary-variant, primary-50, primary-100, primary-200, primary-300, primary-400, primary-500, primary-600, primary-700, primary-800, primary-900, secondary, secondary-variant, secondary-50, secondary-100, secondary-200, secondary-300, secondary-400, secondary-500, secondary-600, secondary-700, secondary-800, secondary-900, danger, danger-variant, danger-50, danger-100, danger-200, danger-300, danger-400, danger-500, danger-600, danger-700, danger-800, danger-900, ancillary-100, ancillary-200, ancillary-300, ancillary-400, ancillary-500, ancillary-600, ancillary-700, ancillary-800, ancillary-900

Footer Content Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for Footer content

Footer Divider Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.

Footer Icon Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
icon	string\|React.ReactNode	null	false	For simple use-cases, this will automatically create the icon object.
themeColor	string	'gray'	false	Color variations. Variants prefixed with `filled-` will add a background color to the icon according to the theme. Variants prefixed with `color-` will change the color of the icon according to the theme.Accepted Values: filled-danger-alt, filled-danger, filled-muted, filled-primary, filled-secondary, color-primary, color-secondary, color-on-dark, blue, gray, green, orange, purple, red, teal, yellow

Footer List Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
lgColSpan	string\|number	'1'	false	How many columns to span the large breakpoint when customizing Footer Bottom columns.
mdColSpan	string\|number	'1'	false	How many columns to span the medium breakpoint when customizing Footer Bottom columns.
smColSpan	string\|number	'1'	false	How many columns to span the small breakpoint when customizing Footer Bottom columns.
title	string	undefined	false	The header title of the content in footer.

Footer List Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for FooterList content

Footer List Item Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.

Footer List Item Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	The default container for FooterBottom content.

Footer Logo Props

Name	Type	Default	Required	Description
className	string	undefined	false	The css class name to be passed through to the component markup.
logo	string\|React.ReactNode	null	false	Optional logo. Expects an image but accepts any valid markup.

clsx prop-types @material/ripple @material/icon-button @babel/runtime-corejs3 @element-public/react-icon @element-public/react-common @element-public/react-ripple @element-public/react-typography @element-public/react-icon-button

@element-public/react-components

1.0.0

7 months ago