Skip to content

Commit

Permalink
Merge branch 'main' into hd-i18n-fr-0-28-0-components-icons
Browse files Browse the repository at this point in the history
  • Loading branch information
HiDeoo committed Sep 20, 2024
2 parents 447e284 + 70e7e79 commit b434366
Show file tree
Hide file tree
Showing 16 changed files with 982 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/src/content/docs/components/link-buttons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Configuration Reference

</Preview>

### Add icons to cards
### Add icons to link buttons

Include an icon in a link button using the [`icon`](#icon) attribute set to the name of [one of Starlight’s built-in icons](/reference/icons/#all-icons).

Expand Down
181 changes: 181 additions & 0 deletions docs/src/content/docs/fr/components/card-grids.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
---
title: Grilles de cartes
description: Apprenez à regrouper plusieurs cartes dans une grille dans Starlight.
sidebar:
order: 4
---

import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';

Pour regrouper plusieurs composants [`<Card>`](/fr/components/cards/) ou [`<LinkCard>`](/fr/components/link-cards/) dans une grille, utilisez le composant `<CardGrid>`.

import Preview from '~/components/component-preview.astro';

<Preview>

<CardGrid slot="preview">
<Card title="Étoiles" icon="star">
Sirius, Véga, Bételgeuse
</Card>
<Card title="Lunes" icon="moon">
Io, Europe, Ganymède
</Card>
</CardGrid>

</Preview>

## Import

```tsx
import { CardGrid } from '@astrojs/starlight/components';
```

## Utilisation

### Grouper des cartes

Affichez plusieurs composants [`<Card>`](/fr/components/cards/) côte à côte lorsqu'il y a suffisamment d'espace en les regroupant à l'aide du composant `<CardGrid>`.

<Preview>

```mdx {3,10}
import { Card, CardGrid } from '@astrojs/starlight/components';

<CardGrid>
<Card title="Regardez-ça" icon="open-book">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>
<Card title="Et autre chose" icon="information">
Plus d'informations que vous souhaitez partager.
</Card>
</CardGrid>
```

<Fragment slot="markdoc">

```markdoc {1,9}
{% cardgrid %}
{% card title="Regardez-ça" icon="open-book" %}
Contenu intéressant que vous souhaitez mettre en évidence.
{% /card %}
{% card title="Et autre chose" icon="information" %}
Plus d'informations que vous souhaitez partager.
{% /card %}
{% /cardgrid %}
```

</Fragment>

<CardGrid slot="preview">
<Card title="Regardez-ça" icon="open-book">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>
<Card title="Et autre chose" icon="information">
Plus d'informations que vous souhaitez partager.
</Card>
</CardGrid>

</Preview>

### Grouper des cartes de liaison

Affichez plusieurs composants [`<LinkCard>`](/fr/components/link-cards/) côte à côte lorsqu'il y a suffisamment d'espace en les regroupant à l'aide du composant `<CardGrid>`.

<Preview>

```mdx {3,9}
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

<CardGrid>
<LinkCard
title="Création de contenu en Markdown"
href="/fr/guides/authoring-content/"
/>
<LinkCard title="Composants" href="/fr/components/using-components/" />
</CardGrid>
```

<Fragment slot="markdoc">

```markdoc {1,7}
{% cardgrid %}
{% linkcard
title="Création de contenu en Markdown"
href="/fr/guides/authoring-content/" /%}
{% linkcard title="Composants" href="/fr/components/using-components/" /%}
{% /cardgrid %}
```

</Fragment>

<CardGrid slot="preview">
<LinkCard
title="Création de contenu en Markdown"
href="/fr/guides/authoring-content/"
/>
<LinkCard title="Composants" href="/fr/components/using-components/" />
</CardGrid>

</Preview>

### Décaler des cartes

Décalez la deuxième colonne de la grille verticalement pour ajouter un intérêt visuel en ajoutant l'attribut [`stagger`](#stagger) au composant `<CardGrid>`.

Cet attribut est utile sur votre page d'accueil pour afficher les principales fonctionnalités de votre projet.

<Preview>

```mdx "stagger"
import { Card, CardGrid } from '@astrojs/starlight/components';

<CardGrid stagger>
<Card title="Regardez-ça" icon="open-book">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>
<Card title="Et autre chose" icon="information">
Plus d'informations que vous souhaitez partager.
</Card>
</CardGrid>
```

<Fragment slot="markdoc">

```markdoc "stagger=true"
{% cardgrid stagger=true %}
{% card title="Regardez-ça" icon="open-book" %}
Contenu intéressant que vous souhaitez mettre en évidence.
{% /card %}
{% card title="Et autre chose" icon="information" %}
Plus d'informations que vous souhaitez partager.
{% /card %}
{% /cardgrid %}
```

</Fragment>

<CardGrid slot="preview" stagger>
<Card title="Regardez-ça" icon="open-book">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>
<Card title="Et autre chose" icon="information">
Plus d'informations que vous souhaitez partager.
</Card>
</CardGrid>

</Preview>

## Props de `<CardGrid>`

**Implémentation :** [`CardGrid.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/CardGrid.astro)

Le composant `<CardGrid>` accepte les props suivantes :

### `stagger`

**Type :** `boolean`

Définit si les cartes de la grille doivent être décalées ou non.
110 changes: 110 additions & 0 deletions docs/src/content/docs/fr/components/cards.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: Cartes
description: Apprenez à utiliser des cartes dans Starlight pour afficher du contenu dans un cadre.
sidebar:
order: 2
---

import { Card } from '@astrojs/starlight/components';

Pour afficher du contenu dans un cadre correspondant aux styles de Starlight, utilisez le composant `<Card>`.

import Preview from '~/components/component-preview.astro';

<Preview>

<Card slot="preview" title="Lunes" icon="moon">
Io, Europe, Ganymède
</Card>

</Preview>

## Import

```tsx
import { Card } from '@astrojs/starlight/components';
```

## Utilisation

Affichez une carte en utilisant le composant `<Card>` et fournissez un titre à la carte en utilisant la propriété [`title`](#title).

<Preview>

```mdx
import { Card } from '@astrojs/starlight/components';

<Card title="Regardez-ça">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>
```

<Fragment slot="markdoc">

```markdoc
{% card title="Regardez-ça" %}
Contenu intéressant que vous souhaitez mettre en évidence.
{% /card %}
```

</Fragment>

<Card slot="preview" title="Regardez-ça">
Contenu intéressant que vous souhaitez mettre en évidence.
</Card>

</Preview>

### Ajouter des icônes aux cartes

Incluez une icône dans une carte en utilisant l'attribut [`icon`](#icon) défini avec le nom de [l'une des icônes intégrées à Starlight](/fr/reference/icons/#toutes-les-icônes).

<Preview>

```mdx 'icon="star"'
import { Card } from '@astrojs/starlight/components';

<Card title="Étoiles" icon="star">
Sirius, Véga, Bételgeuse
</Card>
```

<Fragment slot="markdoc">

```markdoc 'icon="star"'
{% card title="Étoiles" icon="star" %}
Sirius, Véga, Bételgeuse
{% /card %}
```

</Fragment>

<Card slot="preview" title="Étoiles" icon="star">
Sirius, Véga, Bételgeuse
</Card>

</Preview>

### Grouper des cartes

Affichez plusieurs cartes côte à côte lorsqu'il y a suffisamment d'espace en les regroupant à l'aide du composant [`<CardGrid>`](/fr/components/card-grids/).
Consultez le guide [« Grouper des cartes »](/fr/components/card-grids/#grouper-des-cartes) pour un exemple.

## Props de `<Card>`

**Implémentation :** [`Card.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Card.astro)

Le composant `<Card>` accepte les props suivantes :

### `title`

**Obligatoire**
**Type :** `string`

Le titre de la carte à afficher.

### `icon`

**Type :** `string`

Une carte peut inclure un attribut `icon` défini avec le nom de [l'une des icônes intégrées à Starlight](/fr/reference/icons/#toutes-les-icônes).
Loading

0 comments on commit b434366

Please sign in to comment.