feat(theme-classic): toggle code wrap button #7036
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
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
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,49 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
| import clsx from 'clsx'; | ||
| import {translate} from '@docusaurus/Translate'; | ||
| import type {Props} from '@theme/CodeBlock/WordWrapButton'; | ||
|
|
||
| import styles from './styles.module.css'; | ||
|
|
||
| export default function WordWrapButton({ | ||
| className, | ||
| onClick, | ||
| isEnabled, | ||
| }: Props): JSX.Element | null { | ||
| const title = translate({ | ||
| id: 'theme.CodeBlock.wordWrapToggle', | ||
| message: 'Toggle word wrap', | ||
| description: | ||
| 'The title attribute for toggle word wrapping button of code block lines', | ||
| }); | ||
|
|
||
| return ( | ||
| <button | ||
| type="button" | ||
| onClick={onClick} | ||
| className={clsx( | ||
| 'clean-btn', | ||
| className, | ||
| isEnabled && styles.wordWrapButtonEnabled, | ||
| )} | ||
| aria-label={title} | ||
| title={title}> | ||
| <svg | ||
| className={styles.wordWrapButtonIcon} | ||
| viewBox="0 0 24 24" | ||
| aria-hidden="true"> | ||
| <path | ||
| fill="currentColor" | ||
| d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z" | ||
| /> | ||
| </svg> | ||
| </button> | ||
| ); | ||
| } |
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,15 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| .wordWrapButtonIcon { | ||
| width: 1.2rem; | ||
| height: 1.2rem; | ||
| } | ||
|
|
||
| .wordWrapButtonEnabled .wordWrapButtonIcon { | ||
Josh-Cena marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| color: var(--ifm-color-primary); | ||
| } | ||
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,62 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import type {MutableRefObject} from 'react'; | ||
| import {useState, useCallback, useEffect, useRef} from 'react'; | ||
|
|
||
| export function useCodeWordWrap(): { | ||
| readonly codeBlockRef: (node: HTMLPreElement | null) => void; | ||
|
There was a problem hiding this comment. this is not needed to use a function here you can return the React ref and assign it directly (like it was before, but instead it's created in the custom hook instead of the component |
||
| readonly isEnabled: boolean; | ||
| readonly isCodeScrollable: boolean; | ||
| readonly toggle: () => void; | ||
| } { | ||
| const [isEnabled, setIsEnabled] = useState(false); | ||
| const [isCodeScrollable, setIsCodeScrollable] = useState<boolean>(false); | ||
| const codeBlock = useRef() as MutableRefObject<HTMLPreElement>; | ||
| const codeBlockRef = useCallback((node: HTMLPreElement | null) => { | ||
| if (node !== null) { | ||
| codeBlock.current = node; | ||
| } | ||
| }, []); | ||
|
|
||
| const toggle = useCallback(() => { | ||
| const codeElement = codeBlock.current.querySelector('code')!; | ||
|
|
||
| if (isEnabled) { | ||
| codeElement.removeAttribute('style'); | ||
| } else { | ||
| codeElement.style.whiteSpace = 'pre-wrap'; | ||
| } | ||
|
|
||
| setIsEnabled((value) => !value); | ||
| }, [codeBlock, isEnabled]); | ||
|
|
||
| const updateCodeIsScrollable = useCallback(() => { | ||
| const {scrollWidth, clientWidth} = codeBlock.current; | ||
| const isScrollable = | ||
| scrollWidth > clientWidth || | ||
| codeBlock.current.querySelector('code')!.hasAttribute('style'); | ||
| setIsCodeScrollable(isScrollable); | ||
| }, [codeBlock]); | ||
|
|
||
| useEffect(() => { | ||
| updateCodeIsScrollable(); | ||
| }, [isEnabled, updateCodeIsScrollable]); | ||
|
|
||
| useEffect(() => { | ||
| window.addEventListener('resize', updateCodeIsScrollable, { | ||
| passive: true, | ||
| }); | ||
|
|
||
| return () => { | ||
| window.removeEventListener('resize', updateCodeIsScrollable); | ||
| }; | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, []); | ||
|
|
||
| return {codeBlockRef, isEnabled, isCodeScrollable, toggle}; | ||
| } | ||
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
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
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
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
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
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
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we want to use the same size for all buttongroup icons? and introduce anv env variable to customize?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't work that way, the proportions of both icons are different, so if we use the same sizing for them, the wordWrap button will look smaller than the copyButton icon:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can keep it this way for now, but I guess the wordWrap svg could also be cropped somehow to take full space