Document Components

  • every component contains a README.mdx in component directory's root
  • contains a short paragraph/written explanation of the component's purpose
  • examples
  • components' API
  • components' Theme API

Examples via PlayGround

Component examples can be created via the Playground component from @versionone/doc-components. Examples should exercise as many edge cases as possible. This enables comphrensive E2E testing of various aspects of a component in a single page/location.

Every package README.mdx should contain examples exercising all major edge cases of a component.

import { Playground } from '@versionone/doc-components';
import { TextField } from './src';

  <TextField fullWidth />
  <TextField disabled />

Optionally, a Playground can accept a function as its children. This provides a way to programitically setup the example:

  {() => {
    const options = ['option 1', 'option 2'];
    return <Select options={options} />;

Documenting the API

Documenting a component's API consists of a table of its props and a table with its theme definition. This is accompolished via propTypes (with comment descriptions), defaultProps, and themeDefinition propTypes.

all content driving the API documentation are pulled from the component's source file

Component Source API Example

const TextField = ({ value }) => <input type="text" value={value} />;

MyComponent.propTypes = {
  /** Current value. */
  value: PropTypes.node,
MyComponent.defaultProps = {
  color: 'blue',
  value: 'World',
MyComponent.themeDefinition = {
  /** Background color of the component. */
  background: PropTypes.string,

With the API information documented in the component's source code, we can display this information with the PropsTable and ThemeDefinitionTable components exported from @versionone/doc-components.

## API

<PropsTable of={TextField} />

## Theme API

<ThemeDefinitionTable of={TextField} />