File size: 1,966 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# Action Card
This is a [`Card` component](../../components/card) that has a call-to-action button.
## Usage
```jsx
import ActionCard from 'calypso/components/action-card';
function render() {
return (
<ActionCard
headerText="Header"
mainText="Some text"
className={ clsx( 'my-classname-1', 'my-classname-2' ) }
buttonText="Call to action!"
buttonIcon="external"
buttonPrimary
buttonHref="https://wordpress.com"
buttonTarget="_blank"
buttonOnClick={ noop }
buttonDisabled={ false }
/>
);
}
```
## Props
### `headerText`
- **Type:** `Node`
- **Required:** `yes`
Header text of the card
### `mainText`
- **Type:** `Node`
- **Required:** `yes`
Text that describes the header
### `classNames`
- **Type:** `Object`
- **Required:** `no`
- **Default:** `{}`
Class names to append to the Card
### `buttonText`
- **Type:** `String`
- **Required:** `yes`
Label for the call to action button
### `buttonIcon`
- **Type:** `String`
- **Required:** `no`
- **Default:** `undefined`
GridIcon name to place on the button
### `buttonPrimary`
- **Type:** `bool`
- **Required:** `no`
- **Default:** `undefined`
Whether pass true to the button's primary attribute
### `buttonHref`
- **Type:** `String`
- **Required:** `no`
- **Default:** `undefined`
Href to pass to the button
### `buttonTarget`
- **Type:** `String`
- **Required:** `no`
- **Default:** `undefined`
Button target, to use in conjunction with `buttonHref`
### `buttonOnClick`
- **Type:** `Function`
- **Required:** `no`
- **Default:** `undefined`
Button onClick handler
### `buttonDisabled`
- **Type:** `Boolean`
- **Required:** `no`
- **Default:** `false`
Make the button disabled.
### `compact`
- **Type:** `Boolean`
- **Required:** `no`
- **Default:** `true`
Determines whether or not this is a compact card
### `illustration`
- **Type:** `String`
- **Required:** `no`
- **Default:** `undefined`
The URL of an illustration to show on the card
|