Sass @mixin と @include

@mixin ディレクティブを使用すると、スタイルシート全体で再利用できるスタイルを定義できます。

@include ディレクティブは、ミックスインをドキュメントに取り込むことができます。


ミックスインを定義する

ミックスイン(mixin)は @mixin ディレクティブで定義します。 @mixin name { property: value; property: value; ... }

次の例では、"important-text" という名前のミックスインを作成します:

Sass コード:

@mixin important-text {
  color: red;
  font-size: 25px;
  font-weight: bold;
  border: 1px solid blue;
}

注意:Sass において、ハイフン - とアンダースコア _ は同じものとみなされます。つまり @mixin important-text { } と @mixin important_text { } は同じミックスインです。

ミックスインを使用する

@include ディレクティブは、ミックスインを含めるために使用できます:

Sass @include ミックスイン構文:

selector {
  @include mixin-name;
}

したがって、important-text ミックスインを含めるコードは次のようになります:

例

.danger {
  @include important-text;
  background-color: green;
}

上記のコードを CSS コードに変換すると、次のようになります:

CSS コード:

.danger {
  color: red;
  font-size: 25px;
  font-weight: bold;
  border: 1px solid blue;
  background-color: green;
}

ミックスインの中に別のミックスインを含めることもできます。次のようになります:

例

@mixin special-text {
  @include important-text;
  @include link;
  @include special-border;
}

ミックスインへ変数を渡す

ミックスインは引数を受け取ることができます。

ミックスインに変数を渡すことができます。

引数を受け取ることができるミックスインの定義:

例

/* ミックスインは2つの引数を受け取る */
@mixin bordered($color, $width) {
  border: $width solid $color;
}

.myArticle {
  @include bordered(blue, 1px);  // ミックスインを呼び出し、2つの引数を渡す
}

.myNotes {
  @include bordered(red, 2px); // ミックスインを呼び出し、2つの引数を渡す
}

上記の例のミックスインの引数は、枠線(ボーダー)のプロパティ(color と width)を設定するものです。

上記のコードを CSS コードに変換すると、次のようになります:

CSS コード:

.myArticle {
  border: 1px solid blue;
}

.myNotes {
  border: 2px solid red;
}

ミックスインの引数にはデフォルト値を定義することもできます。構文は次のとおりです:

例

@mixin bordered($color: blue, $width: 1px) {
  border: $width solid $color;
}

ミックスインを含める際には、必要な変数名とその値だけを渡せばよいです:

例

@mixin sexy-border($color, $width: 1in) {
  border: {
    color: $color;
    width: $width;
    style: dashed;
  }
}
p { @include sexy-border(blue); }
h1 { @include sexy-border(blue, 2in); }

上記のコードを CSS コードに変換すると、次のようになります:

CSS コード:

p {
  border-color: blue;
  border-width: 1in;
  border-style: dashed; }

h1 {
  border-color: blue;
  border-width: 2in;
  border-style: dashed;
}

可変引数

場合によっては、ミックスイン(mixin)や関数(function)がいくつの引数を使用するか確定できないことがあります。そのような場合は、...を使用して可変引数を設定します。

例えば、ボックスシャドウ(box-shadow)を作成するミックスインは、任意の数の box-shadow を引数として受け取ることができます。

例

@mixin box-shadow($shadows...) {
      -moz-box-shadow: $shadows;
      -webkit-box-shadow: $shadows;
      box-shadow: $shadows;
}

.shadows {
  @include box-shadow(0px 4px 5px #666, 2px 6px 10px #999);
}

上記のコードを CSS コードに変換すると、次のようになります:

CSS コード:

.shadows {
  -moz-box-shadow: 0px 4px 5px #666, 2px 6px 10px #999;
  -webkit-box-shadow: 0px 4px 5px #666, 2px 6px 10px #999;
  box-shadow: 0px 4px 5px #666, 2px 6px 10px #999;
}

ベンダープレフィックスでミックスインを使用する

ベンダープレフィックスでミックスインを使用するのは非常に便利です。次の例のとおりです:

例

@mixin transform($property) {
  -webkit-transform: $property;
  -ms-transform: $property;
  transform: $property;
}

.myBox {
  @include transform(rotate(20deg));
}

上記のコードを CSS コードに変換すると、次のようになります:

CSS コード:

.myBox {
  -webkit-transform: rotate(20deg);
  -ms-transform: rotate(20deg);
  transform: rotate(20deg);
}
その他の拡張