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

docs(Portal): add View Transition #2675

Merged
merged 2 commits into from
Sep 30, 2023
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ completions.json
.history
*not_in_use*
/packages/dnb-ui-lib
**/test-results

# pkm
npm-debug.log*
Expand Down
13 changes: 6 additions & 7 deletions packages/dnb-design-system-portal/src/e2e/fullscreen.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ test.describe('Fullscreen', () => {
}) => {
await page.waitForSelector('nav#portal-sidebar-menu')

await page.click('button[title="Fullscreen"]')
await page.click('a.fullscreen')

await page.waitForSelector('nav#portal-sidebar-menu', {
state: 'hidden',
})

const currentURL = page.url()
expect(currentURL).toContain(
expect(page.url()).toContain(
'/uilib/components/button/demos/?fullscreen',
)

await page.click('a.fullscreen')

expect(page.url()).toContain('/uilib/components/button/demos/')
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ test.describe('Responsiveness', () => {

test('change viewport size should add sidebar menu', async ({
page,
baseURL,
}) => {
await expect(page.locator('nav#portal-sidebar-menu')).toHaveCSS(
'display',
Expand All @@ -35,7 +34,7 @@ test.describe('Responsiveness', () => {
state: 'attached',
})

expect(page.url()).toBe(`${baseURL}/uilib/about-the-lib/`)
expect(page.url()).toContain('/uilib/about-the-lib/')
await expect(page.locator('h1')).toContainText('#About the library')
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
portalHeaderWrapperStyle,
hideSidebarToggleButtonStyle,
} from './StickyMenuBar.module.scss'
import { Link } from '../tags/Anchor'

export default function StickyMenuBar({
hideSidebarToggleButton,
Expand Down Expand Up @@ -66,6 +67,7 @@ export default function StickyMenuBar({
text="Home"
title="Eufemia main sections"
href="/"
element={Link}
icon="chevron_left"
icon_position="left"
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,9 @@ html[show-dev-grid] .dev-grid {
.lh-32 {
line-height: calc(var(--line-height-basis) + 0.5rem); /* 2rem */
}

// Make the home => pages animation
.home-background ul,
#portal-sidebar-menu {
view-transition-name: home;
}
11 changes: 10 additions & 1 deletion packages/dnb-design-system-portal/src/shared/tags/Anchor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
} from '@dnb/eufemia/src/components/Anchor'
import { GatsbyLinkProps, Link as GatsbyLink } from 'gatsby'
import { ElementIsType } from '@dnb/eufemia/src/elements/Element'
import { startPageTransition } from './Transition'

export type AnchorProps = Props &
Omit<
Expand All @@ -22,16 +23,24 @@ export type AnchorProps = Props &
>

const PortalLink = React.forwardRef(function Link<TState>(
{ href, ...props }: AnchorProps,
{ href, onClick = null, ...props }: AnchorProps,
ref,
) {
return (
<GatsbyLink
to={href}
ref={ref}
{...(props as Omit<GatsbyLinkProps<TState>, 'ref' | 'onClick'>)}
onClick={clickHandler}
/>
)

function clickHandler(event: React.MouseEvent<HTMLAnchorElement>) {
startPageTransition()
if (onClick) {
onClick(event)
}
}
})

export { PortalLink as Link }
Expand Down
11 changes: 7 additions & 4 deletions packages/dnb-design-system-portal/src/shared/tags/Intro.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ import React from 'react'
import { Global, css } from '@emotion/react'
import PropTypes from 'prop-types'
import { navigate } from 'gatsby'
import { Link, Button, Space } from '@dnb/eufemia/src'
import { Anchor, Button, Space } from '@dnb/eufemia/src'
import { wrapperStyle, innerStyle, footerStyle } from './Intro.module.scss'
import { startPageTransition } from './Transition'
import { Link } from './Anchor'

const ref = React.createRef<HTMLDivElement>()
const Intro = ({ children }) => {
Expand All @@ -17,6 +19,7 @@ const Intro = ({ children }) => {
if (/textarea|input/i.test(document.activeElement.tagName)) {
return
}
startPageTransition()
try {
if (e.key === 'ArrowRight' && ref && ref.current) {
const elem = ref.current.querySelector('a[href*="/intro"]')
Expand Down Expand Up @@ -61,13 +64,14 @@ export const IntroFooter = ({ href, text }) => (
}
`}
/>
<Button href={href} text={text} icon="chevron_right" />
<Button href={href} text={text} icon="chevron_right" element={Link} />
<Button
href="/uilib/getting-started"
variant="secondary"
text="Cancel"
icon="close"
icon_position="left"
element={Link}
/>
</Space>
)
Expand All @@ -79,9 +83,8 @@ IntroFooter.defaultProps = {}

export const Next = (props) => (
<>
{/* <Hr /> */}
<div className="dnb-section dnb-section--spacing">
<Link {...props} />
<Anchor {...props} />
</div>
</>
)
Expand Down
42 changes: 19 additions & 23 deletions packages/dnb-design-system-portal/src/shared/tags/Tabbar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
*/

import React from 'react'
import { navigate } from 'gatsby'
import { Button, Tabs } from '@dnb/eufemia/src/components'
import { fullscreen as fullscreenIcon } from '@dnb/eufemia/src/icons'
import AutoLinkHeader from './AutoLinkHeader'
Expand Down Expand Up @@ -42,33 +41,29 @@ export default function Tabbar({
/fullscreen/.test(location.search),
)

const cleanFullscreen = (s) =>
s.replace(/\?fullscreen$|&fullscreen|fullscreen|\?$/, '')

const openFullscreen = () => {
setFullscreen(true)

const path = [
location.pathname,
location.search ? location.search + '&' : '?',
'fullscreen',
location.hash,
].join('')

navigate(path)
}

const cleanFullscreen = (s) =>
s.replace(/\?fullscreen$|&fullscreen|fullscreen|\?$/, '')

const quitFullscreen = () => {
setFullscreen(false)
}

const path = [
location.pathname,
cleanFullscreen(location.search),
location.hash,
].join('')
const fullscreenPath = [
location.pathname,
location.search ? location.search + '&' : '?',
'fullscreen',
location.hash,
].join('')

navigate(path)
}
const quitFullscreenPath = [
location.pathname,
cleanFullscreen(location.search),
location.hash,
].join('')

const preparedTabs = React.useMemo(() => {
return (
Expand Down Expand Up @@ -118,9 +113,6 @@ export default function Tabbar({
tab_element={Link}
data={preparedTabs}
selected_key={selectedKey}
on_change={({ selected_key }) => {
navigate(selected_key)
}}
render={({ Wrapper, Content, TabsList, Tabs }) => {
return (
<Wrapper className={tabsWrapperStyle}>
Expand All @@ -129,6 +121,8 @@ export default function Tabbar({
{wasFullscreen ? (
<Button
on_click={quitFullscreen}
href={quitFullscreenPath}
element={Link}
variant="secondary"
title="Quit Fullscreen"
icon="close"
Expand All @@ -137,6 +131,8 @@ export default function Tabbar({
) : (
<Button
on_click={openFullscreen}
href={fullscreenPath}
element={Link}
variant="secondary"
title="Fullscreen"
icon={fullscreenIcon}
Expand Down
14 changes: 14 additions & 0 deletions packages/dnb-design-system-portal/src/shared/tags/Transition.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
declare global {
interface Document {
startViewTransition(): void
}
}

export function startPageTransition() {
if (
!globalThis.IS_TEST &&
typeof document.startViewTransition !== 'undefined'
) {
document.startViewTransition()
}
}