Skip to content

Commit 2aa65f8

Browse files
committed
Update README.md
1 parent 6ae0d12 commit 2aa65f8

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

src/components/ChangelogSnippet/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,14 @@ const item: ChangelogItem = {
6464

6565
## Props
6666

67-
| Prop | Type | Required | Default | Description |
68-
| ---------------- | ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
69-
| `item` | ChangelogItem | Yes | - | The changelog item to display |
70-
| `showBorder` | boolean | No | `true` | Whether to show a border around the card |
71-
| `autoExpand` | boolean | No | `false` | Whether to automatically expand the card to full height (skips height restrictions and hides expand/collapse button) |
72-
| `showCopyButton` | boolean | No | `true` | Whether to show the "Copy URL" button |
73-
| `disableHover` | boolean | No | `false` | Whether to disable hover effects (background color change) |
67+
| Prop | Type | Required | Default | Description |
68+
| ---------------------- | ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
69+
| `item` | ChangelogItem | Yes | - | The changelog item to display |
70+
| `showBorder` | boolean | No | `true` | Whether to show a border around the card |
71+
| `autoExpand` | boolean | No | `false` | Whether to automatically expand the card to full height (skips height restrictions and hides expand/collapse button) |
72+
| `showCopyButton` | boolean | No | `true` | Whether to show the "Copy URL" button |
73+
| `disableHover` | boolean | No | `false` | Whether to disable hover effects (background color change and card padding) |
74+
| `showNetworksAndTopic` | boolean | No | `false` | Whether to show the networks icons and topic chip above the title |
7475

7576
## Usage Examples
7677

@@ -91,3 +92,9 @@ const item: ChangelogItem = {
9192
```astro
9293
<ChangelogCard item={changelogItem} showBorder={false} autoExpand={true} showCopyButton={false} disableHover={true} />
9394
```
95+
96+
### Card with networks and topic displayed
97+
98+
```astro
99+
<ChangelogCard item={changelogItem} showNetworksAndTopic={true} />
100+
```

0 commit comments

Comments
 (0)