Skip to content

Conversation

@brendanatshopify
Copy link
Contributor

WHY are these changes introduced?

Fixes: #4391

In the current project README.md the instructions contain a link to tophat the Playground in an isolated environment at the url: http://YOUR_IP_ADDRESS:ASSIGNED_PORT/iframe.html?selectedKind=Playground&selectedStory=Playground. This link brings up an error dialogue.

WHAT is this pull request doing?

This updates the documentation to use the path param as suggested by Storybook.

To 🎩 :

  1. Open up Playground.tsx and paste the following in:
import React from 'react';

import {Page} from '../src';

export function Playground() {
  return (
    <Page title="Playground">
      <span role="img" aria-label="Hand wave emoji">
        👋
      </span>
    </Page>
  );
}
  1. Run yarn dev
  2. Visit http://YOUR_IP_ADDRESS:ASSIGNED_PORT/iframe.html?selectedKind=Playground&selectedStory=Playground
  3. This should return an error dialogue
  4. Visit http://YOUR_IP_ADDRESS:ASSIGNED_PORT/iframe.html?path=/story/playground-playground--playground
  5. You should see the contents of the Playground on the page

@brendanatshopify brendanatshopify added Bug Something is broken and not working as intended in the system. 📓 Documentation labels Aug 12, 2021
@github-actions
Copy link
Contributor

size-limit report

Path Size
cjs 142.51 KB (0%)
esm 96.27 KB (0%)
esnext 139.44 KB (0%)
css 33.74 KB (0%)

Copy link
Member

@AndrewMusgrave AndrewMusgrave left a comment

Choose a reason for hiding this comment

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

Nice 🎉 Would you mind adding an addition to UNRELEASED.md

@brendanatshopify brendanatshopify merged commit 5be22a7 into main Aug 12, 2021
@brendanatshopify brendanatshopify deleted the update-iframe-playground-link branch August 12, 2021 18:15
lucabezerra pushed a commit that referenced this pull request Aug 16, 2021
… iframe (#4392)

* [README] Update iframe.html link for Playground tophatting

* Add entry to UNRELEASED
BPScott pushed a commit that referenced this pull request Aug 17, 2021
… iframe (#4392)

* [README] Update iframe.html link for Playground tophatting

* Add entry to UNRELEASED
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something is broken and not working as intended in the system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] iframe url for local tophatting in Playground is incorrect

3 participants