API jQuery UI - Widget Button

Catégorie

Widgets

Utilisation

Description :Boutons et ensembles de boutons personnalisables par thème.

Version ajoutée :1.8

Le widget Button améliore la fonctionnalité des éléments de formulaire standard, tels que les boutons, les champs de saisie et les ancres, afin de les thématiser avec des styles de survol et d'activation appropriés.

En plus des boutons de base, les boutons radio et les cases à cocher (types input radio et checkbox) peuvent également être convertis en boutons. L'étiquette associée est stylisée comme un bouton, et un clic dessus met à jour le champ de saisie sous-jacent. Pour que cela fonctionne correctement, le champ de saisie a besoin d'unidattribut, et il doit pointer vers celui du labelforattribut. Ne placez pas l'input à l'intérieur du label, sinon ilcausera des problèmes d'accessibilité。

Pour regrouper des boutons radio, Button fournit également un widget supplémentaire nommé Buttonset. Buttonset s'utilise en sélectionnant un élément conteneur (contenant les boutons radio) et en appelant.buttonset(). Buttonset fournit également un regroupement visuel, il peut donc être envisagé chaque fois qu'il y a un groupe de boutons. Il sélectionne tous les descendants et applique.button(). Vous pouvez activer et désactiver un buttonset, ce qui activera et désactivera tous les boutons contenus. Détruire un buttonset invoque, pour chaque bouton, sadestroyméthode. Pour des boutons radio et des boutons à cocher groupés, il est recommandé d'utiliser unlegenddefieldsetpour fournir un libellé de groupe accessible.

Lors de l'utilisation d'un input de type button, submit ou reset, seuls des libellés en texte brut sans icônes sont pris en charge.

Thèmes

Le widget Button utilise lejQuery UI CSS Frameworkpour définir le style de son apparence. Si vous devez utiliser des styles spécifiques aux boutons, vous pouvez utiliser les noms de classes CSS suivants :

  • ui-button: Représente l'élément DOM du bouton. Cet élément recevra l'une des classes suivantes en fonction de l'optiontexteticons:ui-button-text-only、ui-button-icon-only、ui-button-icons-only、ui-button-text-icons。
    • ui-button-icon-primary: L'élément utilisé pour afficher l'icône principale du bouton. Il est rendu uniquement lorsque l'icône principale est fournie dans l'optionicons.
    • ui-button-text: Le conteneur entourant le contenu textuel du bouton.
    • ui-button-icon-secondary: Utilisé pour afficher l’icône secondaire du bouton. Elle n’est affichée que lorsque l’icône secondaire est fournie dans l’optionicons.
  • ui-buttonset: Le conteneur externe du Buttonset.

Dépendances

Notes supplémentaires

  • Ce widget nécessite du CSS fonctionnel, sinon il ne fonctionnera pas. Si vous créez un thème personnalisé, utilisez le fichier CSS spécifique au widget comme point de départ.

Navigation rapide

Options Méthodes Événements

Options Type Description Default
disabled Boolean Si défini surtrue, le bouton est désactivé.

Exemples de code :

Initialiser le bouton avec les paramètres spécifiésdisabledoption:

$( ".selector" ).button({ disabled: true });
    

Après l'initialisation, obtenir ou définir l'disabledoption:

// getter
var disabled = $( ".selector" ).button( "option", "disabled" );
 
// setter
$( ".selector" ).button( "option", "disabled", true );
    
false
icônes Object Icônes à afficher, y compris les icônes avec texte et les icônes sans texte (voir l’textoption). Par défaut, l’icône primaire est affichée à gauche du texte du libellé, et l’icône secondaire est affichée à droite. La position d’affichage peut être contrôlée via CSS.

primaryetsecondaryLa valeur de l’attribut doit être unnom de classe d’icône, par exemple,"ui-icon-gear". Si une seule icône est utilisée, alorsicons: { primary: "ui-icon-locked" }. Si deux icônes sont utilisées, alorsicons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }。

Exemples de code :

Initialiser le bouton avec les paramètres spécifiésiconsoption:

$( ".selector" ).button({ icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" } });
    

Après l'initialisation, obtenir ou définir l'disabledoption:

// getter
var icons = $( ".selector" ).button( "option", "icons" );
 
// setter
$( ".selector" ).button( "option", "icons", { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" } );
    
{ primary: null, secondary: null }
label String Le texte à afficher dans le bouton. Lorsqu’il n’est pas spécifié (null), le contenu HTML de l’élément est utilisé, ou si l’élément est un élément input de type submit ou reset, savaluel'attribut est utilisé, ou si l'élément est un élément input de type radio ou checkbox, le contenu HTML de l'élément label associé est utilisé.

Exemples de code :

Initialiser le bouton avec les paramètres spécifiéslabeloption:

$( ".selector" ).button({ label: "custom label" });
    

Après l'initialisation, obtenir ou définir l'labeloption:

// getter
var label = $( ".selector" ).button( "option", "label" );
 
// setter
$( ".selector" ).button( "option", "label", "custom label" );
    
null
text Boolean Indique si l'étiquette doit être affichée. Lorsqu'il est défini surfalse, le texte n'est pas affiché, mais l'iconsoption doit être activée, sinon l'textoption sera ignorée.

Exemples de code :

Initialiser le bouton avec les paramètres spécifiéstextoption:

$( ".selector" ).button({ text: false });
    

Après l'initialisation, obtenir ou définir l'textoption:

// getter
var text = $( ".selector" ).button( "option", "text" );
 
// setter
$( ".selector" ).button( "option", "text", false );
    
vrai

Méthodes Renvoie Description
destroy() jQuery (plugin uniquement) Supprime complètement la fonctionnalité du bouton. Cela ramène l'élément à son état de pré-initialisation.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquer la méthode destroy :

$( ".selector" ).button( "destroy" );
    
disable() jQuery (plugin uniquement) Désactive le bouton.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquer la méthode disable :

$( ".selector" ).button( "disable" );
    
enable() jQuery (plugin uniquement) Active le bouton.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquer la méthode enable :

$( ".selector" ).button( "enable" );
    
option( optionName ) Object Obtient la valeur actuellement associée au paramètre spécifiéoptionNameoption.
  • optionName
    Type : String
    Description : Le nom de l'option à obtenir.

Exemples de code :

Invoquez la méthode :

var isDisabled = $( ".selector" ).button( "option", "disabled" );
    
option() PlainObject Récupère un objet contenant des paires clé/valeur qui représentent le hash des options actuelles du bouton.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquez la méthode :

var options = $( ".selector" ).button( "option" );
    
option( optionName, value ) jQuery (plugin uniquement) Définit la valeur de l'option du bouton associée au nom spécifiéoptionNameoption.
  • optionName
    Type : String
    Description : Le nom de l'option à définir.
  • value
    Type : Object
    Description : La valeur à définir pour l'option.

Exemples de code :

Invoquez la méthode :

$( ".selector" ).button( "option", "disabled", true );
    
option( options ) jQuery (plugin uniquement) Définit une ou plusieurs options pour le bouton.
  • options
    Type : Object
    Description : Les paires option-valeur à définir.

Exemples de code :

Invoquez la méthode :

$( ".selector" ).button( "option", { disabled: true } );
    
refresh() jQuery (plugin uniquement) Rafraîchit l'état visuel du bouton. Utilisé pour mettre à jour l'état du bouton après avoir modifié par programmation l'état de sélection ou l'état désactivé de l'élément natif.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Appelez la méthode refresh :

$( ".selector" ).button( "refresh" );
    
widget() jQuery Renvoie un objet jQuery contenant lejQuerybouton.
  • Cette méthode n'accepte aucun argument.

Exemples de code :

Invoquez la méthode widget :

var widget = $( ".selector" ).button( "widget" );
    

Événements Type Description
create( event, ui ) buttoncreate Déclenché lorsqu'un bouton est créé.
  • event
    Type : Event
  • ui
    Type : Object

Remarque :uiL'objet est vide, et il est inclus ici par souci de cohérence avec les autres événements.

Exemples de code :

Initialisez le bouton avec le rappel create spécifié :

$( ".selector" ).button({
  create: function( event, ui ) {}
});
    

Liez un écouteur d'événement à l'événement buttoncreate :

$( ".selector" ).on( "buttoncreate", function( event, ui ) {} );
    

Exemples

Exemple 1 :

Un Button jQuery UI simple.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>按钮部件(Button Widget)演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
  <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>
 
<button>按钮标签</button>
 
<script>
$( "button" ).button();
</script>
 
</body>
</html>

Exemple 2 :

Un Buttonset jQuery UI simple.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>按钮部件(Button Widget)演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
  <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>
 
<form>
  <fieldset>
    <legend>最喜欢的 jQuery 项目</legend>
    <div id="radio">
      <input type="radio" id="sizzle" name="project">
      <label for="sizzle">Sizzle</label>
 
      <input type="radio" id="qunit" name="project" checked="checked">
      <label for="qunit">QUnit</label>
 
      <input type="radio" id="color" name="project">
      <label for="color">Color</label>
    </div>
  </fieldset>
</form>
 
<script>
$( "#radio" ).buttonset();
</script>
 
</body>
</html>

Autres extensions