Skip to main content

NavigationToolbar

Interfaces

Extends

  • ToolbarProps

Properties

PropertyTypeDescription
ComposerIconButtonProps?ComposerIconButtonPropsProps to spread to the ComposerIconButton

Default
{}
NavigationMenuIconButtonComponent?(inProps: NavigationMenuIconButtonProps) => ElementComponent for Navigation Menu Icon Button
NavigationSettingsIconButtonComponent?(inProps: NavigationSettingsIconButtonProps) => ElementComponent for Navigation Settings
NotificationMenuProps?Omit<NotificationsMenuProps, "open" | "onClick" | "transformOrigin" | "onClose" | "anchorOrigin" | "anchorEl">Props to spread to the NotificationsMenu

Default
{}
SearchAutocompleteProps?SearchAutocompletePropsSearchbar props
disableComposer?booleanDisable composer action if possible
disableSearch?booleanDisable search action if possible
endActions?ReactNodeActions to be inserted after Private Messages IconButton
onCloseNotificationMenu?() => voidCallback on close notification menu
onOpenNotificationMenu?() => voidCallback on open notification menu
startActions?ReactNodeActions to be inserted before composer IconButton
valuestringThe navigation path

Functions

NavigationToolbar(inProps): Element

API documentation for the Community-JS NavigationToolbar component. Learn about the available props and the CSS API.

This component renders the application header. Take a look at our demo component here

Import

import {NavigationToolbar} from '@selfcommunity/react-ui';

Component Name

The name SCNavigationToolbar can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCNavigationToolbar-rootStyles applied to the root element.
logo.SCNavigationToolbar-logoStyles applied to the logo element.
register.SCNavigationToolbar-registerStyles applied to the register button elements.
navigation.SCNavigationToolbar-navigationStyles applied to the navigation container element
home.SCNavigationToolbar-homeStyles applied to the home button
explore.SCNavigationToolbar-exploreStyles applied to the explore button
search.SCNavigationToolbar-searchStyles applied to the search component
composer.SCNavigationToolbar-composerStyles applied to the composer component
profile.SCNavigationToolbar-profileStyles applied to the profile button
notification.SCNavigationToolbar-notificationStyles applied to the notification button
notificationsMenu.SCNavigationToolbar-notifications-menuStyles applied to the notifications menu
messages.SCNavigationToolbar-messagesStyles applied to the messages button
settings.SCNavigationToolbar-settingsStyles applied to the settings button
active.SCNavigationToolbar-activeStyles applied to the active button on navigation

Parameters

ParameterTypeDescription
inPropsNavigationToolbarProps

Returns

Element

Source

packages/react-ui/src/components/NavigationToolbar/NavigationToolbar.tsx:156


NavigationToolbarSkeleton(): JSX.Element

API documentation for the Community-JS Navigation Toolbar Skeleton component. Learn about the available props and the CSS API.

Import

import {MobileHeaderSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCNavigationToolbar-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCNavigationToolbar-skeleton-rootStyles applied to the root element.
logo.SCNavigationToolbar-logoStyles applied to the logo element.
navigation.SCNavigationToolbar-navigationStyles applied to the navigation element.
avatar.SCNavigationToolbar-avatarStyles applied to the avatar element.

Returns

JSX.Element

Source

packages/react-ui/src/components/NavigationToolbar/Skeleton.tsx:42