sass:list module

Introduction

The sass:list module helps you work with lists in Sass easily. It gives you tools to add, remove, or check items in lists without mistakes.

You want to add a color to a list of theme colors.

You need to check if a font is already in your font stack list.

You want to get the length of a list of spacing sizes.

You want to join two lists of CSS classes together.

You want to remove a specific item from a list of breakpoints.

Syntax

SASS

@use "sass:list";

// Example functions:
list.append($list, $value, $separator: auto)
list.length($list)
list.index($list, $value)
list.join($list1, $list2, $separator: auto)
list.remove($list, $value)
list.nth($list, $index)

Always @use "sass:list"; to access these functions.

Lists in Sass can be comma-separated or space-separated; some functions let you control this with $separator.

Examples

Adds yellow to the end of the $colors list.

SASS

@use "sass:list";

$colors: red, green, blue;
$new-colors: list.append($colors, yellow);
// $new-colors is red, green, blue, yellow

Finds the position of Helvetica in the $fonts list.

SASS

@use "sass:list";

$fonts: Arial, Helvetica, sans-serif;
$index: list.index($fonts, Helvetica);
// $index is 2

Counts how many items are in the $spacing list.

SASS

@use "sass:list";

$spacing: 0.5rem 1rem 2rem;
$length: list.length($spacing);
// $length is 3

Joins two lists into one.

SASS

@use "sass:list";

$list1: a, b, c;
$list2: d, e;
$joined: list.join($list1, $list2);
// $joined is a, b, c, d, e

Sample Program

This Sass code shows how to use the sass:list module to get the length of a list, add an item, remove an item, and get an item by position. The results are stored in CSS custom properties so you can see them in the browser.

SASS

@use "sass:list";

$breakpoints: mobile, tablet, desktop;

// Print original list length
$original-length: list.length($breakpoints);

// Add a new breakpoint
$new-breakpoints: list.append($breakpoints, widescreen);

// Remove the breakpoint 'tablet'
$updated-breakpoints: list.remove($new-breakpoints, tablet);

// Get the first breakpoint
$first-breakpoint: list.nth($updated-breakpoints, 1);

// Output styles to see results
body {
  --original-length: #{$original-length};
  --new-list: #{list.join($new-breakpoints, (), ", ")};
  --updated-list: #{list.join($updated-breakpoints, (), ", ")};
  --first-breakpoint: #{$first-breakpoint};
}

Important Notes

The list.length() function runs in constant time, so it is very fast.

Remember that list indexes start at 1, not 0.

Use list.remove() carefully because removing an item shifts the positions of later items.

Summary

The sass:list module helps manage lists easily in Sass.

You can add, remove, find, and join list items safely.

Always use @use "sass:list"; to access these functions.

Practice

1.

What is the main purpose of the sass:list module in Sass?

easy

A. To provide functions for managing lists like adding or removing items

B. To create color palettes automatically

C. To handle font styles and sizes

D. To compile Sass files into CSS

Solution

1. Step 1: Understand the sass:list module role

   The sass:list module offers functions to work with lists, such as adding, removing, or finding items.

2. Step 2: Compare options with module purpose

   Options A, B, and D describe unrelated tasks like colors, fonts, or compilation, which are not the sass:list module's job.

3. Final Answer:

   To provide functions for managing lists like adding or removing items -> Option A

4. Quick Check:

   sass:list = list management [OK]

Hint: sass:list is all about list operations, not colors or fonts [OK]

Common Mistakes:

• Confusing sass:list with color or font modules
• Thinking sass:list compiles Sass files
• Assuming sass:list handles CSS properties directly

2.

Which of the following is the correct way to import the sass:list module in your Sass file?

easy

A. @forward "sass:list";

B. @import "sass:list";

C. @include "sass:list";

D. @use "sass:list";

Solution

1. Step 1: Recall Sass module import syntax

   Modern Sass uses @use to import modules, not @import which is deprecated.

2. Step 2: Match options with correct syntax

   @use "sass:list"; uses @use "sass:list"; which is the correct way to import the list module.

3. Final Answer:

   @use "sass:list"; -> Option D

4. Quick Check:

   Use @use for modules [OK]

Hint: Always use @use for Sass modules, not @import [OK]

Common Mistakes:

• Using @import instead of @use
• Confusing @include with module import
• Using @forward incorrectly for importing

3.

Given the Sass code below, what will be the output of list.length($colors)?

@use "sass:list";
$colors: red, green, blue;

.result {
  length: list.length($colors);
}

medium

A. length: 1;

B. length: 0;

C. length: 3;

D. length: 4;

Solution

1. Step 1: Understand the list variable

   The variable $colors contains three items: red, green, and blue.

2. Step 2: Apply list.length function

   The list.length() function returns the number of items in the list, which is 3 here.

3. Final Answer:

   length: 3; -> Option C

4. Quick Check:

   3 items in list = 3 [OK]

Hint: Count items separated by commas for list length [OK]

Common Mistakes:

• Counting commas instead of items
• Confusing list length with string length
• Forgetting to import sass:list module

4.

Identify the error in the following Sass code using sass:list module:

@use "sass:list";
$items: 1 2 3;
$new-items: list.push($items, 4);

.result {
  content: $new-items;
}

medium

A. Using list.push instead of list.append

B. Missing commas between list items in $items

C. Incorrect module import syntax

D. Cannot append numbers to lists

Solution

1. Step 1: Check list syntax in $items

   The list $items is written as 1 2 3 without commas, which is valid space-separated list.

2. Step 2: Understand list.append behavior

   The sass:list module has list.append() to add items, but no list.push().

3. Step 3: Identify the error

   The code uses non-existent list.push(), causing a compilation error. Change to list.append().

4. Final Answer:

   Using list.push instead of list.append -> Option A

5. Quick Check:

   sass:list.append exists, list.push does not [OK]

Hint: sass:list uses list.append, not list.push [OK]

Common Mistakes:

• Confusing list.append with list.push (no list.push in sass:list)
• Assuming space-separated lists are always safe
• Ignoring module import correctness

5.

You want to combine two lists $list1: 1, 2, 3; and $list2: 4, 5; into one list using sass:list functions. Which code snippet correctly joins these lists?

@use "sass:list";

// Options:
// A
$combined: list.length($list1) + list.length($list2);

// B
$combined: list.append($list1, $list2);

// C
$combined: list.insert($list1, $list2, 1);

// D
$combined: list.join($list1, $list2, comma);

hard

A. $combined: list.length($list1) + list.length($list2);

B. $combined: list.join($list1, $list2, comma);

C. $combined: list.insert($list1, $list2, 1);

D. $combined: list.append($list1, $list2);

Solution

1. Step 1: Understand list.join function

   The list.join() function combines two lists into one, with a separator (comma or space).

2. Step 2: Analyze each option

   $combined: list.join($list1, $list2, comma); correctly uses list.join($list1, $list2, comma) to join lists with commas.
   $combined: list.append($list1, $list2); appends the entire second list as one item, not merging.
   $combined: list.insert($list1, $list2, 1); inserts the whole second list at position 1, nesting it.
   $combined: list.length($list1) + list.length($list2); adds lengths, not lists.

3. Final Answer:

   $combined: list.join($list1, $list2, comma); -> Option B

4. Quick Check:

   Use list.join to merge lists [OK]

Hint: Use list.join to merge two lists cleanly [OK]

Common Mistakes:

• Using list.append to merge lists (adds as one item)
• Using list.insert to add whole list inside another
• Adding lengths instead of joining lists