Skip to content

Commit 3e19e46

Browse files
Fix links, simplify examples
1 parent e70ca94 commit 3e19e46

File tree

6 files changed

+29
-40
lines changed

6 files changed

+29
-40
lines changed

docs/react.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
</MakeCodeRenderBlocksProvider>;
2222
```
2323

24-
For more examples, take a look at the [MakeCode blocks rendering demo source code](../src/stories/MakeCodeBlocksRendering.stories.tsx).
24+
For more examples, take a look at the [MakeCode blocks rendering demo source code](../src/stories/react/MakeCodeBlocksRendering.stories.tsx).
2525

2626
## Embed MakeCode editor
2727

@@ -33,13 +33,14 @@ import { MakeCodeFrame } from '@microbit/makecode-embed/react';
3333
<MakeCodeFrame
3434
ref={ref}
3535
controller={1}
36-
controllerId={controllerId}
36+
controllerId="YOUR APP NAME HERE"
3737
initialProjects={[savedProject]}
38+
onEditorContentLoaded={(e) => console.log("MakeCode is now ready")},
3839
onWorkspaceSave={(e) => {
3940
// Set project as project changes in the editor.
4041
setSavedProject(e.project);
4142
}}
4243
/>;
4344
```
4445

45-
For more examples, take a look at the [MakeCode frame demo source code](../src/stories/MakeCodeFrame.stories.tsx).
46+
For more examples, take a look at the [MakeCode frame demo source code](../src/stories/react/MakeCodeFrame.stories.tsx).

docs/vanilla.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
2424
`;
2525
```
2626

27-
For more examples, take a look at the [MakeCode blocks rendering demo source code](../src/stories/createMakeCodeRenderBlocks.stories.tsx).
27+
For more examples, take a look at the [MakeCode blocks rendering demo source code](../src/stories/vanilla/makecode-render-blocks.stories.tsx).
2828

2929
## Embed MakeCode editor
3030

@@ -55,20 +55,16 @@ document.querySelector<HTMLDivElement>("#app")!.appendChild(iframe);
5555
// Create and initialise an instance of MakeCodeFrameDriver.
5656
const driverRef = new MakeCodeFrameDriver(
5757
{
58+
controllerId: "YOUR APP NAME HERE",
5859
initialProjects: async () => [makeCodeProject],
59-
onEditorContentLoaded: (e) => console.log("editorContentLoaded", e),
60-
onWorkspaceLoaded: (e) => console.log("workspaceLoaded", e),
61-
onWorkspaceSync: (e) => console.log("workspaceSync", e),
62-
onWorkspaceReset: (e) => console.log("workspaceReset", e),
63-
onWorkspaceEvent: (e) => console.log("workspaceEvent", e),
60+
onEditorContentLoaded: (e) => console.log("MakeCode is now ready"),
6461
onWorkspaceSave: (e) => {
6562
console.log(e.project!.header!.id, e.project);
6663
},
67-
onTutorialEvent: (e) => console.log("tutorialEvent", e),
6864
},
6965
() => iframe
7066
);
7167
driverRef.initialize();
7268
```
7369

74-
For more examples, take a look at the [MakeCode frame demo source code](../src/stories/makeCodeFrameDriver.stories.tsx).
70+
For more examples, take a look at the [MakeCode frame demo source code](../src/stories/vanilla/makecode-frame-driver.stories.tsx).

src/stories/MakeCodeBlocksRendering.stories.tsx renamed to src/stories/react/MakeCodeBlocksRendering.stories.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { Meta, StoryObj } from '@storybook/react';
22
import { ReactNode, useState } from 'react';
3-
import MakeCodeBlocksRendering from '../react/MakeCodeBlocksRendering.js';
3+
import MakeCodeBlocksRendering from '../../react/MakeCodeBlocksRendering.js';
44
import {
55
initialProject,
66
project,
@@ -12,10 +12,10 @@ import {
1212
projectWithTwoExtensions,
1313
projectWithUserLayout,
1414
strawbeesExample,
15-
} from './fixtures.js';
16-
import { MakeCodeRenderBlocksProvider } from '../react/MakeCodeRenderBlocksProvider.js';
17-
import { MakeCodeRenderBlocksOptions } from '../vanilla/makecode-render-blocks.js';
18-
import { BlockLayout, Project } from '../vanilla/pxt.js';
15+
} from '../fixtures.js';
16+
import { MakeCodeRenderBlocksProvider } from '../../react/MakeCodeRenderBlocksProvider.js';
17+
import { MakeCodeRenderBlocksOptions } from '../../vanilla/makecode-render-blocks.js';
18+
import { BlockLayout, Project } from '../../vanilla/pxt.js';
1919

2020
const meta: Meta<typeof MakeCodeRenderBlocksProvider> = {
2121
title: 'stories/React/MakeCodeBlocksRendering',

src/stories/MakeCodeFrame.stories.tsx renamed to src/stories/react/MakeCodeFrame.stories.tsx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { Meta, StoryObj } from '@storybook/react';
22
import { useCallback, useRef } from 'react';
3-
import { defaultMakeCodeProject } from '../vanilla/examples.js';
4-
import { MakeCodeFrameDriver } from '../vanilla/makecode-frame-driver.js';
3+
import { defaultMakeCodeProject } from '../../vanilla/examples.js';
4+
import { MakeCodeFrameDriver } from '../../vanilla/makecode-frame-driver.js';
55
import {
66
default as MakeCodeFrame,
77
MakeCodeFrameProps,
8-
} from '../react/MakeCodeFrame.js';
9-
import { Project } from '../vanilla/pxt.js';
10-
import { controllerId } from './config.js';
11-
import StoryWrapper from './StoryWrapper.js';
12-
import MakeCodeToolbar from './MakeCodeToolbar.js';
8+
} from '../../react/MakeCodeFrame.js';
9+
import { Project } from '../../vanilla/pxt.js';
10+
import { controllerId } from '../config.js';
11+
import StoryWrapper from '../StoryWrapper.js';
12+
import MakeCodeToolbar from '../MakeCodeToolbar.js';
1313

1414
const meta: Meta<typeof MakeCodeFrame> = {
1515
title: 'stories/React/MakeCodeFrame',

src/stories/makeCodeFrameDriver.stories.tsx renamed to src/stories/vanilla/makecode-frame-driver.stories.tsx

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Meta, StoryObj } from '@storybook/react';
22
import { useRef } from 'react';
3-
import { defaultMakeCodeProject } from '../vanilla/examples.js';
3+
import { defaultMakeCodeProject } from '../../vanilla/examples.js';
44
import {
55
createMakeCodeURL,
66
MakeCodeFrameDriver,
77
Options,
8-
} from '../vanilla/makecode-frame-driver.js';
9-
import { Project } from '../vanilla/pxt.js';
10-
import MakeCodeToolbar from './MakeCodeToolbar.js';
11-
import StoryWrapper from './StoryWrapper.js';
8+
} from '../../vanilla/makecode-frame-driver.js';
9+
import { Project } from '../../vanilla/pxt.js';
10+
import MakeCodeToolbar from '../MakeCodeToolbar.js';
11+
import StoryWrapper from '../StoryWrapper.js';
1212

1313
interface StoryArgs {
1414
options?: {
@@ -29,14 +29,6 @@ export default meta;
2929

3030
type Story = StoryObj<StoryArgs>;
3131

32-
const toolbarStyles = {
33-
fontFamily: 'sans-serif',
34-
display: 'flex',
35-
flexWrap: 'wrap',
36-
gap: '5px',
37-
margin: '10px 0',
38-
} as const;
39-
4032
const renderEditor = (args: StoryArgs) => {
4133
const savedProjects = useRef<Map<string, Project>>(new Map());
4234
const ref = useRef<MakeCodeFrameDriver | null>(null);

src/stories/createMakeCodeRenderBlocks.stories.tsx renamed to src/stories/vanilla/makecode-render-blocks.stories.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Meta, StoryObj } from '@storybook/react';
22
import {
33
createMakeCodeRenderBlocks,
44
MakeCodeRenderBlocksOptions,
5-
} from '../vanilla/makecode-render-blocks.js';
5+
} from '../../vanilla/makecode-render-blocks.js';
66
import {
77
initialProject,
88
project,
@@ -12,9 +12,9 @@ import {
1212
projectWithLayout,
1313
projectWithMelody,
1414
projectWithTwoExtensions,
15-
} from './fixtures.js';
16-
import { Project } from '../vanilla/pxt.js';
17-
import StoryWrapper from './StoryWrapper.js';
15+
} from '../fixtures.js';
16+
import { Project } from '../../vanilla/pxt.js';
17+
import StoryWrapper from '../StoryWrapper.js';
1818

1919
interface StoryArgs {
2020
options: MakeCodeRenderBlocksOptions | undefined;

0 commit comments

Comments
 (0)