woocommerce/plugins/woocommerce-admin/docs/components/flag.md

53 lines
657 B
Markdown

`Flag` (component)
==================
Use the `Flag` component to display a country's flag.
Props
-----
### `code`
- Type: String
- Default: null
Two letter, three letter or three digit country code.
### `order`
- Type: Object
- Default: null
An order can be passed instead of `code` and the code will automatically be pulled from the billing or shipping data.
### `round`
- Type: Boolean
- Default: `true`
True to display a rounded flag.
### `height`
- Type: Number
- Default: `24`
Flag image height.
### `width`
- Type: Number
- Default: `24`
Flag image width.
### `className`
- Type: String
- Default: null
Additional CSS classes.