ButtonIcon

Le composant bouton icône est principalement conçu pour les actions secondaires.

Utilisation

Importez le composant :

import 'mdui/components/button-icon.js';

Importez le type TypeScript correspondant :

import type { ButtonIcon } from 'mdui/components/button-icon.js';

Exemple d'utilisation :

<mdui-button-icon icon="search"></mdui-button-icon>

Exemples

Icône

Utilisez l'attribut icon pour spécifier le nom d'une icône Material Icons. Vous pouvez aussi fournir une icône dans le slot par défaut.

<mdui-button-icon icon="search"></mdui-button-icon>
<mdui-button-icon>
  <mdui-icon name="search"></mdui-icon>
</mdui-button-icon>

Source

Variante

Utilisez l'attribut variant pour définir la variante du bouton icône.

<mdui-button-icon variant="standard" icon="search"></mdui-button-icon>
<mdui-button-icon variant="filled" icon="search"></mdui-button-icon>
<mdui-button-icon variant="tonal" icon="search"></mdui-button-icon>
<mdui-button-icon variant="outlined" icon="search"></mdui-button-icon>

Source

Sélectionnable

Ajoutez l'attribut selectable pour rendre le bouton icône sélectionnable.

<mdui-button-icon selectable icon="favorite_border"></mdui-button-icon>

Source

Utilisez l'attribut selected-icon pour spécifier le nom de l'icône Material Icons à afficher lorsqu'il est sélectionné. Vous pouvez également utiliser le slot selected-icon.

<mdui-button-icon selectable icon="favorite_border" selected-icon="favorite"></mdui-button-icon>
<mdui-button-icon selectable icon="favorite_border">
  <mdui-icon slot="selected-icon" name="favorite"></mdui-icon>
</mdui-button-icon>

Source

Lorsque le bouton icône est sélectionné, l'attribut selected passe à true. Vous pouvez également le présélectionner en ajoutant l'attribut selected.

<mdui-button-icon selectable selected icon="favorite_border" selected-icon="favorite"></mdui-button-icon>

Source

Lien

Ajoutez l'attribut href pour utiliser le bouton icône comme un lien. Les attributs liés aux liens (download, target, rel) sont alors également disponibles.

<mdui-button-icon icon="search" href="https://www.mdui.org" target="_blank"></mdui-button-icon>

Source

États désactivé et chargement

Ajoutez l'attribut disabled pour désactiver le bouton icône ; ajoutez l'attribut loading pour lui appliquer un état de chargement.

<mdui-button-icon disabled icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading icon="search" variant="tonal"></mdui-button-icon>
<mdui-button-icon loading disabled icon="search" variant="tonal"></mdui-button-icon>

Source

API

Propriétés

Attribut HTML	Propriété JavaScript	Type	Défaut
`variant`	`variant`	`'standard' \| 'filled' \| 'tonal' \| 'outlined'`	`'standard'`
Forme du bouton icône. Les valeurs possibles incluent : `standard` : Adapté aux actions de la plus basse priorité `filled` : Effet visuel fort, adapté aux actions de haute priorité `tonal` : Effet visuel entre `filled` et `outlined`, adapté aux actions de priorité moyenne à élevée `outlined` : Adapté aux actions de priorité moyenne
`icon`	`icon`	`string`	-
Nom de l'icône Material Icons. Peut également être défini via le slot par défaut.
`selected-icon`	`selectedIcon`	`string`	-
Nom de l'icône Material Icons pour l'état sélectionné. Peut également être défini via `slot="selected-icon"`.
`selectable`	`selectable`	`boolean`	`false`
Si le composant peut être sélectionné
`selected`	`selected`	`boolean`	`false`
Si le composant est actuellement sélectionné
`href`	`href`	`string`	-
URL cible du lien. Si cette propriété est définie, le composant sera rendu comme un élément `<a>` et pourra utiliser les attributs liés aux liens.
`download`	`download`	`string`	-
Nom du fichier à télécharger. Remarque : Cette propriété ne s'applique que si l'attribut `href` est défini.
`target`	`target`	`'_blank' \| '_parent' \| '_self' \| '_top'`	-
Cible d'ouverture du lien. Les valeurs possibles incluent : `_blank` : Ouvre le lien dans une nouvelle fenêtre `_parent` : Ouvre le lien dans le contexte parent `_self` : Par défaut. Ouvre le lien dans le contexte courant `_top` : Ouvre le lien dans toute la fenêtre Remarque : Cette propriété ne s'applique que si l'attribut `href` est défini.
`rel`	`rel`	`'alternate' \| 'author' \| 'bookmark' \| 'external' \| 'help' \| 'license' \| 'me' \| 'next' \| 'nofollow' \| 'noreferrer' \| 'opener' \| 'prev' \| 'search' \| 'tag'`	-
Relation entre le document actuel et le document lié. Les valeurs possibles incluent : `alternate` : Version alternative du document actuel `author` : Auteur du document actuel ou de l'article `bookmark` : Lien permanent vers la section ancêtre la plus proche `external` : Le document référencé n'est pas sur le même site que le document actuel `help` : Lien vers un document d'aide associé `license` : Le contenu principal du document actuel est couvert par la licence de droits d'auteur du fichier référencé `me` : Le document actuel représente le propriétaire du contenu lié `next` : Le document actuel fait partie d'une série, le document référencé est le suivant dans la série `nofollow` : L'auteur ou l'éditeur du document actuel n'approuve pas le fichier référencé `noreferrer` : N'inclut pas l'en-tête `Referer`. Effet similaire à `noopener` `opener` : Si l'hyperlien crée un contexte de navigation de premier niveau (c'est-à-dire que la valeur de l'attribut `target` est `_blank`), crée un contexte de navigation auxiliaire `prev` : Le document actuel fait partie d'une série, le document référencé est le précédent dans la série `search` : Fournit un lien vers une ressource pouvant être utilisée pour rechercher le fichier actuel et ses pages associées `tag` : Fournit une balise (identifiée par l'adresse donnée) applicable au document actuel Remarque : Disponible uniquement lorsque l'attribut `href` est spécifié.
`autofocus`	`autofocus`	`boolean`	`false`
Si le focus doit être automatiquement obtenu après le chargement de la page
`tabindex`	`tabIndex`	`number`	-
Ordre de l'élément lors de la navigation au clavier avec la touche Tab
`disabled`	`disabled`	`boolean`	`false`
Si le composant est désactivé
`loading`	`loading`	`boolean`	`false`
Si le composant est en état de chargement
`name`	`name`	`string`	`''`
Nom du bouton, qui sera envoyé avec les données du formulaire. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas défini.
`value`	`value`	`string`	`''`
Valeur initiale du bouton, qui sera envoyée avec les données du formulaire. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas défini.
`type`	`type`	`'submit' \| 'reset' \| 'button'`	`'button'`
Type du bouton. Par défaut, il s'agit de `button`. Les valeurs possibles incluent : `submit` : Au clic sur le bouton, les données du formulaire sont envoyées au serveur `reset` : Au clic sur le bouton, tous les champs du formulaire sont réinitialisés à leurs valeurs initiales `button` : Ce type de bouton n'a pas de comportement par défaut Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas spécifié.
`form`	`form`	`string`	-
Élément `<form>` associé. La valeur de cet attribut doit être l'`id` d'un élément `<form>` dans la même page. Si cet attribut n'est pas spécifié, l'élément doit être un enfant de l'élément `<form>`. Grâce à cet attribut, vous pouvez placer l'élément n'importe où sur la page, y compris hors de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas spécifié.
`formaction`	`formAction`	`string`	-
Spécifie l'URL de soumission du formulaire. Si cet attribut est spécifié, il remplace l'attribut `action` de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas spécifié et que `type="submit"`.
`formenctype`	`formEnctype`	`'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'`	-
Spécifie le type de contenu à utiliser pour soumettre le formulaire au serveur. Les valeurs possibles incluent : `application/x-www-form-urlencoded` : Valeur par défaut si l'attribut n'est pas spécifié `multipart/form-data` : À utiliser lorsque le formulaire contient un élément `<input type="file">` `text/plain` : Nouveau dans HTML5, utilisé pour le débogage Si cet attribut est spécifié, il remplace l'attribut `enctype` de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas spécifié et que `type="submit"`.
`formmethod`	`formMethod`	`'post' \| 'get'`	-
Spécifie la méthode HTTP à utiliser pour soumettre le formulaire. Les valeurs possibles incluent : `post` : Les données du formulaire sont incluses dans le corps de la requête et envoyées au serveur `get` : Les données du formulaire sont ajoutées à l'URI du formulaire avec `?` comme séparateur, et l'URI résultante est envoyée au serveur. À utiliser lorsque le formulaire n'a pas d'effets secondaires et ne contient que des caractères ASCII Si cet attribut est défini, il remplace l'attribut `method` de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas défini et que `type="submit"`.
`formnovalidate`	`formNoValidate`	`boolean`	`false`
Quand il est activé, la validation du formulaire n'est pas effectuée lors de la soumission. Si cet attribut est défini, il remplace l'attribut `novalidate` de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas défini et que `type="submit"`.
`formtarget`	`formTarget`	`'_self' \| '_blank' \| '_parent' \| '_top'`	-
Où afficher la réponse après l'envoi du formulaire. Les valeurs possibles incluent : `_self` : Option par défaut, ouvre dans le contexte courant `_blank` : Ouvre dans une nouvelle fenêtre `_parent` : Ouvre dans le contexte parent `_top` : Ouvre dans toute la fenêtre Si cet attribut est défini, il remplace l'attribut `target` de l'élément `<form>`. Remarque : Cette propriété ne s'applique que si l'attribut `href` n'est pas défini et que `type="submit"`.
	`validity`	`ValidityState`	-
État de validation du formulaire, voir `ValidityState` pour plus de détails
	`validationMessage`	`string`	-
Si la validation du formulaire échoue, cet attribut contient un message d'erreur. Si la validation réussit, cet attribut est une chaîne vide

Méthodes

Nom	Paramètres	Valeur de retour
`click`		`void`
Simule un clic sur l'élément
`focus`	`options: FocusOptions` (Optionnel)	`void`
Place le focus sur l'élément. Vous pouvez passer un objet en paramètre, dont les propriétés incluent : `preventScroll` : Par défaut, après la prise de focus, la page défile pour amener l'élément à l'écran. Si vous ne souhaitez pas que la page défile, vous pouvez définir cette propriété sur `true`.
`blur`		`void`
Retire le focus de l'élément
`checkValidity`		`boolean`
Vérifie si le champ du formulaire est valide. Dans le cas contraire, renvoie `false` et déclenche l'événement `invalid` ; sinon, renvoie `true`.
`reportValidity`		`boolean`
Vérifie si le champ du formulaire est valide. Dans le cas contraire, renvoie `false` et déclenche l'événement `invalid` ; sinon, renvoie `true`. Si la validation échoue, un message d'erreur s'affiche également sur le composant.
`setCustomValidity`	`message: string`	`void`
Définit un message d'erreur personnalisé. Tant qu'il n'est pas vide, le champ est considéré comme invalide.

Événements

Nom
`focus`
Se déclenche lorsque l'élément obtient le focus
`blur`
Se déclenche lorsque l'élément perd le focus
`change`
Se déclenche lorsque l'état de sélection change
`invalid`
Se déclenche lorsque la validation du champ du formulaire échoue

Slots

Nom
Défaut
Composant Icône
`selected-icon`
Élément d'icône affiché à l'état sélectionné

CSS Parts

Nom
`button`
Élément `<button>` ou `<a>` interne
`icon`
Icône à l'état non sélectionné
`selected-icon`
Icône à l'état sélectionné
`loading`
Élément `<mdui-circular-progress>` en état de chargement

Propriétés CSS personnalisées

Nom
`--shape-corner`
Taille des coins arrondis du composant. Vous pouvez spécifier une valeur de pixel spécifique ; mais il est préférable de se référer au Design Tokens.

Chapitre précédent

Button

Chapitre suivant

Card