storybookjs/storybook

Addon-docs: Resize iframe to fit content

Open

#8,112 opened on Sep 18, 2019

View on GitHub
 (32 comments) (8 reactions) (2 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
addon: docsblock: otherfeature requesthelp wantedtriage:reviewed

Description

Is your feature request related to a problem? Please describe. Sometimes the component being displayed in Docs is only a few px tall, yet the iframe defaults to 500px. When you have a lot of these stories stacked, there is a lot of empty space.

Describe the solution you'd like After iframe loads, have it resize to fit the content

Describe alternatives you've considered Can set styles to manually override the iframe height per-story, but this is difficult/tedious to maintain

Contributor guide

Tech stack
typescriptreacthtmlcss
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of iframe resizingFamiliarity with Storybook addon docs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
First, examine the iframe component in Storybook's addon docs package, likely in `addons/docs/src/blocks/`. Understand how the iframe is currently sized (fixed 500px). Then, implement a listener for the iframe's `load` event and use `postMessage` to receive the content's height. Alternatively, use `ResizeObserver` to detect size changes. Check comments in the issue for any previous attempts or constraints. Ensure the solution works across different browsers and handles dynamic content resizing.