スケーラブルなベクターアイコンをコンテンツの好きな場所に配置できます。
UIkitには独自のSVGアイコンシステムと、増え続けるエレガントなアウトラインアイコンで構成される包括的なライブラリが付属しています。このコンポーネントはSVGをサイトに注入するため、SVGは色を採用し、CSSでスタイルを設定できます。
アイコンライブラリのスクリプトを必ず含めてください。詳細については、インストール手順を参照してください。
<script src="uikit/dist/js/uikit-icons.min.js"></script>
このコンポーネントを適用するには、<span>
または<a>
要素にuk-icon
属性を追加します。実際のアイコンを表示するには、属性にicon: NAME
パラメーターを追加する必要があります。これで、テキストのように色を継承するベクターアイコンが表示されます。
<span uk-icon="icon: check"></span>
<a href="" uk-icon="icon: heart"></a>
icon
が属性値の唯一のオプションである場合は、uk-icon="NAME"
も使用できます。
<span uk-icon="heart"></span>
現在利用可能なすべてのアイコンの概要を以下に示します。今後、新しいアイコンをリストに追加していきます。
アイコンのサイズを2倍にするには、uk-icon
属性にratio: 2
パラメーターを追加します。アイコンをどれくらい大きくしたいかに応じて、他の数値も指定できます。
<span uk-icon="icon: check; ratio: 2"></span>
<span class="uk-margin-small-right" uk-icon="icon: check; ratio: 2"></span>
<span uk-icon="icon: check; ratio: 3.5"></span>
アンカー内でアイコンを使用する際に、デフォルトのリンクスタイルをより控えめな色にリセットするには、.uk-icon-link
クラスを追加します。
<a href="" class="uk-icon-link" uk-icon="heart"></a>
<div>
<a href="#" class="uk-icon-link uk-margin-small-right" uk-icon="copy"></a>
<a href="#" class="uk-icon-link uk-margin-small-right" uk-icon="file-edit"></a>
<a href="#" class="uk-icon-link" uk-icon="trash"></a>
</div>
ソーシャルアイコンなどに使用できるアイコンボタンを作成するには、<a>
要素に修飾子.uk-icon-button
クラスを使用します。
<a href="" class="uk-icon-button" uk-icon="instagram"></a>
<div>
<a href="" class="uk-icon-button uk-margin-small-right" uk-icon="instagram"></a>
<a href="" class="uk-icon-button uk-margin-small-right" uk-icon="facebook"></a>
<a href="" class="uk-icon-button" uk-icon="youtube"></a>
</div>
背景画像をアイコンのサイズに合わせて拡大縮小することもできます。.uk-icon-image
クラスと背景画像のパスを追加するだけです。
<span class="uk-icon uk-icon-image" style="background-image: url(images/dark.jpg);"></span>
これらのオプションはすべてコンポーネント属性に適用できます。複数のオプションはセミコロンで区切ります。詳細はこちら
オプション | 値 | デフォルト | 説明 |
---|---|---|---|
icon |
文字列 | 表示するアイコン。 | |
ratio |
数値 | 1 |
アイコンのサイズ比率。 |
icon
はプライマリオプションであり、属性値にそれが唯一のオプションである場合はキーを省略できます。
<span uk-icon="heart"></span>
JavaScriptコンポーネントの詳細をご覧ください。
UIkit.icon(element, options);
追加されたSVGノードで解決されるJavaScript Promise。
UIkit.icon(element).svg.then(function(svg) { svg.querySelector('path').style.stroke = 'red'; })
アイコンコンポーネントに適切なWAI-ARIAロール、ステート、プロパティを設定します。
<a>
要素を使用する場合は、その意味を説明するために<a>
要素にaria-label
プロパティを設定します。<a href="" uk-icon="icon: heart" aria-label="…"></a>