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.

Sign up for GitHub

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

Make CodeSurfer compatible with mdx-deck 2.x #54

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Make CodeSurfer compatible with mdx-deck 2.x #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
430cdb4
Update mdx-deck dependency to 2.0.5
vlsi Mar 24, 2019
2f0e7b2
Make CodeSurfer compatible with mdx-deck 2.x
vlsi Mar 24, 2019
81b6609
Ensure CodeSurfer div does not exceed the viewport width
vlsi Mar 24, 2019
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
4 changes: 2 additions & 2 deletions fixtures/react-docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-docs-fixture",
"version": "0.5.5",
"version": "0.6.0",
"author": "pomber",
"license": "MIT",
"private": true,
Expand All @@ -9,7 +9,7 @@
"build": "docz build"
},
"dependencies": {
"code-surfer": "^0.5.5",
"code-surfer": "^0.6.0",
"prop-types": "^15.6.2",
"react": "^16.4.2"
},
Expand Down
6 changes: 3 additions & 3 deletions fixtures/sample/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "sample-fixture",
"private": true,
"version": "0.5.5",
"version": "0.6.0",
"scripts": {
"build": "mdx-deck build sample.mdx",
"start": "mdx-deck sample.mdx"
},
"devDependencies": {
"mdx-deck": "^1.7.7",
"mdx-deck-code-surfer": "^0.5.5",
"mdx-deck": "^2.0.5",
"mdx-deck-code-surfer": "^0.6.0",
"raw-loader": "^0.5.1"
}
}
4 changes: 2 additions & 2 deletions fixtures/sample/sample.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { CodeSurfer } from "mdx-deck-code-surfer"
import { dark } from "mdx-deck/themes"
import { dark } from "@mdx-deck/themes"
import nightOwl from "prism-react-renderer/themes/nightOwl"

export { components } from "mdx-deck-code-surfer"
Expand Down Expand Up @@ -124,7 +124,7 @@ And you can still add regular notes the ol' fashioned way!
---

```jsx Global Theming
import { dark } from "mdx-deck/themes"
import { dark } from "@mdx-deck/themes"
import nightOwl from "prism-react-renderer/themes/nightOwl"

export const theme = {
Expand Down
4 changes: 2 additions & 2 deletions fixtures/storybook/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "storybook-fixture",
"private": true,
"version": "0.5.5",
"version": "0.6.0",
"scripts": {
"build": "build-storybook -c .storybook -o dist",
"start": "start-storybook -c .storybook -p 9001"
},
"devDependencies": {
"@storybook/react": "^3.4.10",
"@types/storybook__react": "^3.0.9",
"code-surfer": "^0.5.5",
"code-surfer": "^0.6.0",
"raw-loader": "^0.5.1"
}
}
6 changes: 3 additions & 3 deletions fixtures/theming/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "theming-fixture",
"private": true,
"version": "0.5.5",
"version": "0.6.0",
"scripts": {
"build": "mdx-deck build theming.mdx",
"start": "mdx-deck theming.mdx"
},
"devDependencies": {
"mdx-deck": "^1.7.0",
"mdx-deck-code-surfer": "^0.5.5",
"mdx-deck": "^2.0.5",
"mdx-deck-code-surfer": "^0.6.0",
"raw-loader": "^0.5.1"
}
}
5 changes: 2 additions & 3 deletions packages/code-surfer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "code-surfer",
"version": "0.5.5",
"version": "0.6.0",
"private": false,
"main": "dist/code-surfer.js",
"files": [
Expand All @@ -26,8 +26,7 @@
"babel-preset-env": "^1.7.0",
"babel-preset-react": "^6.24.1",
"babel-preset-stage-3": "^6.24.1",
"jest": "^23.5.0",
"react": "^16.4.2"
"jest": "^23.5.0"
},
"author": "pomber",
"license": "MIT",
Expand Down
11 changes: 5 additions & 6 deletions packages/mdx-deck-code-surfer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mdx-deck-code-surfer",
"version": "0.5.5",
"version": "0.6.0",
"private": false,
"main": "dist/index.js",
"files": [
Expand All @@ -11,7 +11,7 @@
"build:watch": "yarn build --watch"
},
"dependencies": {
"code-surfer": "^0.5.5",
"code-surfer": "^0.6.0",
"memoize-one": "^4.0.2"
},
"devDependencies": {
Expand All @@ -20,13 +20,12 @@
"babel-preset-env": "^1.7.0",
"babel-preset-react": "^6.24.1",
"babel-preset-stage-2": "^6.24.1",
"mdx-deck": "^1.7.7",
"react": "^16.4.2"
"mdx-deck": "^2.0.5"
},
"peerDependencies": {
"mdx-deck": "^1.7.7",
"mdx-deck": ">=2.0.0",
"react": ">=15.0.0",
"styled-components": ">=3.0.0"
"emotion-theming": ">=10.0.0"
},
"author": "pomber",
"license": "MIT",
Expand Down
21 changes: 10 additions & 11 deletions packages/mdx-deck-code-surfer/src/deck-code-surfer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import CodeSurfer from "code-surfer";
import React from "react";
import { withDeck, updaters } from "mdx-deck";
import { withTheme } from "styled-components";
import { withContext } from "@mdx-deck/components";
import { withTheme } from "emotion-theming";
import memoizeOne from "memoize-one";

const Notes = ({ notes }) =>
Expand All @@ -17,14 +17,10 @@ const Title = ({ title }) =>
class InnerCodeSurfer extends React.Component {
constructor(props) {
super(props);
const { update, index } = props.deck;
const { register, index } = props.context;
if (typeof register !== "function") return;
const parsedSteps = this.parseSteps(props.steps);
const maxStep = parsedSteps.length - 1;
update(updaters.setSteps(index, maxStep));
}

shouldComponentUpdate(nextProps) {
return !!nextProps.deck.active;
register(index, { steps: parsedSteps.length - 1 });
}

parseSteps = memoizeOne((steps, notes) => {
Expand All @@ -50,6 +46,7 @@ class InnerCodeSurfer extends React.Component {

render() {
let {
context,
code,
steps,
title,
Expand All @@ -60,7 +57,8 @@ class InnerCodeSurfer extends React.Component {
...rest
} = this.props;

const stepIndex = this.props.deck.step || 0;
const { step } = context;
const stepIndex = step || 0;
const mdxDeckTheme = theme;
prismTheme = prismTheme || mdxDeckTheme.codeSurfer;
showNumbers = showNumbers || (prismTheme && prismTheme.showNumbers);
Expand Down Expand Up @@ -88,6 +86,7 @@ class InnerCodeSurfer extends React.Component {
<div
style={{
height: "100vh",
maxWidth: "100vw",
display: "flex",
flexDirection: "column",
justifyContent: "center"
Expand Down Expand Up @@ -121,7 +120,7 @@ class InnerCodeSurfer extends React.Component {
}

// Things I need to do to avoid props name collisions
const EnhancedCodeSurfer = withDeck(withTheme(InnerCodeSurfer));
const EnhancedCodeSurfer = withContext(withTheme(InnerCodeSurfer));
export default ({ theme, ...rest }) => (
<EnhancedCodeSurfer {...rest} prismTheme={theme} />
);
2 changes: 1 addition & 1 deletion packages/mdx-deck-code-surfer/src/deck-components.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from "react";
import { Notes } from "mdx-deck";
import { Notes } from "@mdx-deck/components";
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mdx-deck package actually exports all of the components in @mdx-deck/components. See here.

import DeckCodeSurfer from "./deck-code-surfer";

class Code extends React.PureComponent {
Expand Down
4 changes: 2 additions & 2 deletions website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "website",
"version": "0.5.0",
"version": "0.6.0",
"author": "pomber",
"license": "MIT",
"private": true,
Expand All @@ -11,7 +11,7 @@
"start": "gatsby develop"
},
"dependencies": {
"gatsby": "next",
"gatsby": "1.6.3",
"gatsby-plugin-manifest": "next",
"gatsby-plugin-offline": "next",
"gatsby-plugin-react-helmet": "next",
Expand Down
Loading