woocommerce/plugins/woocommerce-admin/client/components/order-status/README.md

23 lines
386 B
Markdown
Raw Normal View History

OrderStatus
============
Use `OrderStatus` to display a badge with human-friendly text describing the current order status.
## How to use:
```jsx
import OrderStatus from 'components/order-status';
render: function() {
return (
<OrderStatus
order={ order }
/>
);
}
```
## Props
* `order` (required): The order to display a status for.
* `className`: Additional CSS classes.