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

Jump to bottom

[docs] Live editable demos #24640

Closed
wants to merge 17 commits into from
Closed

[docs] Live editable demos #24640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
33480f4
[docs] WIP Live demos
mbrookes Jan 23, 2021
bdb829d
All demos, not just components
mbrookes Jan 27, 2021
1a7bcb6
requireComponent => requireImports
mbrookes Jan 27, 2021
c47fe07
yarn deduplicate
mbrookes Jan 27, 2021
fd3d8c6
prettier
mbrookes Jan 27, 2021
bd7dfc6
create -> build
mbrookes Jan 27, 2021
cca3025
update getJsxPreview tests
mbrookes Jan 27, 2021
b7dd5c8
ts support
mbrookes Jan 28, 2021
f442ce8
Exclude some directories
mbrookes Jan 28, 2021
375b225
fix aliased imports, fix require for skipped files
mbrookes Jan 28, 2021
78379ea
Fix regression test file pattern
mbrookes Jan 29, 2021
e82ce3b
Fix demo width
mbrookes Jan 29, 2021
e4fc1ae
Add keyboard focus indicator
mbrookes Jan 29, 2021
d53aba4
editable previews
mbrookes Jan 30, 2021
d3bb795
don't inline codeOpenChange
mbrookes Jan 31, 2021
73055aa
dynamic import typescript
mbrookes Feb 13, 2021
3290a6b
lint
mbrookes Feb 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"final-form": "^4.18.5",
"flexsearch": "^0.6.30",
"fs-extra": "^9.0.0",
"jarle": "^1.1.0",
"json2mq": "^0.2.0",
"jss": "^10.0.3",
"jss-plugin-template": "^10.0.3",
Expand All @@ -102,6 +103,7 @@
"react-redux": "^7.1.1",
"react-router": "^5.0.0",
"react-router-dom": "^5.0.1",
"react-simple-code-editor": "^0.11.0",
"react-spring": "^8.0.27",
"react-swipeable-views": "^0.13.9",
"react-text-mask": "^5.0.2",
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/company/about.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import TopLayoutCompany from 'docs/src/modules/components/TopLayoutCompany';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'company/about';
const requireDemo = require.context('docs/src/pages/company/about', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/company/about', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/company/about',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <TopLayoutCompany demos={demos} docs={docs} requireDemo={requireDemo} />;
return <TopLayoutCompany demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/company/contact.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import TopLayoutCompany from 'docs/src/modules/components/TopLayoutCompany';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'company/contact';
const requireDemo = require.context('docs/src/pages/company/contact', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/company/contact', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/company/contact',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <TopLayoutCompany demos={demos} docs={docs} requireDemo={requireDemo} />;
return <TopLayoutCompany demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/company/jobs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import TopLayoutCompany from 'docs/src/modules/components/TopLayoutCompany';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'company/jobs';
const requireDemo = require.context('docs/src/pages/company/jobs', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/company/jobs', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/company/jobs',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <TopLayoutCompany demos={demos} docs={docs} requireDemo={requireDemo} />;
return <TopLayoutCompany demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/company/software-engineer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import TopLayoutCompany from 'docs/src/modules/components/TopLayoutCompany';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'company/software-engineer';
const requireDemo = require.context(
const requireImports = require.context(
'docs/src/pages/company/software-engineer',
false,
/\.(js|tsx)$/,
Expand All @@ -15,7 +15,7 @@ const requireRaw = require.context(
);

export default function Page({ demos, docs }) {
return <TopLayoutCompany demos={demos} docs={docs} requireDemo={requireDemo} />;
return <TopLayoutCompany demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/about-the-lab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/about-the-lab';
const requireDemo = require.context(
const requireImports = require.context(
'docs/src/pages/components/about-the-lab',
false,
/\.(js|tsx)$/,
Expand All @@ -15,7 +15,7 @@ const requireRaw = require.context(
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
8 changes: 6 additions & 2 deletions docs/pages/components/accordion.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/accordion';
const requireDemo = require.context('docs/src/pages/components/accordion', false, /\.(js|tsx)$/);
const requireImports = require.context(
'docs/src/pages/components/accordion',
false,
/Imports\.js$/,
);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/accordion',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/alert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/alert';
const requireDemo = require.context('docs/src/pages/components/alert', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/alert', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/alert',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/app-bar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/app-bar';
const requireDemo = require.context('docs/src/pages/components/app-bar', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/app-bar', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/app-bar',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
10 changes: 7 additions & 3 deletions docs/pages/components/autocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/autocomplete';
const requireDemo = require.context('docs/src/pages/components/autocomplete', false, /\.(js|tsx)$/);
const requireImports = require.context(
'docs/src/pages/components/autocomplete',
false,
/Imports\.js$/,
);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/autocomplete',
false,
Expand All @@ -12,10 +16,10 @@ const requireRaw = require.context(

// Run styled-components ref logic
// https://github.com/styled-components/styled-components/pull/2998
requireDemo.keys().map(requireDemo);
requireImports.keys().map(requireImports);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/avatars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/avatars';
const requireDemo = require.context('docs/src/pages/components/avatars', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/avatars', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/avatars',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/backdrop.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/backdrop';
const requireDemo = require.context('docs/src/pages/components/backdrop', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/backdrop', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/backdrop',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/badges.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/badges';
const requireDemo = require.context('docs/src/pages/components/badges', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/badges', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/badges',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/bottom-navigation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/bottom-navigation';
const requireDemo = require.context(
const requireImports = require.context(
'docs/src/pages/components/bottom-navigation',
false,
/\.(js|tsx)$/,
Expand All @@ -15,7 +15,7 @@ const requireRaw = require.context(
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/box.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/box';
const requireDemo = require.context('docs/src/pages/components/box', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/box', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/box',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
8 changes: 6 additions & 2 deletions docs/pages/components/breadcrumbs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/breadcrumbs';
const requireDemo = require.context('docs/src/pages/components/breadcrumbs', false, /\.(js|tsx)$/);
const requireImports = require.context(
'docs/src/pages/components/breadcrumbs',
false,
/Imports\.js$/,
);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/breadcrumbs',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
8 changes: 6 additions & 2 deletions docs/pages/components/button-group.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/button-group';
const requireDemo = require.context('docs/src/pages/components/button-group', false, /\.(js|tsx)$/);
const requireImports = require.context(
'docs/src/pages/components/button-group',
false,
/Imports\.js$/,
);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/button-group',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/buttons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/buttons';
const requireDemo = require.context('docs/src/pages/components/buttons', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/buttons', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/buttons',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/cards.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/cards';
const requireDemo = require.context('docs/src/pages/components/cards', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/cards', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/cards',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
8 changes: 6 additions & 2 deletions docs/pages/components/checkboxes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/checkboxes';
const requireDemo = require.context('docs/src/pages/components/checkboxes', false, /\.(js|tsx)$/);
const requireImports = require.context(
'docs/src/pages/components/checkboxes',
false,
/Imports\.js$/,
);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/checkboxes',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/components/chips.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import { prepareMarkdown } from 'docs/src/modules/utils/parseMarkdown';

const pageFilename = 'components/chips';
const requireDemo = require.context('docs/src/pages/components/chips', false, /\.(js|tsx)$/);
const requireImports = require.context('docs/src/pages/components/chips', false, /Imports\.js$/);
const requireRaw = require.context(
'!raw-loader!../../src/pages/components/chips',
false,
/\.(js|md|tsx)$/,
);

export default function Page({ demos, docs }) {
return <MarkdownDocs demos={demos} docs={docs} requireDemo={requireDemo} />;
return <MarkdownDocs demos={demos} docs={docs} requireImports={requireImports} />;
}

Page.getInitialProps = () => {
Expand Down