diff --git a/packages/components/src/index.ts b/packages/components/src/index.ts index a2836d7..2ff39a1 100644 --- a/packages/components/src/index.ts +++ b/packages/components/src/index.ts @@ -1,2 +1,3 @@ export * from './general'; export * from './list'; +export * from './navigation'; diff --git a/packages/components/src/navigation/index.ts b/packages/components/src/navigation/index.ts new file mode 100644 index 0000000..cbbba65 --- /dev/null +++ b/packages/components/src/navigation/index.ts @@ -0,0 +1 @@ +export * from './navigationBar.component'; diff --git a/packages/frontend/src/components/general/navigation/NavigationBar.tsx b/packages/components/src/navigation/navigationBar.component.tsx similarity index 62% rename from packages/frontend/src/components/general/navigation/NavigationBar.tsx rename to packages/components/src/navigation/navigationBar.component.tsx index 8f4552f..c7e7663 100644 --- a/packages/frontend/src/components/general/navigation/NavigationBar.tsx +++ b/packages/components/src/navigation/navigationBar.component.tsx @@ -1,20 +1,8 @@ import * as React from 'react'; -import { - AppBar, - Toolbar, - makeStyles, - fade, - IconButton, - Theme, - createStyles, - Typography, - Button, -} from '@material-ui/core'; +import { AppBar, Toolbar, makeStyles, IconButton, Theme, createStyles, Typography, Button } from '@material-ui/core'; import MenuIcon from '@material-ui/icons/Menu'; -import { RouteDrawer } from './RouteDrawer'; -import h from '../../../util/history'; -import { getLinkForPath } from 'util/routes'; -import { AppPath } from 'elite-types'; +import { RouteDrawer } from './routeDrawer.component'; +import { AppRoute } from 'elite-types'; const useStyles = makeStyles((theme: Theme) => createStyles({ @@ -31,13 +19,27 @@ const useStyles = makeStyles((theme: Theme) => ); export interface NavigationBarProps { - readonly title?: string; + /** Title displayed by in navigation bar */ + readonly title: string; + + /** Callback used by navigation bar to navigate to a route */ + readonly onNavigateTo: (route: AppRoute) => void; + + /** Routes that the user may navigate to */ + readonly routes: AppRoute[]; } +/** + * NavigationBar displays a material-ui AppBar in combination with a Drawer + * component which the User can use to navigate the available routes + * + * @param props See NavigationBarProps + */ export const NavigationBar = (props: NavigationBarProps) => { const classes = useStyles(); const [routeDrawerOpen, setRouteDrawerOpen] = React.useState(false); - const title = props.title || getLinkForPath(h.location.pathname as AppPath); + + const title = props.title; return ( <> @@ -62,6 +64,8 @@ export const NavigationBar = (props: NavigationBarProps) => { setRouteDrawerOpen(true)} onClose={() => setRouteDrawerOpen(false)} diff --git a/packages/frontend/src/components/general/navigation/RouteDrawer.tsx b/packages/components/src/navigation/routeDrawer.component.tsx similarity index 67% rename from packages/frontend/src/components/general/navigation/RouteDrawer.tsx rename to packages/components/src/navigation/routeDrawer.component.tsx index d8bdc0b..48a3caf 100644 --- a/packages/frontend/src/components/general/navigation/RouteDrawer.tsx +++ b/packages/components/src/navigation/routeDrawer.component.tsx @@ -2,20 +2,29 @@ import { createStyles, List, ListItem, + ListItemIcon, ListItemText, makeStyles, SwipeableDrawer, Theme, - ListItemIcon, } from '@material-ui/core'; +import { AppRoute, getDisplayNameForRoute, getLinkForRoute } from 'elite-types'; import * as React from 'react'; -import { Link } from 'react-router-dom'; -import { APP_ROUTES, getLinkForRoute, getDisplayNameForRoute } from '../../../util/routes'; -import h from '../../../util/history'; export interface RouteDrawerProps { + /** Routes displayed as options in the drawer list */ + readonly routes: AppRoute[]; + + /** Callback used by route drawer to navigate to a route */ + readonly onNavigateTo: (route: AppRoute) => void; + + /** Whether or not the drawer is open */ readonly isOpen: boolean; + + /** Callback used by the drawer to signify it should open */ readonly onOpen: () => void; + + /** Callback used by the drawer to signify it should close */ readonly onClose: () => void; } @@ -36,8 +45,8 @@ export const RouteDrawer = (props: RouteDrawerProps) => {
- {APP_ROUTES.map(route => ( - h.push(getLinkForRoute(route))}> + {props.routes.map(route => ( + props.onNavigateTo(route)}> {route.icon && {route.icon}} diff --git a/packages/frontend/src/app.tsx b/packages/frontend/src/app.tsx index 3c72b4c..70cd708 100644 --- a/packages/frontend/src/app.tsx +++ b/packages/frontend/src/app.tsx @@ -1,6 +1,6 @@ -import { ErrorBoundaryComponent, FeatureFlagsProvider } from 'elite-components'; +import { ErrorBoundaryComponent, FeatureFlagsProvider, NavigationBar } from 'elite-components'; import { getConfiguration } from 'elite-configuration'; -import { AppPath, Configuration } from 'elite-types'; +import { AppPath, Configuration, getDisplayNameForRoute, getLinkForRoute } from 'elite-types'; import * as React from 'react'; import { hot } from 'react-hot-loader'; import { Redirect, Route, Switch } from 'react-router'; @@ -17,7 +17,20 @@ export const AppComponent = () => ( {APP_ROUTES.map((route, index) => ( - + ( + <> + history.push(getLinkForRoute(r))} + /> + {route.render(props)} + + )} + /> ))} {/* Error 404 Fallback */} } /> diff --git a/packages/frontend/src/util/routes.tsx b/packages/frontend/src/util/routes.ts similarity index 58% rename from packages/frontend/src/util/routes.tsx rename to packages/frontend/src/util/routes.ts index 666485b..f5f5947 100644 --- a/packages/frontend/src/util/routes.tsx +++ b/packages/frontend/src/util/routes.ts @@ -1,20 +1,9 @@ -import * as React from 'react'; import { HOME_ROUTE } from 'elite-home'; import { LINK_ROUTE } from 'elite-link'; -import { AppPath, AppRoute, LinkType } from 'elite-types'; +import { AppPath, AppRoute, LinkType, getLinkForRoute, getDisplayNameForRoute } from 'elite-types'; export const APP_ROUTES: AppRoute[] = [HOME_ROUTE, LINK_ROUTE]; -/** - * Retrieves the url which other pages can use to link to a certain - * app path - * - * @param route - */ -export function getLinkForRoute(route: AppRoute): LinkType { - return route.link || route.path; -} - /** * Retrieves the url which other pages can use to link to a certain * app path @@ -28,16 +17,6 @@ export function getLinkForPath(path: AppPath): LinkType { return getLinkForRoute(route); } -/** - * Retrieves the human readable link title/displayed name for - * a given route - * - * @param route - */ -export function getDisplayNameForRoute(route: AppRoute): string { - return route.displayName || getLinkForRoute(route); -} - /** * Retrieves the human readable link title/displayed name for * a given path diff --git a/packages/home/src/home.page.tsx b/packages/home/src/home.page.tsx index 720698b..dffe5d5 100644 --- a/packages/home/src/home.page.tsx +++ b/packages/home/src/home.page.tsx @@ -1,7 +1,7 @@ import { FeatureFlag } from 'elite-components'; +import { AppPath, AppRoute } from 'elite-types'; import * as React from 'react'; import { RouteComponentProps } from 'react-router'; -import { AppPath, AppRoute } from 'elite-types'; export interface HomePageProps extends RouteComponentProps {} @@ -16,12 +16,8 @@ export const HOME_ROUTE: AppRoute = { export const HomePage = (props: HomePageProps) => { return ( - <> - {/* */} - - - Elite Sexyz is currently under construction. See discord main channel for more information - - + + Elite Sexyz is currently under construction. See discord main channel for more information + ); }; diff --git a/packages/link/src/link.page.tsx b/packages/link/src/link.page.tsx index a34bb63..21164c8 100644 --- a/packages/link/src/link.page.tsx +++ b/packages/link/src/link.page.tsx @@ -1,8 +1,8 @@ import { List } from '@material-ui/core'; -import * as React from 'react'; -import { RouteComponentProps } from 'react-router'; import { LinkListItem } from 'elite-components'; import { AppPath, AppRoute } from 'elite-types'; +import * as React from 'react'; +import { RouteComponentProps } from 'react-router'; export interface LinkPageProps extends RouteComponentProps {} @@ -12,19 +12,12 @@ export interface LinkPageProps extends RouteComponentProps {} export const LINK_ROUTE: AppRoute = { path: AppPath.LINK, displayName: 'Useful Links', - render: props => ( - <> - - - ), + render: props => , }; export const LinkPage = (props: LinkPageProps) => ( - <> - {/* */} - - - - - + + + + ); diff --git a/packages/types/src/routes/appRoute.type.ts b/packages/types/src/routes/appRoute.type.ts index 14b9a39..80dba3e 100644 --- a/packages/types/src/routes/appRoute.type.ts +++ b/packages/types/src/routes/appRoute.type.ts @@ -1,22 +1,31 @@ import { LinkType } from './link.type'; import { AppPath } from './appPath.type'; -import { RouteProps } from 'react-router'; +import { RouteProps, RouteComponentProps } from 'react-router'; /** * Each Approute can have a specific link (i.e., path with filled parameter placeholders), * a display Name, i.e., text of the link and a nonoptional (!) path */ export interface AppRoute extends RouteProps { - // Use this if the link target differs from the path specification, - // i.e., if the path url contains paramter specifications etc + /** + * Use this if the link target differs from the path specification, + * i.e., if the path url contains paramter specifications etc + */ readonly link?: LinkType; - // link text (Human readable!) + /** link text (Human readable!) */ readonly displayName?: string; - // optional icon displayed next to the link name + /** optional icon displayed next to the link name */ readonly icon?: JSX.Element; - // AppRoutes must have a path - deoptionalize this property + /** AppRoutes must have a path - deoptionalize this property */ readonly path: AppPath; + + /** render is required for AppRoutes */ + readonly render: (props: RouteComponentProps) => React.ReactNode; + + /** prevent usage of component/children props, i.e., AppRoutes must use render! */ + readonly component?: never; + readonly children?: never; } diff --git a/packages/types/src/routes/appRoute.util.ts b/packages/types/src/routes/appRoute.util.ts new file mode 100644 index 0000000..085f05d --- /dev/null +++ b/packages/types/src/routes/appRoute.util.ts @@ -0,0 +1,22 @@ +import { AppRoute } from './appRoute.type'; +import { LinkType } from './link.type'; + +/** + * Retrieves the url which other pages can use to link to a certain + * app path + * + * @param route + */ +export function getLinkForRoute(route: AppRoute): LinkType { + return route.link || route.path; +} + +/** + * Retrieves the human readable link title/displayed name for + * a given route + * + * @param route + */ +export function getDisplayNameForRoute(route: AppRoute): string { + return route.displayName || getLinkForRoute(route); +} diff --git a/packages/types/src/routes/index.ts b/packages/types/src/routes/index.ts index 91d063f..fe01775 100644 --- a/packages/types/src/routes/index.ts +++ b/packages/types/src/routes/index.ts @@ -1,3 +1,4 @@ export * from './appPath.type'; export * from './appRoute.type'; +export * from './appRoute.util'; export * from './link.type';