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

chore(DashboardWrapper + DashboardHeader) convert to TS #9618

Merged
merged 8 commits into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from 4 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
3 changes: 2 additions & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ module.exports = {
],
roots: ['<rootDir>/packages'],
transform: {
'^.+\\.[jt]sx?$': 'babel-jest'
'^.+\\.[jt]sx?$': 'babel-jest',
'^.+\\.svg$': 'jest-transform-stub'
},
setupFilesAfterEnv: ['<rootDir>/packages/testSetup.ts'],
transformIgnorePatterns: ['node_modules/(?!@patternfly|@novnc|@popperjs|lodash|monaco-editor|react-monaco-editor)'],
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"@typescript-eslint/eslint-plugin": "^5.59.2",
"@typescript-eslint/parser": "^5.59.2",
"babel-jest": "^27.2.5",
"jest-transform-stub": "^2.0.0",
"concurrently": "^7.6.0",
"eslint": "^8.39.0",
"eslint-plugin-markdown": "^3.0.0",
Expand Down
1 change: 1 addition & 0 deletions packages/react-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"rimraf": "^3.0.2",
"rollup": "^3.21.5",
"rollup-plugin-scss": "^4.0.0",
"rollup-plugin-svg": "2.0.0",
"rollup-plugin-terser": "^7.0.2",
"typescript": "^4.7.4"
},
Expand Down
186 changes: 186 additions & 0 deletions packages/react-core/src/components/DashboardHeader.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
import React, { useState } from 'react';
import { Avatar } from './Avatar';
import { Brand } from './Brand';
import { Button, ButtonVariant } from './Button';
import { Divider } from './Divider';
import { Dropdown, DropdownGroup, DropdownItem, DropdownList } from './Dropdown';
import { Masthead, MastheadToggle, MastheadMain, MastheadBrand, MastheadContent } from './Masthead';
import { MenuToggle } from './MenuToggle';
import { Toolbar, ToolbarContent, ToolbarGroup, ToolbarItem } from './Toolbar';
import { PageToggleButton } from './Page/PageToggleButton';
import BarsIcon from '@patternfly/react-icons/dist/esm/icons/bars-icon';
import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon';
import QuestionCircleIcon from '@patternfly/react-icons/dist/esm/icons/question-circle-icon';
import BellIcon from '@patternfly/react-icons/dist/esm/icons/bell-icon';
import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
import imgAvatar from '@patternfly/react-core/src/components/assets/avatarImg.svg';
import pfLogo from '@patternfly/react-core/src/demos/assets/pf-logo.svg';

interface DashboardHeaderProps {
notificationBadge?: React.ReactNode;
}

export const DashboardHeader: React.FC<DashboardHeaderProps> = ({ notificationBadge }) => {
const [isDropdownOpen, setIsDropdownOpen] = useState(false);
const [isKebabDropdownOpen, setIsKebabDropdownOpen] = useState(false);
const [isFullKebabDropdownOpen, setIsFullKebabDropdownOpen] = useState(false);

const kebabDropdownItems = (
<>
<DropdownItem>
<CogIcon /> Settings
</DropdownItem>
<DropdownItem>
<HelpIcon /> Help
</DropdownItem>
</>
);

const userDropdownItems = (
<>
<DropdownItem key="group 2 profile">My profile</DropdownItem>
<DropdownItem key="group 2 user">User management</DropdownItem>
<DropdownItem key="group 2 logout">Logout</DropdownItem>
</>
);

const onDropdownToggle = () => {
setIsDropdownOpen((prevIsDropdownOpen) => !prevIsDropdownOpen);
};

const onDropdownSelect = () => {
setIsDropdownOpen(false);
};

const onKebabDropdownToggle = () => {
setIsKebabDropdownOpen((prevIsKebabDropdownOpen) => !prevIsKebabDropdownOpen);
};

const onKebabDropdownSelect = () => {
setIsKebabDropdownOpen(false);
};

const onFullKebabToggle = () => {
setIsFullKebabDropdownOpen((prevIsFullKebabDropdownOpen) => !prevIsFullKebabDropdownOpen);
};

const onFullKebabSelect = () => {
setIsFullKebabDropdownOpen(false);
};

return (
<Masthead>
<MastheadToggle>
<PageToggleButton variant="plain" aria-label="Global navigation">
<BarsIcon />
</PageToggleButton>
</MastheadToggle>
<MastheadMain>
<MastheadBrand>
<Brand src={pfLogo} alt="PatternFly" heights={{ default: '36px' }} />
</MastheadBrand>
</MastheadMain>
<MastheadContent>
<Toolbar id="toolbar" isFullHeight isStatic>
<ToolbarContent>
<ToolbarGroup
variant="icon-button-group"
align={{ default: 'alignRight' }}
spacer={{ default: 'spacerNone', md: 'spacerMd' }}
>
{notificationBadge ? (
notificationBadge
) : (
<ToolbarItem>
<Button
aria-label="Notifications"
variant={ButtonVariant.plain}
icon={<BellIcon />}
onClick={() => {}}
/>
</ToolbarItem>
)}
<ToolbarGroup variant="icon-button-group" visibility={{ default: 'hidden', lg: 'visible' }}>
<ToolbarItem>
<Button aria-label="Settings" variant={ButtonVariant.plain} icon={<CogIcon />} />
</ToolbarItem>
<ToolbarItem>
<Button aria-label="Help" variant={ButtonVariant.plain} icon={<QuestionCircleIcon />} />
</ToolbarItem>
</ToolbarGroup>
<ToolbarItem visibility={{ default: 'hidden', md: 'visible', lg: 'hidden' }}>
<Dropdown
isOpen={isKebabDropdownOpen}
onSelect={onKebabDropdownSelect}
onOpenChange={setIsKebabDropdownOpen}
popperProps={{ position: 'right' }}
toggle={(toggleRef: React.RefObject<any>) => (
<MenuToggle
ref={toggleRef}
isExpanded={isKebabDropdownOpen}
onClick={onKebabDropdownToggle}
variant="plain"
aria-label="Settings and help"
>
<EllipsisVIcon aria-hidden="true" />
</MenuToggle>
)}
>
<DropdownList>{kebabDropdownItems}</DropdownList>
</Dropdown>
</ToolbarItem>
<ToolbarItem visibility={{ md: 'hidden' }}>
<Dropdown
isOpen={isFullKebabDropdownOpen}
onSelect={onFullKebabSelect}
onOpenChange={setIsFullKebabDropdownOpen}
popperProps={{ position: 'right' }}
toggle={(toggleRef: React.RefObject<any>) => (
<MenuToggle
ref={toggleRef}
isExpanded={isFullKebabDropdownOpen}
onClick={onFullKebabToggle}
variant="plain"
aria-label="Toolbar menu"
>
<EllipsisVIcon aria-hidden="true" />
</MenuToggle>
)}
>
<DropdownGroup key="group 2" aria-label="User actions">
<DropdownList>{userDropdownItems}</DropdownList>
</DropdownGroup>
<Divider />
<DropdownList>{kebabDropdownItems}</DropdownList>
</Dropdown>
</ToolbarItem>
</ToolbarGroup>
<ToolbarItem visibility={{ default: 'hidden', md: 'visible' }}>
<Dropdown
isOpen={isDropdownOpen}
onSelect={onDropdownSelect}
onOpenChange={setIsDropdownOpen}
popperProps={{ position: 'right' }}
toggle={(toggleRef: React.RefObject<any>) => (
<MenuToggle
ref={toggleRef}
isExpanded={isDropdownOpen}
onClick={onDropdownToggle}
icon={<Avatar src={imgAvatar} alt="" />}
isFullHeight
>
Ned Username
</MenuToggle>
)}
>
<DropdownList>{userDropdownItems}</DropdownList>
</Dropdown>
</ToolbarItem>
</ToolbarContent>
</Toolbar>
</MastheadContent>
</Masthead>
);
};
DashboardHeader.displayName = 'DashboardHeader';
118 changes: 118 additions & 0 deletions packages/react-core/src/components/DashboardWrapper.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import React, { useState } from 'react';
import { Breadcrumb, BreadcrumbItem } from './Breadcrumb';
import { Nav, NavItem, NavList } from './Nav';
import { Page, PageProps, PageSection, PageSidebar, PageSidebarBody } from './Page';
import { SkipToContent } from './SkipToContent';
import { Text, TextContent } from './Text';
import { DashboardHeader } from './DashboardHeader';

interface DashboardWrapperProps extends Omit<PageProps, 'ref'> {
/** Programmatically manage if the sidebar nav is shown */
sidebarNavOpen?: boolean;
/** Flag to render sample breadcrumb if custom breadcrumb not passed */
hasDefaultBreadcrumb?: boolean;
/** Flag to render sample page title if custom title not passed */
hasPageTemplateTitle?: boolean;
}

export const DashboardBreadcrumb = (
<Breadcrumb>
<BreadcrumbItem>Section home</BreadcrumbItem>
<BreadcrumbItem to="#">Section title</BreadcrumbItem>
<BreadcrumbItem to="#">Section title</BreadcrumbItem>
<BreadcrumbItem to="#" isActive>
Section landing
</BreadcrumbItem>
</Breadcrumb>
);

const PageTemplateTitle = (
<PageSection variant="light">
<TextContent>
<Text component="h1">Main title</Text>
<Text component="p">This is a full page demo.</Text>
</TextContent>
</PageSection>
);

export const DashboardWrapper: React.FC<DashboardWrapperProps> = ({
children,
mainContainerId,
breadcrumb,
header,
sidebar,
sidebarNavOpen,
onPageResize,
hasDefaultBreadcrumb,
notificationDrawer,
isNotificationDrawerExpanded,
hasPageTemplateTitle,
...pageProps
}: DashboardWrapperProps) => {
const [activeItem, setActiveItem] = useState(1);

const onNavSelect = (_event: React.FormEvent<HTMLInputElement>, result: any) => {
setActiveItem(result.itemId);
};

let renderedBreadcrumb;
if (!hasDefaultBreadcrumb) {
renderedBreadcrumb = breadcrumb ?? DashboardBreadcrumb;
}

const PageNav = (
<Nav onSelect={onNavSelect} aria-label="Nav">
<NavList>
<NavItem itemId={0} isActive={activeItem === 0} to="#system-panel">
System panel
</NavItem>
<NavItem itemId={1} isActive={activeItem === 1} to="#policy">
Policy
</NavItem>
<NavItem itemId={2} isActive={activeItem === 2} to="#auth">
Authentication
</NavItem>
<NavItem itemId={3} isActive={activeItem === 3} to="#network">
Network services
</NavItem>
<NavItem itemId={4} isActive={activeItem === 4} to="#server">
Server
</NavItem>
</NavList>
</Nav>
);

const _sidebar = (
<PageSidebar isSidebarOpen={sidebarNavOpen || false}>
<PageSidebarBody>{PageNav}</PageSidebarBody>
</PageSidebar>
);

const PageSkipToContent = (
<SkipToContent href={`#${mainContainerId ?? 'main-content-page-layout-default-nav'}`}>
Skip to content
</SkipToContent>
);

return (
<Page
header={header ?? <DashboardHeader />}
sidebar={sidebar ?? _sidebar}
isManagedSidebar
skipToContent={PageSkipToContent}
breadcrumb={renderedBreadcrumb}
mainContainerId={mainContainerId ?? 'main-content-page-layout-default-nav'}
notificationDrawer={notificationDrawer}
isNotificationDrawerExpanded={isNotificationDrawerExpanded}
{...(typeof onPageResize === 'function' && {
onPageResize: (event: MouseEvent | TouchEvent | React.KeyboardEvent<Element>, resizeObject: any) =>
onPageResize(event, resizeObject)
})}
{...pageProps}
>
{hasPageTemplateTitle && PageTemplateTitle}
{children}
</Page>
);
};
DashboardWrapper.displayName = 'DashboardWrapper';
2 changes: 2 additions & 0 deletions packages/react-core/src/components/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export * from './Checkbox';
export * from './Chip';
export * from './ClipboardCopy';
export * from './CodeBlock';
export * from './DashboardHeader';
export * from './DashboardWrapper';
export * from './DataList';
export * from './DatePicker';
export * from './DescriptionList';
Expand Down
2 changes: 0 additions & 2 deletions packages/react-core/src/demos/AlertGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ section: components
import { useEffect } from 'react';
import SearchIcon from '@patternfly/react-icons/dist/js/icons/search-icon';
import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
import DashboardWrapper from './examples/DashboardWrapper';
import DashboardHeader from './examples/DashboardHeader';

## Demos

Expand Down
2 changes: 0 additions & 2 deletions packages/react-core/src/demos/BackToTop.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ id: Back to top
section: components
---

import DashboardWrapper from '@patternfly/react-core/src/demos/examples/DashboardWrapper';

## Demos

### Using name selector
Expand Down
6 changes: 2 additions & 4 deletions packages/react-core/src/demos/Banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ id: Banner
section: components
---

import DashboardWrapper from '@patternfly/react-core/src/demos/examples/DashboardWrapper';

## Demos

### Basic sticky banner
Expand All @@ -15,6 +13,7 @@ import {
Banner,
Card,
CardBody,
DashboardWrapper,
Flex,
Gallery,
GalleryItem,
Expand All @@ -23,7 +22,6 @@ import {
TextContent,
Text
} from '@patternfly/react-core';
import DashboardWrapper from '@patternfly/react-core/src/demos/examples/DashboardWrapper';

class BannerDemo extends React.Component {
render() {
Expand Down Expand Up @@ -78,6 +76,7 @@ import {
Banner,
Card,
CardBody,
DashboardWrapper,
Flex,
FlexItem,
Gallery,
Expand All @@ -87,7 +86,6 @@ import {
TextContent,
Text
} from '@patternfly/react-core';
import DashboardWrapper from '@patternfly/react-core/src/demos/examples/DashboardWrapper';

class BannerDemo extends React.Component {
render() {
Expand Down
Loading
Loading