Skip to content

Commit 5582082

Browse files
author
Josh Habdas
committed
Adding DocBlock defaults for known Component props
1 parent cb22811 commit 5582082

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

docs/app/Components/ComponentDoc/ComponentProps.js

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
import _ from 'lodash';
22
import React, {Component, PropTypes} from 'react';
3-
import {Segment, Table, TableColumn} from 'stardust';
3+
import {Header, Segment, Table, TableColumn} from 'stardust';
4+
5+
const DOCBLOCK_DESCRIPTION_DEFAULTS = {
6+
children: 'Body of the component.',
7+
className: 'Class names for custom styling.',
8+
};
49

510
/**
611
* Displays a table of a Component's PropTypes.
@@ -34,7 +39,7 @@ export default class ComponentProps extends Component {
3439
const propsDefinition = this.props.props;
3540
const content = _.map(propsDefinition, (propConfig, propName) => {
3641
const name = propName;
37-
const description = _.get(propConfig, 'docBlock.description');
42+
const description = _.get(propConfig, 'docBlock.description') || DOCBLOCK_DESCRIPTION_DEFAULTS[name];
3843

3944
const value = _.get(propConfig, 'type.value');
4045
let type = _.get(propConfig, 'type.name');
@@ -58,7 +63,7 @@ export default class ComponentProps extends Component {
5863

5964
return (
6065
<Segment className='basic vertical'>
61-
<h2 className='ui header'>Props</h2>
66+
<Header.H2 className='ui header'>Props</Header.H2>
6267
<Table data={content} className='very basic'>
6368
<TableColumn dataKey='name' cellRenderer={this.nameRenderer} />
6469
<TableColumn dataKey='type' />

src/elements/Segment/Segment.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ export default class Segment extends Component {
1111
* Segment tag body content.
1212
*/
1313
children: PropTypes.node,
14-
/**
15-
* Class name for custom styling.
16-
*/
1714
className: PropTypes.string,
1815
/**
1916
* Optional segment heading.

src/elements/Segment/Segments.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,9 @@ import {ofComponentTypes} from 'src/utils/customPropTypes';
99
export default class Segments extends Component {
1010
static propTypes = {
1111
/**
12-
* Must be of type Segment, Segments, H1, H2, H3, H4, H5, H6, Subheading or Message.
12+
* Must be of type Segment, Segments, H1, H2, H3, H4, H5, H6, Subheader or Message.
1313
*/
1414
children: ofComponentTypes(['Segment', 'Segments', 'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'Subheader', 'Message']),
15-
/**
16-
* Class name for custom styling.
17-
*/
1815
className: PropTypes.string,
1916
};
2017

0 commit comments

Comments
 (0)