string.replace()

The string.replace() function replaces the first or all $substring occurrences in the string with $replacement.

// Modules.
@use 'string.replace.function';

// The `string.replace()` function.
@function replace($string, $occurrence, $substring, $replacement) {
  @each $value in $substring {
    $index: string.index($string, $value);
    @while not($index == null) {
      $string: string.insert(
        string.slice($string, 1, $index - 1) +
          string.slice(
            $string,
            $index + string.length($value),
            string.length($string)
          ),
        $replacement,
        $index
      );
      @if $occurrence == first {
        $index: null;
      }
      @if $occurrence == all or ($occurrence == first and not ($index == null))
      {
        $index: string.index($string, $value);
      }
    }
  }
  @return $string;
}
https://github.com/angular-package/sass/blob/main/string/_string.replace.function.scss

Parameters

$string

A string to replace first or all $substring in it by $replacement.

$occurrence

First or all occurrences of $substring to replace in $string.

$substring

A string or list of strings to replace by $replacement.

$replacement

A string to replace $substring.

Return

The return value is a string with a first/all replaced $substring by $replacement.

Examples

Last updated

Was this helpful?