リスト

Sassのリスト型

⚠️ 注意!

このリスト型のメソッドは、Sass内ではリストが1から始まるインデックスを使用しているにもかかわらず、0から始まるインデックスを使用します。 また、これらのメソッドは、リストの末尾から逆方向にインデックスするために負の数を使用することをサポートしていません。

階層

  • リスト

コンストラクタ

メソッド

コンストラクタ

  • 新しいSassリストを作成します。

    ⚠️ 注意!

    リスト要素の初期値は未定義です。 これらの要素は、Sassにリストを返す前、または要素にアクセスする前に、setValueを使用して設定する必要があります。

    const list = new sass.types.List(3);
    list.setValue(0, new sass.types.Number(10, "px"));
    list.setValue(1, new sass.types.Number(15, "px"));
    list.setValue(2, new sass.types.Number(32, "px"));
    list; // 10px, 15px, 32px

    パラメータ

    • length: number

      リスト内の(初期は未定義の)要素の数。

    • オプション commaSeparator: boolean

      trueの場合、リストはカンマ区切りです。そうでない場合、スペース区切りです。 デフォルトはtrueです。

    戻り値 List

メソッド

  • リスト内の要素の数を返します。

    // list is `10px, 15px, 32px`
    list.getLength(); // 3

    // list is `1px solid`
    list.getLength(); // 2

    戻り値 number

  • このリストがカンマ区切りであればtrueを、そうでなければfalseを返します。

    // list is `10px, 15px, 32px`
    list.getSeparator(); // true

    // list is `1px solid`
    list.getSeparator(); // false

    戻り値 boolean

  • index番目の要素を返します。値が設定されていない場合はundefinedを返します。

    // list is `10px, 15px, 32px`
    list.getValue(0); // 10px
    list.getValue(2); // 32px

    例外

    indexがこのリストの要素数より小さいか、または等しい場合、Errorをスローします。

    パラメータ

    • index: number

      このリストへの(0から始まる)インデックス。

    戻り値 undefined | LegacyValue

  • リストがカンマ区切りであるかどうかを設定します。

    パラメータ

    • isComma: boolean

      リストをカンマ区切りにする場合はtrue、そうでない場合はfalse

    戻り値 void

  • index番目の要素をvalueに設定します。

    // list is `10px, 15px, 32px`
    list.setValue(1, new sass.types.Number(18, "px"));
    list; // 10px, 18px, 32px

    例外

    indexがこのリストの要素数より小さいか、または等しい場合、Errorをスローします。

    パラメータ

    • index: number

      このリストへの(0から始まる)インデックス。

    • value: LegacyValue

    戻り値 void