BottomAppBar

Description

Bottom App Bar organize content across different screens, data sets, and other interactions. The Bottom App Bar contains the Bottom Tab Scroller and Tab components for the bottom.

See live demos on storybook

Storybook BottomAppBar Demos

Install bundle from npm-e

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

Optional: install the component individually

npm i @element-public/react-bottom-app-bar @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

Bottom App Bar is a navigation-bar component placed on the bottom of the page displayed normally on mobile devices. Could be used in RWD pages.

Bottom App Bar Props

| Name | Type | Default | Required | Description | | -------------- | ------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | activeTabIndex | number | 0 | false | Index of the currently active tab. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | elevated | boolean | false | false | Apply elevated styles to raise the tab-bar above standard content. | | variant | string | 'surface' | false | Background theme color. Accepts one of 'primary', 'secondary', or 'surface'.Accepted Values: primary, secondary, surface |

Bottom App Bar Deprecated Props

| Name | Type | Default | Required | Deprecated | Description | | ---------- | ------- | --------- | -------- | -------------------------------------------------- | ------------------------------------------- | | raised | boolean | undefined | false | Please use elevated instead. | Apply a raised style. | | scrollable | boolean | undefined | false | Deprecated, containers will scroll when necessary. | Create a fixed height scrollable container. |

Bottom App Bar Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ----------------------------------- | | children | React.ReactNode | null | false | Accepts one or more Tab components. |

Bottom App Bar Events

| Name | Default | Required | Params | Description | | -------------- | --------- | -------- | ------ | ---------------------------------------- | | onTabActivated | undefined | false | | Fires when switching to a different tab. |

Bottom App Indicator Props

| Name | Type | Default | Required | Description | | ------ | ------- | ------- | -------- | ---------------------------------------------------------------------- | | active | boolean | false | false | Visually activates the indicator. | | icon | string | null | false | The bottom-tab-indicator will use an underline if no icon is provided. |

Bottom App Scroller Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ----------------------------- | | children | React.ReactNode | null | false | Accepts BottomTab components. |

Bottom Tab Props

| Name | Type | Default | Required | Description | | ------------- | ------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | active | boolean | undefined | false | Indicates that the tab is active. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | indicatorIcon | string | null | false | An icon to be used as the tab indicator. Accepts the name of any valid material icon (see Icon component documentation for a list of valid icons). If no icon is provided the tab-indicator will use an underline. |

Bottom Tab Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | children | React.ReactNode | null | false | The displayed content. Expects a valid string, though will accept any valid components or markup. If label and children are both set, label will take priority. | | icon | React.ReactNode | undefined | false | Add a leading icon to the tab. | | label | React.ReactNode | null | false | The displayed text. Expects a valid string. If label and children are both set, label will take priority. |