Skip to content

Commit

Permalink
Merge pull request #1275 from interactivellama/icon-settings-single-node
Browse files Browse the repository at this point in the history
Document child nodes of IconSettings
  • Loading branch information
futuremint committed Feb 14, 2018
2 parents 89678df + 82405ce commit 6d9abc5
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions components/icon-settings/index.jsx
Expand Up @@ -7,8 +7,7 @@ import PropTypes from 'prop-types';
import { ICON_SETTINGS } from '../../utilities/constants';

/**
* The Icon Settings component allows for the path to the icons to be specified.
* This should be used at the root of the application.
* The Icon Settings component allows for the path to the icons to be specified in all child components and is recommended to be used at the root of the application. It's render function is `return this.props.children`, so it can only have one child node.
*
* **Individual sprites**
* If you are using webpack it is advised to use the sprite properties
Expand Down

0 comments on commit 6d9abc5

Please sign in to comment.