storybookjs/storybook

How to show viewport on the docs page?

Open

#9,218 opened on Dec 22, 2019

View on GitHub
 (2 comments) (16 reactions) (0 assignees)TypeScript (10,058 forks)batch import
addon: docsaddon: viewporthelp wantedmediumtriage:reviewed

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (Avg merge 7d 22h) (184 merged PRs in 30d)

Description

Describe the bug How to show viewport on the docs page? The canvas page has viewport options，But the documentation page is not。Is this a bug or does it require additional configuration?

Screenshots The canvas page has viewport options. image

But the documentation page is not。 image

Code snippets

import { configure, addParameters } from '@storybook/react'
import { DocsPage, DocsContainer } from '@storybook/addon-docs/blocks'
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport'
import '../src/index.less'

addParameters({
    viewport: {
        viewports: INITIAL_VIEWPORTS
    },
    docs: {
        container: DocsContainer,
        page: DocsPage
    }
})

Contributor guide

Research direction
Investigate why viewport options are not showing on the Docs page. Look into the viewport addon source code and its integration with the Docs container. Check if there is a separate configuration required for the Docs viewport.
Tech stack
reacttypescript
Domain
frontenddocumentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75