expand menu if SubNavigation is opened, even if it is inside an ExtensionPoint

This commit is contained in:
Sebastian Sdorra
2020-03-30 15:04:00 +02:00
parent 23f4c3cba9
commit daa272b4fc
4 changed files with 144 additions and 38 deletions

View File

@@ -0,0 +1,103 @@
/*
* MIT License
*
* Copyright (c) 2020-present Cloudogu GmbH and Contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import { storiesOf } from "@storybook/react";
import React, { ReactElement } from "react";
import SecondaryNavigation from "./SecondaryNavigation";
import SecondaryNavigationItem from "./SecondaryNavigationItem";
import styled from "styled-components";
import SubNavigation from "./SubNavigation";
import { Binder, ExtensionPoint, BinderContext } from "@scm-manager/ui-extensions";
import { MemoryRouter } from "react-router-dom";
const Columns = styled.div`
margin: 2rem;
`;
const starships = (
<SubNavigation to="/hitchhiker/starships" label="Starships">
<SecondaryNavigationItem
to="/hitchhiker/starships/heart-of-gold"
icon="fas fa-star"
label="Heart Of Gold"
title="Heart Of Gold"
/>
<SecondaryNavigationItem to="/hitchhiker/starships/titanic" label="Titanic" title="Starship Titanic" />
</SubNavigation>
);
const withRoute = (route: string) => {
return (story: ReactElement<any>) => <MemoryRouter initialEntries={[route]}>{story}</MemoryRouter>;
};
storiesOf("Navigation|Secondary", module)
.addDecorator(story => (
<Columns className="columns">
<div className="column is-3">{story()}</div>
</Columns>
))
.add("Default", () =>
withRoute("/")(
<SecondaryNavigation label="Hitchhiker" collapsed={false} onCollapse={() => {}}>
<SecondaryNavigationItem to="/" icon="fas fa-puzzle-piece" label="Puzzle 42" title="Puzzle 42" />
<SecondaryNavigationItem to="/some" icon="fas fa-star" label="Heart Of Gold" title="Heart Of Gold" />
</SecondaryNavigation>
)
)
.add("Collapsed", () =>
withRoute("/")(
<SecondaryNavigation label="Hitchhiker" collapsed={true} onCollapse={() => {}}>
<SecondaryNavigationItem to="/" icon="fas fa-puzzle-piece" label="Puzzle 42" title="Puzzle 42" />
<SecondaryNavigationItem to="/some" icon="fas fa-star" label="Heart Of Gold" title="Heart Of Gold" />
</SecondaryNavigation>
)
)
.add("Sub Navigation", () =>
withRoute("/")(
<SecondaryNavigation label="Hitchhiker" collapsed={false} onCollapse={() => {}}>
<SecondaryNavigationItem to="/42" icon="fas fa-puzzle-piece" label="Puzzle 42" title="Puzzle 42" />
{starships}
</SecondaryNavigation>
)
)
.add("Sub Navigation Collapsed", () =>
withRoute("/hitchhiker/starships/heart-of-gold")(
<SecondaryNavigation label="Hitchhiker" collapsed={true} onCollapse={() => {}}>
<SecondaryNavigationItem to="/42" icon="fas fa-puzzle-piece" label="Puzzle 42" title="Puzzle 42" />
{starships}
</SecondaryNavigation>
)
)
.add("Collapsed EP Sub", () => {
const binder = new Binder("menu");
binder.bind("subnav.sample", starships);
return withRoute("/hitchhiker/starships/titanic")(
<BinderContext.Provider value={binder}>
<SecondaryNavigation label="Hitchhiker" collapsed={true} onCollapse={() => {}}>
<SecondaryNavigationItem to="/42" icon="fas fa-puzzle-piece" label="Puzzle 42" title="Puzzle 42" />
<ExtensionPoint name="subnav.sample" renderAll={true} />
</SecondaryNavigation>
</BinderContext.Provider>
);
});

View File

@@ -26,6 +26,7 @@ import styled from "styled-components";
import SubNavigation from "./SubNavigation";
import { matchPath, useLocation } from "react-router-dom";
import { isMenuCollapsed, MenuContext } from "./MenuContext";
import { ExtensionPoint, Binder, useBinder } from "@scm-manager/ui-extensions";
type Props = {
label: string;
@@ -62,9 +63,10 @@ const MenuLabel = styled.p<CollapsedProps>`
const SecondaryNavigation: FC<Props> = ({ label, children, collapsed, onCollapse }) => {
const location = useLocation();
const binder = useBinder();
const menuContext = useContext(MenuContext);
const subNavActive = isSubNavigationActive(children, location.pathname);
const subNavActive = isSubNavigationActive(binder, children, location.pathname);
const isCollapsed = collapsed && !subNavActive;
useEffect(() => {
@@ -74,7 +76,16 @@ const SecondaryNavigation: FC<Props> = ({ label, children, collapsed, onCollapse
}, [subNavActive]);
const childrenWithProps = React.Children.map(children, (child: ReactElement) =>
React.cloneElement(child, { collapsed: isCollapsed })
React.cloneElement(child, {
collapsed: isCollapsed,
propTransformer: (props: object) => {
const np = {
...props,
collapsed: isCollapsed
};
return np;
}
})
);
const arrowIcon = isCollapsed ? <i className="fas fa-caret-down" /> : <i className="fas fa-caret-right" />;
@@ -105,16 +116,22 @@ const createParentPath = (to: string) => {
return parents.join("/");
};
const isSubNavigationActive = (children: ReactNode, url: string): boolean => {
const isSubNavigationActive = (binder: Binder, children: ReactNode, url: string): boolean => {
const childArray = React.Children.toArray(children);
const match = childArray
.filter(child => {
// what about extension points?
.filter(React.isValidElement)
.flatMap(child => {
// @ts-ignore
if (child.type.name === ExtensionPoint.name) {
// @ts-ignore
return binder.getExtensions(child.props.name, child.props.props);
}
return [child];
})
.filter(child => {
return child.type.name === SubNavigation.name;
})
.map(child => {
// @ts-ignore
return child.props;
})
.find(props => {

View File

@@ -21,48 +21,28 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import React, { ReactElement, ReactNode } from "react";
import React, { FC, ReactElement, ReactNode } from "react";
import { MenuContext } from "./MenuContext";
import SubNavigation from "./SubNavigation";
import NavLink from "./NavLink";
type Props = {
to: string;
icon: string;
icon?: string;
label: string;
title: string;
collapsed?: boolean;
activeWhenMatch?: (route: any) => boolean;
activeOnlyWhenExact?: boolean;
children?: ReactElement[];
};
export default class SecondaryNavigationItem extends React.Component<Props> {
render() {
const { to, icon, label, title, activeWhenMatch, activeOnlyWhenExact, children } = this.props;
if (children) {
return (
<MenuContext.Consumer>
{({ menuCollapsed }) => (
<SubNavigation
to={to}
icon={icon}
label={label}
title={title}
activeWhenMatch={activeWhenMatch}
activeOnlyWhenExact={activeOnlyWhenExact}
collapsed={menuCollapsed}
>
{children}
</SubNavigation>
)}
</MenuContext.Consumer>
);
} else {
return (
<MenuContext.Consumer>
{({ menuCollapsed }) => <NavLink to={to} icon={icon} label={label} title={title} collapsed={menuCollapsed} />}
</MenuContext.Consumer>
);
}
const SecondaryNavigationItem: FC<Props> = ({ children, ...props }) => {
if (children) {
return <SubNavigation {...props}>{children}</SubNavigation>;
} else {
return <NavLink {...props} />;
}
}
};
export default SecondaryNavigationItem;

View File

@@ -1,3 +1,9 @@
{
"extends": "@scm-manager/tsconfig"
"extends": "@scm-manager/tsconfig",
"compilerOptions": {
"lib": [
"es2019",
"dom"
]
}
}