列表

Sass 的 列表类型。

⚠️ 注意！

此列表类型的使用方法使用 0 索引，即使在 Sass 列表中使用 1 索引也是如此。这些方法也不支持使用负数从列表末尾反向索引。

层次结构

  • 列表

构造函数

constructor

方法

getLength getSeparator getValue setSeparator setValue

构造函数

constructor

  • 创建一个新的 Sass 列表。

    ⚠️ 注意！

    列表元素的初始值为未定义。这些元素必须使用 setValue 设置，然后才能访问它们或将列表传回 Sass。

    示例

    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

      列表中（最初未定义的）元素的数量。

    • Optional commaSeparator: boolean

      如果为 true，则列表以逗号分隔；否则，以空格分隔。默认值为 true。

    返回 List

方法

getLength

  • 返回列表中元素的数量。

    示例

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

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

    返回 number

getSeparator

  • 如果此列表以逗号分隔，则返回 true，否则返回 false。

    示例

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

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

    返回 boolean

getValue

  • 返回 index 处的元素，如果该值尚未设置，则返回 undefined。

    示例

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

    抛出

    Error 如果 index 小于 0 或大于或等于此列表中的元素数量。

    参数

    • index: number

      此列表中的（0 索引）索引。

    返回 undefined | LegacyValue

setSeparator

  • 设置列表是否以逗号分隔。

    参数

    • isComma: boolean

      true 使列表以逗号分隔，false 否则。

    返回 void

setValue

  • 将 index 处的元素设置为 value。

    示例

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

    抛出

    Error 如果 index 小于 0 或大于或等于此列表中的元素数量。

    参数

    • index: number

      此列表中的（0 索引）索引。

    • value: LegacyValue

    返回 void