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

fix(v2): make code blocks scrollable #2241

Merged
merged 3 commits into from
Feb 8, 2020
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
28 changes: 13 additions & 15 deletions packages/docusaurus-theme-classic/src/theme/CodeBlock/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,17 @@ export default ({children, className: languageClassName, metastring}) => {
code={children.trim()}
language={language}>
{({className, style, tokens, getLineProps, getTokenProps}) => (
<div className={styles.codeBlockWrapper}>
<pre
ref={target}
className={classnames(className, styles.codeBlock)}
style={style}>
<pre className={classnames(className, styles.codeBlock)}>
<button
ref={button}
type="button"
aria-label="Copy code to clipboard"
className={styles.copyButton}
onClick={handleCopyCode}>
{showCopied ? 'Copied' : 'Copy'}
</button>

<code ref={target} className={styles.codeBlockLines} style={style}>
{tokens.map((line, i) => {
const lineProps = getLineProps({line, key: i});

Expand All @@ -110,16 +116,8 @@ export default ({children, className: languageClassName, metastring}) => {
</div>
);
})}
</pre>
<button
ref={button}
type="button"
aria-label="Copy code to clipboard"
className={styles.copyButton}
onClick={handleCopyCode}>
{showCopied ? 'Copied' : 'Copy'}
</button>
</div>
</code>
</pre>
)}
</Highlight>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,10 @@
*/

.codeBlock {
margin-bottom: 0;
overflow: hidden;
overflow-wrap: break-word;
white-space: pre-wrap;
}

.codeBlockWrapper {
position: relative;
}

.codeBlockWrapper:hover > .copyButton {
visibility: visible;
opacity: 1;
overflow: auto;
display: block;
padding: 0;
margin: 0;
}

.copyButton {
Expand All @@ -38,3 +29,17 @@
transition: opacity 200ms ease-in-out, visibility 200ms ease-in-out,
bottom 200ms ease-in-out;
}

.codeBlock:hover > .copyButton {
visibility: visible;
opacity: 1;
}

.codeBlockLines {
background-color: transparent;
border-radius: 0;
margin-bottom: 0;
float: left;
min-width: 100%;
padding: var(--ifm-pre-padding);
}
3 changes: 2 additions & 1 deletion packages/docusaurus-theme-classic/src/theme/DocItem/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
import DocPaginator from '@theme/DocPaginator';
import useTOCHighlight from '@theme/hooks/useTOCHighlight';

import classnames from 'classnames';
import styles from './styles.module.css';

const LINK_CLASS_NAME = 'contents__link';
Expand Down Expand Up @@ -95,7 +96,7 @@ function DocItem(props) {
<div className="padding-vert--lg">
<div className="container">
<div className="row">
<div className="col">
<div className={classnames('col', styles.docItemCol)}>
<div className={styles.docItemContainer}>
<article>
{version && (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@
padding: 0 0.5rem;
}

@media only screen and (min-width: 997px) {
.docItemCol {
max-width: 75% !important;
}
}

.tableOfContents {
display: inherit;
max-height: calc(100vh - (var(--ifm-navbar-height) + 2rem));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import React from 'react';
import Link from '@docusaurus/Link';
import CodeBlock from '@theme/CodeBlock';
import Heading from '@theme/Heading';

import styles from './styles.module.css';

export default {
Expand All @@ -26,7 +27,7 @@ export default {
}
return <Link {...props} />;
},
pre: props => <pre className={styles.mdxCodeBlock} {...props} />,
pre: props => <div className={styles.mdxCodeBlock} {...props} />,
h1: Heading('h1'),
h2: Heading('h2'),
h3: Heading('h3'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@
*/

.mdxCodeBlock {
background-color: transparent;
position: relative;
border-radius: var(--ifm-global-radius);
box-sizing: border-box;
font-family: inherit;
padding: 0;
margin-bottom: var(--ifm-leading);
font-size: var(--ifm-code-font-size);
}

.mdxCodeBlock pre {
font-size: inherit;
}
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,17 @@ export default ({
code={children.trim()}
language={language}>
{({className, style, tokens, getLineProps, getTokenProps}) => (
<div className={styles.codeBlockWrapper}>
<pre
ref={target}
className={classnames(className, styles.codeBlock)}
style={style}>
<pre className={classnames(className, styles.codeBlock)}>
<button
ref={button}
type="button"
aria-label="Copy code to clipboard"
className={styles.copyButton}
onClick={handleCopyCode}>
{showCopied ? 'Copied' : 'Copy'}
</button>

<code ref={target} className={styles.codeBlockLines} style={style}>
{tokens.map((line, i) => {
const lineProps = getLineProps({line, key: i});

Expand All @@ -129,16 +135,8 @@ export default ({
</div>
);
})}
</pre>
<button
ref={button}
type="button"
aria-label="Copy code to clipboard"
className={styles.copyButton}
onClick={handleCopyCode}>
{showCopied ? 'Copied' : 'Copy'}
</button>
</div>
</code>
</pre>
)}
</Highlight>
);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
.codeBlock {
font-size: inherit;
margin-bottom: 0;
overflow: hidden;
overflow-wrap: break-word;
white-space: pre-wrap;
}

.codeBlockWrapper {
position: relative;
}
/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

.codeBlockWrapper:hover > .copyButton {
visibility: visible;
opacity: 1;
.codeBlock {
overflow: auto;
display: block;
padding: 0;
margin: 0;
}

.copyButton {
Expand All @@ -32,3 +29,17 @@
transition: opacity 200ms ease-in-out, visibility 200ms ease-in-out,
bottom 200ms ease-in-out;
}

.codeBlock:hover > .copyButton {
visibility: visible;
opacity: 1;
}

.codeBlockLines {
background-color: transparent;
border-radius: 0;
margin-bottom: 0;
float: left;
min-width: 100%;
padding: var(--ifm-pre-padding);
}