Skip to content

guide screenshot

Drew Jones edited this page Jan 26, 2021 · 1 revision

Screenshot guide

Within our documentation we have a number of screenshots. An example page containing quite a few screenshots is the ns-landmark

There are two types of screenshot, one as an example and another as an annotated image to assist the content guidance.

Create an example screenshot

Using Firefox, set the browser to 1280px wide.

(I find it's easiest to do this using the developer toolbar pinned to the side.)

Storybook create

Once you have configured your desired content within the Knobs, launch the iframe image to open the developer tools in the new tab to set the screen width.

Using the firefox screenshot tool, take a screenshot of the full width component.

Examples

The ns-landmark fills the full width:

Firefox screenshot ns-landmark

To screenshot a list of components, display them in ns-panel and screenshot the entire panel.

Firefox screenshot ns-panel

There maybe a combination of components that is required that is not possible to create using Storybook. The exact same technique can be used to screenshot any ns-panel within a prototype, or an HTML page mockup saved locally.

Firefox screenshot prototype

An example, of an example screenshot

This is ready to be embedded into one of our docs.

ns-landmark-lakeside-cake

Happy screenshotting 👩🏽‍💻