woocommerce/plugins/woocommerce-admin/client/components/count
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
..
README.md Add a label to Count to add context for screen reader users (https://github.com/woocommerce/woocommerce-admin/pull/102) 2018-06-01 10:39:48 -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 CSS naming conventions following Gutenberg’s standards (https://github.com/woocommerce/woocommerce-admin/pull/99) 2018-06-01 10:35:18 -04:00

README.md

Count

Display a number with a styled border

Usage

import Count from 'components/count';

export default function myCount() {
	return (
		<Count count={ 33 } />
	);
}

Props

  • Marks required props
Name Type Default Description
count* number none Value of the number to be displayed
label string "Total {props.count}" A translated label with the number in context, used for screen readers