Renamed! This package has been renamed to @sass-fairy/math and organised in a mono-repo for better maintainablity, an improved user experience, and full documentation. Explore more about the change at sass-fairy.com.

sass-module-math

This Sass module provides more advanced math functions.

Install

Requires

Dart Sass: >=1.33.0

Install the package:

npm install sass-module-math

Use the package like any other Sass module:

@use 'sass-module-math';

Depending on your setup, you may need to configure node_modules as include path:

const sass = require('sass');

sass.render({
  file: scss_filename,
  includePaths: ['node_modules']
});

Public API

Bounding Functions

gcd ( $numbers... ): Returns the Greatest Common Divisor (GCD, GCF, HCF) of a set of numbers.
lcm ( $numbers... ): Returns the Least Common Multiple (LCM) of a set of numbers.

Exponential Functions

exp ( $number ): Returns Euler's number to the specified power.
fact ( $number ): Returns the factorial of the specified integer.

Unit Functions

change ( $number, $units ): Returns the given number with the same units as another specified number.
unitless ( $number ): Returns the unitless value of the specified number.

Don't see the function you're looking for? Request a new feature describing a use case.

Combined API

In order to avoid constantly declaring both the native 'sass:math' module and this library, the combined API has been added which merges the two.

// Rather than using both modules separately...
@use 'sass-module-math';
@use 'sass:math';

// ...this statement will accomplish the same thing.
@use 'sass-module-math/math';

roydukkey / sass-module-math