Skip to content

Commit

Permalink
chore: document slots
Browse files Browse the repository at this point in the history
  • Loading branch information
marvel-uiuc committed Jul 17, 2024
1 parent fb2552a commit 3e32762
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,18 @@ several variations:

- The top of the card can have an image using `slot="image"`, or an icon using `slot="icon"`.
- The whole card can be made clickable using the attribute `clickable`.
- Text content can be centered using the `centered` attribute.
- Text content can be centered using `align="center"`.
- Color themes for `gray`, `blue`, `orange`, `blue-gradient` and `orange-gradient`. For example, `theme="blue"`.

### Slots

| Slot | Description |
|-----------------|--------------------------------------------------------------------------------------------|
| `slot="image"` | Placed full-width at the top of the card with a roughly 16:10 aspect ratio. |
| `slot="icon"` | Centered at the top of the card with ample spacing. |
| `slot="footer"` | Content remains at the bottom of the card when the card is stretched to fit a larger area. |


## Code Examples

### Basic card with buttons
Expand Down

0 comments on commit 3e32762

Please sign in to comment.