@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
76 lines (68 loc) • 2.91 kB
TypeScript
import { ToolbarProps } from '@mui/material';
import React from 'react';
import { SearchAutocompleteProps } from '../SearchAutocomplete';
import { NavigationSettingsIconButtonProps } from '../NavigationSettingsIconButton';
import { NavigationMenuIconButtonProps } from '../NavigationMenuIconButton';
import { ComposerIconButtonProps } from '../ComposerIconButton';
export interface NavigationToolbarMobileProps extends ToolbarProps {
/**
* Disable search action if possible
*/
disableSearch?: boolean;
/**
* Preserve the same as the desktop version
*/
preserveDesktopLogo?: boolean;
/**
* Props spread to SearchAutocomplete component
*/
SearchAutocompleteComponentProps?: SearchAutocompleteProps;
/**
* Actions to be inserted before composer IconButton
*/
startActions?: React.ReactNode | null;
/**
* Actions to be inserted after Private Messages IconButton
*/
endActions?: React.ReactNode | null;
/**
* Component for Navigation Menu Icon Button
*/
NavigationMenuIconButtonComponent?: (inProps: NavigationMenuIconButtonProps) => JSX.Element;
/**
* Component for Navigation Settings
*/
NavigationSettingsIconButtonComponent?: (inProps: NavigationSettingsIconButtonProps) => JSX.Element;
/**
* Props to spread to the ComposerIconButton
* @default {}
*/
ComposerIconButtonProps?: ComposerIconButtonProps;
}
/**
* > API documentation for the Community-JS Navigation Toolbar Mobile component. Learn about the available props and the CSS API.
*
*
* This component renders the mobile application header.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/NavigationToolbarMobile)
#### Import
```jsx
import {NavigationToolbarMobile} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCNavigationToolbarMobile` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCNavigationToolbarMobile-root|Styles applied to the root element.|
|logo|.SCNavigationToolbarMobile-logo|Styles applied to the logo element.|
|search|.SCNavigationToolbarMobile-search|Styles applied to the search button element|
|searchDialog|.SCNavigationToolbarMobile-search-dialog|Styles applied to the search dialog element|
|notifications|.SCNavigationToolbarMobile-notifications|Styles applied to the notifications button element|
|settings|.SCNavigationToolbarMobile-settings|Styles applied to the settings button element|
|settingsDialog|.SCNavigationToolbarMobile-settingsDialog|Styles applied to the settings dialog elements|
|login|.SCNavigationToolbarMobile-login|Styles applied to the login element.|
*
* @param inProps
*/
export default function NavigationToolbarMobile(inProps: NavigationToolbarMobileProps): JSX.Element;