Pagination
<gcds-pagination>

Autres noms : index de pages, navigation de pages.

La pagination est un composant de navigation qui répartit un contenu sur plusieurs pages liées.

• GitHub
• Figma

Sur cette page

• Codage et accessibilité de pagination
• Exemples
• Générateur de code

Codage et accessibilité de pagination

Configurez la pagination simple

Utilisez la pagination simple lorsque le nombre de pages est peu important.

• Réglez l’attribut display sur simple.
• Définissez l’URL de la page précédente à l’aide de l’attribut previous-href.
• Définissez le libellé de la page précédente à l’aide de l’attribut previous-label.
• Définissez l’URL de la page suivante à l’aide de l’attribut next-href.
• Définissez le libellé de la page suivante à l’aide de l’attribut next-label.

Configurez la pagination sous forme de liste

Utilisez la pagination sous forme de liste si votre contenu est étendu sur un plus grand nombre de pages.

• Réglez l’attribut display sur list.
• Définissez le nombre total de pages pour votre séquence à l’aide de l’attribut total-pages en utilisant un nombre.
• Définissez la page actuelle ou active à l’aide de l’attribut current-page en utilisant un nombre.
• Choisissez d’utiliser l’attribut url pour fournir au composant un groupe de liens de pages. Il peut s’agir d’un objet si vous travaillez dans un environnement JS ou d’une chaîne si vous utilisez HTML.

Appliquez l’objet de l’URL pour la pagination sous forme de liste.

Utilisez l’objet url pour générer les chaînes de requête et les fragments pour les liens de la pagination sous forme de liste.

url = {
  queryStrings: {
    // Key value pairs
    key: value,
  },
  fragment: string, // Target id
};

Pour modifier la valeur en fonction du lien de page visualisé, ajoutez les modificateurs ::offset ou ::match à une clé dans l’objet queryStrings.

::offset entame le décompte depuis la valeur donnée en commençant par le lien de la deuxième page.

url = {
  queryStrings: {
    'index::offset': 100,
  },
};

Utilisez ::match pour le lien de page actuellement visualisée afin de multiplier ce dernier par la valeur fournie.

url = {
  queryStrings: {
    'page::match': 1,
  },
};

Utilisez ::offset ou ::match pour permettre l’injection d’un nombre dans une chaîne. Utilisez {{#}} pour que l’élément modificateur injecte le nombre modifié en fonction de la méthode de comptage dans la chaîne au moment de la visualisation.

url = {
  queryStrings: {
    'index::offset': 'index_{{100}}',
    'page::match': 'page_{{1}}',
  },
};

Dans cette section

• Attributs essentiels
• Attributs facultatifs

label

L'attribut label définit le texte qui identifie le repère de navigation de la pagination, lui donnant un nom clair et accessible.

<gcds-pagination label="pagination sous forme de liste" total-pages="15" current-page="9" lang="fr">
</gcds-pagination>

current-page

L'attribut current-page définit la page actuelle pour une pagination en liste.

<gcds-pagination label="pagination sous forme de liste" total-pages="15" current-page="9" lang="fr">
</gcds-pagination>

display

L'attribut display définit le style d'affichage de la pagination. Les options sont :

• list (par défaut)
• simple

<gcds-pagination label="pagination sous forme de liste" display="list" total-pages="15" current-page="9">
</gcds-pagination>

next-href

L'attribut next-href définit l'URL de la page suivante pour une pagination simple.

<gcds-pagination label="pagination simple" display="simple" previous-href="#" next-href="#" previous-label="Titre de la page" next-label="3 de 3" lang="fr">
</gcds-pagination>

next-label

L'attribut next-label définit le libellé de la page suivante pour une pagination simple.

<gcds-pagination label="pagination simple" display="simple" previous-href="#" next-href="#" previous-label="Titre de la page" next-label="3 de 3" lang="fr">
</gcds-pagination>

previous-href

L'attribut previous-href définit l'URL de la page précédente pour une pagination simple.

<gcds-pagination label="pagination simple" display="simple" previous-href="#" next-href="#" previous-label="Titre de la page" next-label="3 de 3" lang="fr">
</gcds-pagination>

previous-label

L'attribut previous-label définit le libellé de la page précédente pour une pagination simple.

<gcds-pagination label="pagination simple" display="simple" previous-href="#" next-href="#" previous-label="Titre de la page" next-label="3 de 3" lang="fr">
</gcds-pagination>

total-pages

L'attribut total-pages définit le nombre total de pages pour une pagination en liste.

<gcds-pagination label="pagination sous forme de liste" total-pages="15" current-page="9" lang="fr">
</gcds-pagination>

url

L'attribut url définit l'objet (en JavaScript) ou la chaîne (en HTML) qui génère les chaînes de requête et le fragment pour les liens de pagination en liste.

<gcds-pagination label="pagination sous forme de liste" total-pages="15" current-page="9" url='{"queryStrings": { "querystring::offset": 10 }, "fragment": "main" }'>
</gcds-pagination>

Générateur de code

Générez une version du composant dont vous avez besoin en sélectionnant les propriétés de code correspondantes ou explorez les possibilités en choisissant différentes valeurs de code.

1. Choisissez des valeurs de code pour obtenir l'élément que vous voulez.

2. Obtenez le code et intégrez-le dans votre environnement.

3. Ajoutez tout contenu nécessaire au composant (comme le texte du libellé).

Remarque : Conformément à la pratique courante, le générateur de code utilise l'anglais pour tous les éléments de code.