JSPM

@rmwc/top-app-bar

4.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12019
  • Score
    100M100P100Q135778F
  • License MIT

RMWC TopAppBar component

Package Exports

  • @rmwc/top-app-bar
  • @rmwc/top-app-bar/README.md

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rmwc/top-app-bar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Top App Bar

Top App Bar acts as a container for items such as application title, navigation icon, and action items.

The TopAppBar cannot be effectively demoed inline, but it is in use above in the RMWC docs. To view additional functionality, check out the Material Components Top App Bar demo page.

import {
  TopAppBar,
  TopAppBarRow,
  TopAppBarSection,
  TopAppBarNavigationIcon,
  TopAppBarActionItem,
  TopAppBarTitle
} from '@rmwc/top-app-bar';

{/* Minimum usage. material-components-web will throw an error if you do not include TopAppBarNavigationIcon. */}
<TopAppBar>
  <TopAppBarRow>
    <TopAppBarSection>
      <TopAppBarNavigationIcon icon="menu" />
    </TopAppBarSection>
  </TopAppBarRow>
</TopAppBar>

{/* Fully Featured Example */}
<TopAppBar>
  <TopAppBarRow>
    <TopAppBarSection alignStart>
      <TopAppBarNavigationIcon icon="menu" />
      <TopAppBarTitle>Title</TopAppBarTitle>
    </TopAppBarSection>
    <TopAppBarSection alignEnd>
      <TopAppBarActionItem aria-label="Download" alt="Download">
        file_download
      </TopAppBarActionItem>
      <TopAppBarActionItem
        aria-label="Print this page"
        alt="Print this page"
      >
        print
      </TopAppBarActionItem>
      <TopAppBarActionItem
        aria-label="Bookmark this page"
        alt="Bookmark this page"
      >
        bookmark
      </TopAppBarActionItem>
    </TopAppBarSection>
  </TopAppBarRow>
</TopAppBar>

Simplified Usage

import { SimpleTopAppBar } from '@rmwc/top-app-bar';

<SimpleTopAppBar
  title="test"
  navigationIcon={{ onClick: () => console.log('Navigate') }}
  actionItems={[
    { onClick: () => console.log('Do Something'), use: 'file_download' },
    { onClick: () => console.log('Do Something'), use: 'print' },
    { onClick: () => console.log('Do Something'), use: 'bookmark' }
  ]}
/>
import { DocumentComponent } from '@rmwc/base/utils/document-component';
import * as docs from './docgen.json';
import * as iconDocs from '@rmwc/icon//docgen.json';

<DocumentComponent docs={docs} displayName="TopAppBar" />
<DocumentComponent docs={docs} displayName="TopAppBarRow" />
<DocumentComponent docs={docs} displayName="TopAppBarSection" />
<DocumentComponent docs={docs} displayName="TopAppBarTitle" />
<DocumentComponent docs={[docs, iconDocs]} displayName="TopAppBarNavigationIcon" composes={['Icon']} />
<DocumentComponent docs={[docs, iconDocs]} displayName="TopAppBarActionItem" composes={['Icon']} />
<DocumentComponent docs={docs} displayName="TopAppBarFixedAdjust" />
<DocumentComponent docs={docs} displayName="SimpleTopAppBar" />