Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ui-shell): add side-nav-divider component #7756

Merged
merged 4 commits into from
Feb 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/components/src/components/ui-shell/_side-nav.scss
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,15 @@
height: mini-units(6);
}

//----------------------------------------------------------------------------
// Side-nav > Navigation > Divider
//----------------------------------------------------------------------------
.#{$prefix}--side-nav__divider {
height: 1px;
margin: $spacing-03 $spacing-05;
background-color: $ibm-color__gray-20;
}

//----------------------------------------------------------------------------
// Side-nav > Navigation > {Menu,Submenu}
//----------------------------------------------------------------------------
Expand Down
7 changes: 7 additions & 0 deletions packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -7023,6 +7023,13 @@ Map {
},
},
},
"SideNavDivider" => Object {
"propTypes": Object {
"className": Object {
"type": "string",
},
},
},
"SideNavFooter" => Object {
"defaultProps": Object {
"assistiveText": "Toggle opening or closing the side navigation",
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/__tests__/index-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ describe('Carbon Components React', () => {
"SelectableTile",
"SideNav",
"SideNavDetails",
"SideNavDivider",
"SideNavFooter",
"SideNavHeader",
"SideNavIcon",
Expand Down
27 changes: 27 additions & 0 deletions packages/react/src/components/UIShell/SideNavDivider.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/**
* Copyright IBM Corp. 2021
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/

import { settings } from 'carbon-components';
import cx from 'classnames';
import PropTypes from 'prop-types';
import React from 'react';

const { prefix } = settings;

function SideNavDivider({ className }) {
const classNames = cx(`${prefix}--side-nav__divider`, className);
return <li role="separator" className={classNames} />;
}

SideNavDivider.propTypes = {
/**
* Provide an optional class to be applied to the containing node
*/
className: PropTypes.string,
};

export default SideNavDivider;
54 changes: 54 additions & 0 deletions packages/react/src/components/UIShell/UIShell-story.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import {
// SideNavHeader,
// SideNavDetails,
// SideNavSwitcher,
SideNavDivider,
SideNavItems,
SideNavLink,
SideNavMenu,
Expand Down Expand Up @@ -151,6 +152,7 @@ export default {
SkipToContent,
SideNav,
SideNavItems,
SideNavDivider,
SideNavLink,
SideNavMenu,
SideNavMenuItem,
Expand Down Expand Up @@ -683,6 +685,58 @@ export const FixedSideNavWIcons = withReadme(readme, () => (

FixedSideNavWIcons.storyName = 'Fixed SideNav w/ Icons';

export const FixedSideNavWDivider = withReadme(readme, () => (
<>
<SideNav
isFixedNav
expanded={true}
isChildOfHeader={false}
aria-label="Side navigation">
<SideNavItems>
<SideNavMenu title="L0 menu">
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
</SideNavMenu>
<SideNavMenu title="L0 menu" isActive={true}>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem aria-current="page" href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
</SideNavMenu>
<SideNavMenu title="L0 menu">
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
<SideNavMenuItem href="javascript:void(0)">
L0 menu item
</SideNavMenuItem>
</SideNavMenu>
<SideNavDivider />
<SideNavLink href="javascript:void(0)">L0 link</SideNavLink>
<SideNavLink href="javascript:void(0)">L0 link</SideNavLink>
</SideNavItems>
</SideNav>
<StoryContent useResponsiveOffset={false} />
</>
));

FixedSideNavWDivider.storyName = 'Fixed SideNav w/ Divider';

export const SideNavRail = withReadme(readme, () => (
<>
<SideNav aria-label="Side navigation" isRail>
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/components/UIShell/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export SkipToContent from './SkipToContent';

export SideNav from './SideNav';
export SideNavDetails from './SideNavDetails';
export SideNavDivider from './SideNavDivider';
export SideNavFooter from './SideNavFooter';
export SideNavHeader from './SideNavHeader';
export SideNavIcon from './SideNavIcon';
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ export {
SkipToContent,
SideNav,
SideNavDetails,
SideNavDivider,
SideNavFooter,
SideNavHeader,
SideNavIcon,
Expand Down