@ju-skinner/sw-doc-components

Doc Components

Background

We started off using Storybook to document our Stencil Web Components. With Stencil you have framework integrations or Output Targets, we were using React. Instead of having multiple versions of Storybook (WebComponents, React, etc), we elected to recreate the common components we used within Storybook (ArgsTable and Canvas).

Components

docArgsTable

The docArgsTable component can be used to show a static table of arg types for a given component as a way to document its interface.

Properties

name	description
docSource	The docs-json output type from Stencil. During compiliation Stencil will generate a JSON file with all of the components metadata. You can read more about docs-json here. It expects the components key.
componentName	The name of the component to lookup.

docCanvas

The Canvas component is a wrapper, featuring a series of buttons to view the various Source snippets.

Properties

name	description
mdxSource	An object of key/value pairs. Each key will render a button that will show the source code.

How to use

docArgsTable

import { DocArgsTable } from '@ju-skinner/sw-doc-components';
import { components } from '../../../../dist/docs.json';

<DocArgsTable componentName='pds-radio' docSource={components} />

output

docCanvas

import { DocCanvas } from '@ju-skinner/sw-doc-components';

<DocCanvas mdxSource={{
  react: `<PdsRadio componentId="message1" label="Label" helperMessage="This is short message text." />`,
  webComponent: `<pds-radio component-id="message1" label="Label" helper-message="This is short message text." />`
}}>
  <pds-radio component-id="message1" label="Label" helper-message="This is short message text." />
</DocCanvas>

output

Default state

Active Tab