forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor display-platform-specific-content (#22665)
* refactor display-platform-specific-content * update PlatformPicker tests and cleanup
- Loading branch information
1 parent
12f5437
commit 7310fc9
Showing
8 changed files
with
216 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| import { useEffect, useState } from 'react' | ||
| import Cookies from 'js-cookie' | ||
| import { SubNav, TabNav, UnderlineNav } from '@primer/components' | ||
| import { sendEvent, EventType } from 'components/lib/events' | ||
|
|
||
| import { useArticleContext } from 'components/context/ArticleContext' | ||
| import parseUserAgent from 'components/lib/user-agent' | ||
|
|
||
| const platforms = [ | ||
| { id: 'mac', label: 'Mac' }, | ||
| { id: 'windows', label: 'Windows' }, | ||
| { id: 'linux', label: 'Linux' }, | ||
| ] | ||
|
|
||
| // Imperatively modify article content to show only the selected platform | ||
| // find all platform-specific *block* elements and hide or show as appropriate | ||
| // example: {% mac } block content {% mac %} | ||
| function showPlatformSpecificContent(platform: string) { | ||
| const markdowns = Array.from(document.querySelectorAll<HTMLElement>('.extended-markdown')) | ||
| markdowns | ||
| .filter((el) => platforms.some((platform) => el.classList.contains(platform.id))) | ||
| .forEach((el) => { | ||
| el.style.display = el.classList.contains(platform) ? '' : 'none' | ||
| }) | ||
|
|
||
| // find all platform-specific *inline* elements and hide or show as appropriate | ||
| // example: <span class="platform-mac">inline content</span> | ||
| const platformEls = Array.from( | ||
| document.querySelectorAll<HTMLElement>( | ||
| platforms.map((platform) => `.platform-${platform.id}`).join(', ') | ||
| ) | ||
| ) | ||
| platformEls.forEach((el) => { | ||
| el.style.display = el.classList.contains(`platform-${platform}`) ? '' : 'none' | ||
| }) | ||
| } | ||
|
|
||
| // uses the order of the supportedPlatforms array to | ||
| // determine the default platform | ||
| const getFallbackPlatform = (detectedPlatforms: Array<string>): string => { | ||
| const foundPlatform = platforms.find((platform) => detectedPlatforms.includes(platform.id)) | ||
| return foundPlatform?.id || 'linux' | ||
| } | ||
|
|
||
| type Props = { | ||
| variant?: 'subnav' | 'tabnav' | 'underlinenav' | ||
| } | ||
| export const PlatformPicker = ({ variant = 'subnav' }: Props) => { | ||
| const { defaultPlatform, detectedPlatforms } = useArticleContext() | ||
| const [currentPlatform, setCurrentPlatform] = useState(defaultPlatform || '') | ||
|
|
||
| // Run on mount for client-side only features | ||
| useEffect(() => { | ||
| let userAgent = parseUserAgent().os | ||
| if (userAgent === 'ios') { | ||
| userAgent = 'mac' | ||
| } | ||
|
|
||
| setCurrentPlatform(defaultPlatform || Cookies.get('osPreferred') || userAgent || 'linux') | ||
| }, []) | ||
|
|
||
| // Make sure we've always selected a platform that exists in the article | ||
| useEffect(() => { | ||
| // Only check *after* current platform has been determined | ||
| if (currentPlatform && !detectedPlatforms.includes(currentPlatform)) { | ||
| setCurrentPlatform(getFallbackPlatform(detectedPlatforms)) | ||
| } | ||
| }, [currentPlatform, detectedPlatforms.join(',')]) | ||
|
|
||
| const onClickPlatform = (platform: string) => { | ||
| setCurrentPlatform(platform) | ||
|
|
||
| // imperatively modify the article content | ||
| showPlatformSpecificContent(platform) | ||
|
|
||
| sendEvent({ | ||
| type: EventType.preference, | ||
| preference_name: 'os', | ||
| preference_value: platform, | ||
| }) | ||
|
|
||
| Cookies.set('osPreferred', platform, { | ||
| sameSite: 'strict', | ||
| secure: true, | ||
| }) | ||
| } | ||
|
|
||
| // only show platforms that are in the current article | ||
| const platformOptions = platforms.filter((platform) => detectedPlatforms.includes(platform.id)) | ||
|
|
||
| const sharedContainerProps = { | ||
| 'data-testid': 'platform-picker', | ||
| 'aria-label': 'Platform picker', | ||
| 'data-default-platform': defaultPlatform, | ||
| className: 'mb-4', | ||
| } | ||
|
|
||
| if (variant === 'subnav') { | ||
| return ( | ||
| <SubNav {...sharedContainerProps}> | ||
| <SubNav.Links> | ||
| {platformOptions.map((option) => { | ||
| return ( | ||
| <SubNav.Link | ||
| key={option.id} | ||
| data-platform={option.id} | ||
| as="button" | ||
| selected={option.id === currentPlatform} | ||
| onClick={() => { | ||
| onClickPlatform(option.id) | ||
| }} | ||
| > | ||
| {option.label} | ||
| </SubNav.Link> | ||
| ) | ||
| })} | ||
| </SubNav.Links> | ||
| </SubNav> | ||
| ) | ||
| } | ||
|
|
||
| if (variant === 'underlinenav') { | ||
| return ( | ||
| <UnderlineNav {...sharedContainerProps}> | ||
| {platformOptions.map((option) => { | ||
| return ( | ||
| <UnderlineNav.Link | ||
| key={option.id} | ||
| data-platform={option.id} | ||
| as="button" | ||
| selected={option.id === currentPlatform} | ||
| onClick={() => { | ||
| onClickPlatform(option.id) | ||
| }} | ||
| > | ||
| {option.label} | ||
| </UnderlineNav.Link> | ||
| ) | ||
| })} | ||
| </UnderlineNav> | ||
| ) | ||
| } | ||
|
|
||
| return ( | ||
| <TabNav {...sharedContainerProps}> | ||
| {platformOptions.map((option) => { | ||
| return ( | ||
| <TabNav.Link | ||
| key={option.id} | ||
| data-platform={option.id} | ||
| as="button" | ||
| selected={option.id === currentPlatform} | ||
| onClick={() => { | ||
| onClickPlatform(option.id) | ||
| }} | ||
| > | ||
| {option.label} | ||
| </TabNav.Link> | ||
| ) | ||
| })} | ||
| </TabNav> | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.