lightning:buttonIconStateful
lightning:buttonIconStateful コンポーネントは、2 つの状態を切り替えるアイコンのみのボタン要素を表します。たとえば、このコンポーネントを使用して、ブログ投稿に関する顧客のフィードバック (賛成または反対) を取得できます。ボタンをクリックすると、onclick に設定されたクライアント側コントローラメソッドがトリガされ、selected 属性を使用してアイコンの状態が変更されます。
Lightning Design System ユーティリティアイコンカテゴリでは、lightning:buttonIconStateful で使用できる約 200 個のユーティリティアイコンを提供しています。Lightning Design System では複数のアイコンカテゴリが提供されていますが、このコンポーネントで使用できるのはユーティリティカテゴリのみです。
ユーティリティアイコンを表示するには、https://lightningdesignsystem.com/icons/#utilityにアクセスしてください。
このコンポーネントは、Lightning Design System のボタンアイコンからスタイル設定を継承します。
variant、size、class の各属性を組み合わせて、ボタンやアイコンのスタイルをカスタマイズできます。ボタンコンテナのスタイル設定をカスタマイズするには、class 属性を使用します。
次の例では、2 つの状態を切り替える [like (賛成)] ボタンを作成します。デフォルトでは、[like (賛成)] ボタンが選択されます。ボタンの状態は selected 属性に保存されます。
1<aura:component>
2 <aura:attribute name="liked" type="Boolean" default="true"/>
3 <lightning:buttonIconStateful iconName="utility:like" selected="{!v.liked}" alternativeText="Like" onclick="{! c.handleToggle }"/>
4<aura:component>[dislike (反対)] ボタンを選択すると、[like (賛成)] ボタンの状態も切り替わり、選択解除されます。
1({
2 handleToggle : function (cmp, event) {
3 var liked = cmp.get("v.liked");
4 cmp.set("v.liked", !liked);
5 }
6})メソッド
このコンポーネントは、次のメソッドをサポートします。
focus(): フォーカスを要素に設定します。
属性
| 属性名 | 属性型 | 説明 | 必須項目 |
|---|---|---|---|
| body | Component[] | コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。 | |
| accesskey | String | 要素の有効化またはフォーカス設定のためのショートカットキーを指定します。 | |
| tabindex | Integer | 要素のタブ順序を指定します (タブボタンがナビゲーションに使用される場合)。 | |
| onfocus | Aura.Action | 要素にフォーカスが設定されたときにトリガされるアクション。 | |
| onblur | Aura.Action | 要素がフォーカスを解放したときにトリガされるアクション。 | |
| class | String | コンポーネントの基本クラスに加え、外部要素の CSS クラス。 | |
| title | String | マウスが要素に重ねられたときにツールチップテキストを表示します。 | |
| name | String | ボタン要素の名前。この値は省略可能であり、コールバック内でボタンを識別するために使用できます。 | |
| value | String | ボタン要素の値。この値は省略可能であり、フォームの送信時に使用できます。 | |
| iconName | String | アイコンの Lightning Design System 名。名前は、形式「\utility:down\」で記述します。「utility」はカテゴリ、「down」は表示する特定のアイコンです。注意: このコンポーネントで使用できるのはユーティリティアイコンのみです。 | はい |
| variant | String | バリエーションによって buttonIcon の外観が変更されます。使用できるバリエーションは border と border-inverse です。この値のデフォルトは border です。 | |
| size | String | buttonIcon のサイズ。オプションは、xx-small、x-small、small、medium です。この値のデフォルトは medium です。 | |
| disabled | Boolean | このボタンを無効な状態で表示するかどうかを指定します。無効なボタンをクリックすることはできません。この値のデフォルトは false です。 | |
| alternativeText | String | アイコンを説明するために使用する代替テキスト。このテキストでは、アイコンの外観 (「ペーパークリップ」) ではなく、ボタンをクリックしたときに何が起こるか (「ファイルのアップロード」など) を説明する必要があります。 | はい |
| onclick | Aura.Action | ボタンがクリックされたときに実行されるアクション。 | |
| selected | Boolean | ボタンが選択済みの状態かどうかを指定します。 |