@carbon-labs/react-ui-shell

!npm version
!License

The @carbon-labs/react-ui-shell package extends UI Shell components from
@carbon/react, providing additional enhancements while maintaining
compatibility.

📦 Getting started

To install @carbon-labs/react-ui-shell in your project, you will need to run
the following command using npm:

``bash
npm install -S @carbon-labs/react-ui-shell @carbon/react
`

If you prefer Yarn, use the following command
instead:

`bash
yarn add @carbon-labs/react-ui-shell @carbon/react
`

⚡ Usage

To use this package you will need to import components from both @carbon/react
and @carbon-labs/react-ui-shell to compose the UI Shell. The following
components are provided by @carbon-labs/react-ui-shell:

- HeaderDivider
- HeaderPopover
- HeaderPopoverActions
- HeaderPopoverButton
- HeaderPopoverContent
- Profile
- SideNav
- SideNavItems
- SideNavLink
- SideNavMenu
- SideNavMenuItem
- SideNavSlot
- SideNavTitle
- TrialCountdown

`jsx
import { SideNav } from '@carbon-labs/react-ui-shell';
import { Header } from '@carbon/react';

function MyComponent() {
return (



...>



);
}
`

$3

Import the styles from @carbon/react and @carbon-labs/react-ui-shell in your
stylesheet:

`scss
@use '@carbon/react' with (
$font-path: '@ibm/plex'
);
@use '@carbon-labs/react-ui-shell/scss/ui-shell';
`

$3

You can explore the available components, see different configuration options,
and learn how to compose them in
Storybook.

🙌 Contributing

Want to contribute to @carbon-labs`? Read through the Carbon Labs
contribution section
before diving into our developer guide:

- Developer Guide

📖 Changelog

See the latest updates and version history in the
changelog.

📝 License

Licensed under the
Apache 2.0 License.

IBM Telemetry

This package uses IBM Telemetry to collect de-identified and anonymized metrics
data. By installing this package as a dependency you are agreeing to telemetry
collection. To opt out, see
Opting out of IBM Telemetry data collection.
For more information on the data being collected, please see the
IBM Telemetry documentation.