Skip to content

Documentation: Updated TS documentation for re-using play functions #21517

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

Merged
ndelangen merged 3 commits into from
Nov 28, 2023
Merged

Documentation: Updated TS documentation for re-using play functions #21517

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
9d1a1fb
Updated TS documentation for re-using play functions
Foxhoundn Mar 9, 2023
3b88fbf
Updated also JS & Web-components documentaitons. Using full `context`…
Foxhoundn Mar 9, 2023
7f67fa8
Merge branch 'next' into patch-1
ndelangen Nov 28, 2023
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
8 changes: 4 additions & 4 deletions docs/snippets/common/my-component-play-function-composition.js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ export const SecondStory = {
};

export const CombinedStories = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
play: async (context) => {
const canvas = within(context.canvasElement);

// Runs the FirstStory and Second story play function before running this story's play function
await FirstStory.play({ canvasElement });
await SecondStory.play({ canvasElement });
await FirstStory.play(context);
await SecondStory.play(context);
await userEvent.type(canvas.getByTestId('another-element'), 'random value');
},
};
Expand Down
8 changes: 4 additions & 4 deletions docs/snippets/common/my-component-play-function-composition.ts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ export const SecondStory: Story = {
};

export const CombinedStories: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
play: async (context) => {
const canvas = within(context.canvasElement);

// Runs the FirstStory and Second story play function before running this story's play function
await FirstStory.play({ canvasElement });
await SecondStory.play({ canvasElement });
await FirstStory.play(context);
await SecondStory.play(context);
await userEvent.type(canvas.getByTestId('another-element'), 'random value');
},
};
Expand Down
8 changes: 4 additions & 4 deletions docs/snippets/web-components/my-component-play-function-composition.js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ export const SecondStory = {
};

export const CombinedStories = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
play: async (context) => {
const canvas = within(context.canvasElement);

// Runs the FirstStory and Second story play function before running this story's play function
await FirstStory.play({ canvasElement });
await SecondStory.play({ canvasElement });
await FirstStory.play(context);
await SecondStory.play(context);
await userEvent.type(canvas.getByTestId('another-element'), 'random value');
},
};
Expand Down
8 changes: 4 additions & 4 deletions docs/snippets/web-components/my-component-play-function-composition.ts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ export const SecondStory: Story = {
};

export const CombinedStories: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);
play: async (context) => {

@jonniebigodes jonniebigodes Mar 10, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Foxhoundn can you add a small comment in the example explaining why the user would use context instead of the destructured canvasElement, so that we can clarify to the readers? Also if you're able, can you also apply this pattern to this file, so that folks don't see one example with canvasElement and another with context

const canvas = within(context.canvasElement);

// Runs the FirstStory and Second story play function before running this story's play function
await FirstStory.play({ canvasElement });
await SecondStory.play({ canvasElement });
await FirstStory.play(context);
await SecondStory.play(context);
await userEvent.type(canvas.getByTestId('another-element'), 'random value');
},
};
Expand Down