npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@element-public/react-side-app-bar

v1.1.5

Published

Side App Bar component for Element React

Downloads

376

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

arkadiusz.slowikowskiarkadiusz.slowikowskipeon125peon125slowikowskiarkadiuszslowikowskiarkadiusz

Keywords

Readme

SideAppBar

Description

Component used for navigation, assigned to the left side of the page. Includes Navigation for the Tabs and Drawer for the Content.

See live demos on storybook

Storybook SideAppBar 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-side-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

Side App Bar has been implemented to create left-side navigation on a page.

The Side App Bar is composed of 4 subcomponents:

  • SideAppBar
    • The root component within which all related components will be placed
  • SideAppBarNavigation
    • This root area to display each tab of the SideAppBar component
  • SideAppBarTab
    • Each tab, which could be clicked to display different content
  • SideAppBarDrawer
    • The content to be displayed or hidden

Side App Bar Props

| Name | Type | Default | Required | Description | | --------- | ------ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | className | string | undefined | false | The css class name to be passed through to the component markup. | | variant | string | 'surface' | false | Background theme color. Accepts one of 'primary', 'secondary', or 'surface'.Accepted Values: primary, secondary, surface |

Side App Bar Render Props

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

Side App Bar Drawer Props

| Name | Type | Default | Required | Description | | --------- | ------- | --------- | -------- | ------------------------------------------------------------------ | | 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. |

Side App Bar Drawer Render Props

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

Side App Bar Indicator Props

| Name | Type | Default | Required | Description | | --------- | ------- | --------- | -------- | ---------------------------------------------------------------------------- | | active | boolean | false | false | Visually activates the indicator. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | icon | string | null | false | The side-app-bar-tab-indicator will use an underline if no icon is provided. | | id | string | undefined | false | Randomly generated id. May be overwritten. |

Side App Bar List Props

| Name | Type | Default | Required | Description | | --------- | ------ | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | className | string | undefined | false | The css class name to be passed through to the component markup. | | variant | string | 'surface' | false | Background theme color. Accepts one of 'primary', 'secondary', or 'surface'.Accepted Values: primary, secondary, surface |

Side App Bar List Render Props

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

Side App Bar List Item Props

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

Side App Bar List Item Render Props

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

Side App Bar Navigation Props

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

Side App Bar Navigation Render Props

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

Side App Bar 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. | | id | string | undefined | false | Randomly generated id. May be overwritten. | | 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. |

Side App Bar 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. |

Side App Bar Tab Events

| Name | Default | Required | Params | Description | | ------- | --------- | -------- | ------ | ------------------- | | onClick | undefined | false | | Click event handler |