Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: better card docs #72

Merged
merged 2 commits into from
Aug 8, 2024
Merged

docs: better card docs #72

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6852fc5
docs: better card docs
Carl-J-M Jul 10, 2024
6293cb1
docs: improve card docs
Carl-J-M Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions components/canvas/Card/About.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { Meta, Title, Primary, Controls, Stories } from '@storybook/blocks';
import * as CardStories from './Card.stories';


<Meta of={CardStories}/>


## Quickstart guide

The Card component is a simple wrapper, with a single slot for presenting content.

```html
<diamond-card>
<slot>
</diamond-card>
```

## Interactive

The interactive `diamond-card` is a regular `diamond-card` element with a wrapper as shown in the examples below. Interactive cards are keyboard focusable, and have an associated action when triggered.

We have two types of interactive card, either wrap the `diamond-card` element with an `a` or an `button` tag.

### Anchor
<a href="https://etch.co" rel="noopener noreferrer" target="_blank">
<diamond-card border>
<h3>Card title</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.
</p>
</diamond-card>
</a>

```html
<a href="https://etch.co" rel="noopener noreferrer" target="_blank">
<diamond-card border>
<h3>Card title</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.
</p>
</diamond-card>
</a>
```

### Button

<button type="button">
<diamond-card border>
<h3>Card title</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.
</p>
</diamond-card>
</button>

```html
<button type="button">
<diamond-card border>
<h3>Card title</h3>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.
</p>
</diamond-card>
</button>
```

4 changes: 4 additions & 0 deletions components/canvas/Card/Card.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { html } from 'lit';
import '../../composition/Grid/Grid';
import '../../composition/Grid/GridItem';
import './Card';
import Guide from './About.mdx';

export default {
component: 'diamond-card',
Expand All @@ -30,6 +31,9 @@ export default {
'none',
],
},
docs: {
page: Guide,
},
},
};

Expand Down