diff --git a/packages/venia-ui/lib/components/MediaIcons/__tests__/__snapshots__/mediaIcons.spec.js.snap b/packages/venia-ui/lib/components/MediaIcons/__tests__/__snapshots__/mediaIconGroup.spec.js.snap similarity index 100% rename from packages/venia-ui/lib/components/MediaIcons/__tests__/__snapshots__/mediaIcons.spec.js.snap rename to packages/venia-ui/lib/components/MediaIcons/__tests__/__snapshots__/mediaIconGroup.spec.js.snap diff --git a/packages/venia-ui/lib/components/MediaIcons/__tests__/mediaIcons.spec.js b/packages/venia-ui/lib/components/MediaIcons/__tests__/mediaIconGroup.spec.js similarity index 100% rename from packages/venia-ui/lib/components/MediaIcons/__tests__/mediaIcons.spec.js rename to packages/venia-ui/lib/components/MediaIcons/__tests__/mediaIconGroup.spec.js diff --git a/packages/venia-ui/lib/components/MediaIcons/mediaIconGroup.js b/packages/venia-ui/lib/components/MediaIcons/mediaIconGroup.js index 584a83c42f..77e039c96a 100644 --- a/packages/venia-ui/lib/components/MediaIcons/mediaIconGroup.js +++ b/packages/venia-ui/lib/components/MediaIcons/mediaIconGroup.js @@ -9,6 +9,16 @@ import {object, string, number, shape} from 'prop-types'; import {mergeClasses} from '../../classify'; import defaultClasses from './mediaIconGroup.css'; +/** + * A component that renders social media icons in the footer. + * + * @typedef MediaIconGroup + * @kind functional component + * + * @param {props} props React component props + * + * @returns {React.Element} A React component that displays social media icons in the footer. + */ const MediaIconGroup = props => { const {links, height, width} = props; const classes = mergeClasses(defaultClasses, props.classes); @@ -59,6 +69,21 @@ const MediaIconGroup = props => { ); }; +/** + * Props for {@link MediaIconGroup} + * + * @typedef props + * + * @property {Object} classes An object containing the class names for the + * MediaIconGroup component. + * @property {string} classes.facebookLogoClass class for facebook icon + * @property {string} classes.instagramLogoClass class for instagram icon + * @property {string} classes.twitterLogoClass class for twitter icon + * @property {string} classes.youtubeLogoClass class for youtube icon + * @property {object} links for filling the href attribute for an icon + * @property {number} height the height of the icons. + * @property {number} width the height of the icons. + */ MediaIconGroup.propTypes = { classes: shape({ facebookLogoClass: string,