Rename runPlayFunction -> autoplay

code/lib/preview-web/src/render/StoryRender.test.ts

@@ -51,7 +51,7 @@ describe('StoryRender', () => {
     await expect(preparePromise).rejects.toThrowError(PREPARE_ABORTED);
   });
 
-  it('does run play function if passed runPlayFunction=true', async () => {
+  it('does run play function if passed autoplay=true', async () => {
     const story = {
       id: 'id',
       title: 'title',
@@ -69,7 +69,7 @@ describe('StoryRender', () => {
       {} as any,
       entry.id,
       'story',
-      { runPlayFunction: true },
+      { autoplay: true },
       story as any
     );
 
@@ -77,7 +77,7 @@ describe('StoryRender', () => {
     expect(story.playFunction).toHaveBeenCalled();
   });
 
-  it('does not run play function if passed runPlayFunction=false', async () => {
+  it('does not run play function if passed autoplay=false', async () => {
     const story = {
       id: 'id',
       title: 'title',
@@ -95,7 +95,7 @@ describe('StoryRender', () => {
       {} as any,
       entry.id,
       'story',
-      { runPlayFunction: false },
+      { autoplay: false },
       story as any
     );
 

code/lib/preview-web/src/render/StoryRender.ts

@@ -47,7 +47,7 @@ export type RenderContextCallbacks<TFramework extends AnyFramework> = Pick<
 >;
 
 export type StoryRenderOptions = {
-  runPlayFunction?: boolean;
+  autoplay?: boolean;
 };
 
 export class StoryRender<TFramework extends AnyFramework> implements Render<TFramework> {
@@ -76,7 +76,7 @@ export class StoryRender<TFramework extends AnyFramework> implements Render<TFra
     private callbacks: RenderContextCallbacks<TFramework>,
     public id: StoryId,
     public viewMode: ViewMode,
-    public renderOptions: StoryRenderOptions = { runPlayFunction: true },
+    public renderOptions: StoryRenderOptions = { autoplay: true },
     story?: Store_Story<TFramework>
   ) {
     this.abortController = new AbortController();
@@ -223,12 +223,7 @@ export class StoryRender<TFramework extends AnyFramework> implements Render<TFra
       if (abortSignal.aborted) return;
 
       // The phase should be 'rendering' but it might be set to 'aborted' by another render cycle
-      if (
-        this.renderOptions.runPlayFunction &&
-        forceRemount &&
-        playFunction &&
-        this.phase !== 'errored'
-      ) {
+      if (this.renderOptions.autoplay && forceRemount && playFunction && this.phase !== 'errored') {
         this.disableKeyListeners = true;
         try {
           await this.runPhase(abortSignal, 'playing', async () => {

code/ui/blocks/src/blocks/Story.tsx

@@ -97,8 +97,8 @@ const Story: FC<StoryProps> = (props) => {
     let cleanup: () => void;
     if (story && storyRef.current) {
       const element = storyRef.current as HTMLElement;
-      const runPlayFunction = story.parameters.docs?.autoplay;
-      cleanup = context.renderStoryToElement(story, element, { runPlayFunction });
+      const autoplay = story.parameters.docs?.autoplay;
+      cleanup = context.renderStoryToElement(story, element, { autoplay });
       setShowLoader(false);
     }
     return () => cleanup && cleanup();