lightning:helptext (ベータ)
テキストのポップオーバーがあるアイコンです。このコンポーネントでは、API バージョン 41.0 以降が必要です。
lightning:helptext コンポーネントは、画面の要素を説明する少量のテキストを含むポップオーバーがあるアイコンを表示します。ポップオーバーは、関連付けられているアイコンにユーザがマウスポインタまたはフォーカスを置くと表示されます。このコンポーネントはツールチップと似ており、項目レベルのヘルプテキストを表示する場合などに役立ちます。ツールチップコンテンツでは、HTML マークアップはサポートされていません。
このコンポーネントは、Lightning Design System のツールチップからスタイル設定を継承します。
デフォルトでは、ツールチップは utility:info アイコンを使用します。Lightning Design System ユーティリティアイコンカテゴリでは、lightning:helptext で使用できる約 200 個のユーティリティアイコンを提供しています。Lightning Design System では複数のアイコンカテゴリが提供されていますが、lightning:buttonIcon で使用できるのはユーティリティカテゴリのみです。
ユーティリティアイコンを表示するには、https://lightningdesignsystem.com/icons/#utilityにアクセスしてください。
次の例では、ツールチップがあるアイコンを作成します。
1<aura:component>
2 <lightning:helptext
3 content="Your email address will be your login name" />
4</aura:component>ポップオーバーはアイコンの左下に固定され、スペースがある場合はアイコンの上に表示されます。ビューポートに従ってその位置が自動的に調整されます。
属性
| 属性名 | 属性型 | 説明 | 必須項目 |
|---|---|---|---|
| body | Component[] | コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。 | |
| class | String | コンポーネントの基本クラスに加え、外部要素の CSS クラス。 | |
| title | String | マウスポインタが要素に重ねられたときにツールチップテキストを表示します。 | |
| content | String | ポップオーバーに表示するテキスト。 | |
| iconName | String | 表示要素として使用するアイコンの Lightning Design System 名。名前は、形式「utility:info」で記述します。「utility」はカテゴリ、「info」は表示する特定のアイコンです。デフォルト値は「utility:info」です。 |