woocommerce/plugins/woocommerce-admin/client/components/gravatar
Kelly Dwan d36511479e Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336)
* Switch all components to default exports

This ensures we can read all components for documentation generation (plus, standardizing is good)

* Add documentation to component file

* Fix table exports

* Move readme docs into inline docs

Includes updating new props, adding prop shapes

* Add doc-generation scripts to pull exported component docs into folder

* Remove key propType, causing react special-keys warning

* Fix proptype

* Update incorrect comment

* Remove template import, we can just use string concat

* Fix typo, update docs
2018-08-31 13:27:21 -04:00
..
test Add Gravatar Component (https://github.com/woocommerce/woocommerce-admin/pull/188) 2018-07-11 13:06:26 -04:00
README.md Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336) 2018-08-31 13:27:21 -04:00
index.js Docs Project: Add documentation parser + inline documentation (https://github.com/woocommerce/woocommerce-admin/pull/336) 2018-08-31 13:27:21 -04:00
style.scss Add Gravatar Component (https://github.com/woocommerce/woocommerce-admin/pull/188) 2018-07-11 13:06:26 -04:00

README.md

Gravatar

Use Gravatar to display a user's Gravatar.

How to use:

import Gravatar from 'components/gravatar';

render: function() {
  return (
    <Gravatar
		user="email@example.org"
		size={ 48 }
	/>
  );
}

Props

  • user: The address to hash for displaying a Gravatar. Can be an email address or WP-API user object.
  • size: Default 60. The size of Gravatar to request.
  • alt: Text to display as the image alt attribute.
  • title: Text to use for the image's title
  • className: Additional CSS classes.