unit.gl 0.0.40 → 0.1.1

package/scss/functions/_color.scss

@@ -3,38 +3,35 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Color Variables Module
 /// ===========================================================================
-/// 
-/// These colors are used for visual guides such as grid overlays, baselines, 
-/// and alignment guides. The colors are defined with varying levels of opacity 
+///
+/// These colors are used for visual guides such as grid overlays, baselines,
+/// and alignment guides. The colors are defined with varying levels of opacity
 /// to ensure they are visible yet non-intrusive on the design.
-/// 
+///
 /// @group Color
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Functions
 // ============================================================================
 
-
-/// 
+///
 /// Function to Retrieve Guide Colors (Optional for Flexibility)
 /// ---------------------------------------------------------------------------
-/// 
+///
 @function guide_color($name) {
     @return map-get($guide_colors, $name);
 }

package/scss/functions/_index.scss

@@ -3,10 +3,10 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Functions Module
 /// ===========================================================================
-/// 
+///
 /// This module serves as a central hub for all core SCSS functions used across
 /// the project. By forwarding various function modules, it allows for
 /// consistent access to utilities like mathematical operations, ratio
@@ -18,28 +18,35 @@
 /// - scale:   Utilities for implementing modular scales in responsive design.
 /// - sequence: Functions for generating and working with numeric sequences.
 /// - unit:    Functions for unit conversions and calculations.
-/// 
+///
 /// @group Functions
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Forward
 // ============================================================================
 
-@forward "math";              // Core mathematical operations and utilities
-@forward "ratio";             // Functions for handling and calculating ratios
-@forward "scale";             // Scaling utilities for responsive design
-@forward "sequence";          // Functions for numeric sequence generation
-@forward "unit";              // Functions for unit conversion and calculations
+// Core mathematical operations and utilities
+@forward "math";
+
+// Functions for handling and calculating ratios
+@forward "ratio";
+
+// Scaling utilities for responsive design
+@forward "scale";
+
+// Functions for numeric sequence generation
+@forward "sequence";
+
+// Functions for unit conversion and calculations
+@forward "unit";

package/scss/functions/_layer.scss

@@ -3,46 +3,42 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Layer Functions Module
 /// ===========================================================================
-/// 
+///
 /// @group Layer
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Functions
 // ============================================================================
 
-
-
 ///
 /// Z-Index Layer Function
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// This function retrieves the z-index value from the $layers map based on
 /// the provided layer name. If the layer is not found, a warning is issued.
 ///
 /// @name z
 /// @param {String} $layer - The name of the layer to retrieve the z-index for.
 /// @return {Number | Null} - The z-index value associated with the layer, or null if not found.
-/// 
+///
 @function z($layer) {
     @if not map-has-key($layers, $layer) {
         @warn "Layer `#{$layer}` not found in the $layers map. z-index property omitted.";
         @return null;
     }
     @return map-get($layers, $layer);
-}
+}

package/scss/functions/_ratio.scss

@@ -3,47 +3,44 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Ratio Functions Module
 /// ===========================================================================
-/// 
-/// This module provides functions for calculating sizes based on well-known 
-/// mathematical ratios, such as the golden ratio. These functions are useful 
-/// for maintaining harmonious proportions in design elements like spacing, 
+///
+/// This module provides functions for calculating sizes based on well-known
+/// mathematical ratios, such as the golden ratio. These functions are useful
+/// for maintaining harmonious proportions in design elements like spacing,
 /// typography, and layout.
-/// 
+///
 /// @group Ratio
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Functions
 // ============================================================================
 
-
 ///
 /// Golden Ratio Function
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates a size using the golden ratio (approximately 1.618), which is
 /// widely used in design for its aesthetically pleasing proportions.
-/// 
+///
 /// @name ratio_golden
 /// @param {Number} $size - The base size to scale.
 /// @param {Number} $increment - The exponent applied to the golden ratio, default is 1.
 /// @return {Number} - The calculated size based on the golden ratio.
-/// 
+///
 /// @example scss - Usage Example
 ///   // Increase size using the golden ratio
 ///   .element {
@@ -54,17 +51,17 @@
 ///   .small-element {
 ///     width: golden_ratio(16px, -1); // Output: 9.888px
 ///   }
-/// 
+///
 @function ratio_golden($size, $increment: 1) {
     $golden-ratio: 1.618;
 
     // Validate the input size
-    @if not unitless($size) and type-of($size) != 'number' {
+    @if not unitless($size) and type-of($size) != "number" {
         @error "The size parameter must be a valid number or unitless value.";
     }
 
     // Validate the increment
-    @if type-of($increment) != 'number' {
+    @if type-of($increment) != "number" {
         @error "The increment parameter must be a valid number.";
     }
 

package/scss/functions/_scale.scss

@@ -3,62 +3,64 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Scale Functions Module
 /// ===========================================================================
-/// 
+///
 /// This module defines various scales used for designing harmonious layouts
 /// and typographies, including musical scales and a classic typographic scale.
 /// It also provides a function to calculate values based on a modular scale,
 /// which is essential for maintaining consistent design proportions.
-/// 
+///
 /// @group Scale
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Functions
 // ============================================================================
 
-
 ///
 /// Modular Scale Function
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates sizes (like font-size, spacing) based on a modular
 /// scale. This helps maintain harmonious proportions across a design.
-/// 
+///
 /// @name modular_scale
 /// @param {Number} $increment - The step on the scale, can be positive or negative.
 /// @param {Number} $base - The base value to scale from, defaults to 1em (typographic base size).
 /// @param {Number} $ratio - The ratio to use for scaling, defaults to the Golden Ratio (1.618).
 /// @return {Number} - The calculated value based on the modular scale.
-/// 
-@function modular_scale($increment: 1, $base: 1em, $ratio: 1.618) {
-    // Validate inputs
-    @if type-of($increment) != 'number' {
+///
+@function modular_scale(
+    $increment: 1,
+    $base: 1em,
+    $ratio: 1.618
+) {
+
+        // Validate inputs
+    @if type-of($increment) != "number" {
         @error "Step must be a number.";
     }
-  
-    @if type-of($base) != 'number' and not unitless($base) {
+
+    @if type-of($base) != "number" and not unitless($base) {
         @error "Base must be a number with or without units.";
     }
-  
-    @if type-of($ratio) != 'number' or $ratio <= 0 {
+
+    @if type-of($ratio) != "number" or $ratio <= 0 {
         @error "Ratio must be a positive number.";
     }
-  
+
     // Calculate the modular scale value
     @return $base * pow($ratio, $increment);
 }

package/scss/functions/_sequence.scss

@@ -3,98 +3,99 @@
 // ============================================================================
 
 ////
-/// 
+///
 /// Sequence Functions Module
 /// ===========================================================================
-/// 
-/// This module provides various functions to calculate terms in well-known 
-/// mathematical sequences such as Fibonacci, Lucas, Prime numbers, and more. 
-/// Each function is designed to compute the nth term in the respective 
+///
+/// This module provides various functions to calculate terms in well-known
+/// mathematical sequences such as Fibonacci, Lucas, Prime numbers, and more.
+/// Each function is designed to compute the nth term in the respective
 /// sequence using a straightforward algorithm.
-/// 
+///
 /// @group Sequence
 /// @author Scape Agency
 /// @link https://unit.gl
 /// @since 0.1.0 initial release
 /// @todo None
 /// @access public
-/// 
+///
 ////
 
-
 // ============================================================================
 // Use
 // ============================================================================
 
-
 // ============================================================================
 // Functions
 // ============================================================================
 
-
 ///
 /// Fibonacci Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth Fibonacci number using a recursive approach.
-/// Fibonacci numbers form a sequence where each number is the sum of the two 
+/// Fibonacci numbers form a sequence where each number is the sum of the two
 /// preceding ones, starting with 0 and 1.
-/// 
+///
 /// @name sequence_fibonacci
 /// @param {Number} $n - The position in the Fibonacci sequence to calculate.
 /// @return {Number} - The nth Fibonacci number.
-/// 
- @function sequence_fibonacci($n) {
+///
+@function sequence_fibonacci($n) {
     @if $n < 0 {
         @warn "Index #{$n} is not valid for the Fibonacci sequence.";
         @return null;
     }
-    @if $n == 0 { @return 0; }
-    @else if $n == 1 { @return 1; }
-    @else {
+    @if $n == 0 {
+        @return 0;
+    } @else if $n == 1 {
+        @return 1;
+    } @else {
         @return sequence_fibonacci($n - 1) + sequence_fibonacci($n - 2);
     }
 }
 
-
 ///
 /// Lucas Number Sequence
 /// ---------------------------------------------------------------------------
 ///
 /// Calculates the nth Lucas number using a recursive approach.
-/// Lucas numbers form a sequence similar to Fibonacci numbers but start with 
+/// Lucas numbers form a sequence similar to Fibonacci numbers but start with
 /// 2 and 1 instead of 0 and 1.
-/// 
+///
 /// @name sequence_lucas
 /// @param {Number} $n - The position in the Lucas sequence to calculate.
 /// @return {Number} - The nth Lucas number.
-/// 
+///
 @function sequence_lucas($n) {
     @if $n < 0 {
         @warn "Index #{$n} is not valid for the Lucas sequence.";
         @return null;
     }
-    @if $n == 0 { @return 2; }
-    @else if $n == 1 { @return 1; }
-    @else {
+    @if $n == 0 {
+        @return 2;
+    } @else if $n == 1 {
+        @return 1;
+    } @else {
         @return sequence_lucas($n - 1) + sequence_lucas($n - 2);
     }
 }
 
-
 ///
 /// Prime Number Check
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Checks if a number is prime.
-/// A prime number is a natural number greater than 1 that has no positive 
+/// A prime number is a natural number greater than 1 that has no positive
 /// divisors other than 1 and itself.
 /// @name is_prime
 /// @param {Number} $n - The number to check.
 /// @return {Boolean} - `true` if the number is prime, `false` otherwise.
-/// 
+///
 @function is_prime($n) {
-    @if $n <= 1 { @return false; }
+    @if $n <= 1 {
+        @return false;
+    }
     @for $i from 2 through math.sqrt($n) {
         @if $n % $i == 0 {
             @return false;
@@ -103,18 +104,17 @@
     @return true;
 }
 
-
 ///
 /// Factorial
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the factorial of a number.
 /// Factorial is the product of all positive integers up to a given number.
-/// 
+///
 /// @name factorial
 /// @param {Number} $n - The number to calculate the factorial for.
 /// @return {Number} - The factorial of $n.
-/// 
+///
 @function factorial($n) {
     $result: 1;
     @for $i from 1 through $n {
@@ -126,31 +126,30 @@
 ///
 /// Catalan Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth Catalan number.
-/// Catalan numbers are a sequence of natural numbers with applications in 
+/// Catalan numbers are a sequence of natural numbers with applications in
 /// combinatorial mathematics, such as counting certain types of lattice paths.
-/// 
+///
 /// @name sequence_catalan
 /// @param {Number} $n - The position in the Catalan sequence to calculate.
 /// @return {Number} - The nth Catalan number.
-/// 
+///
 @function sequence_catalan($n) {
     @return factorial(2 * $n) / (factorial($n + 1) * factorial($n));
 }
 
-
 ///
 /// Harmonic Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth term of the harmonic series.
 /// The harmonic series is the sum of the reciprocals of the positive integers.
-/// 
+///
 /// @name sequence_harmonic
 /// @param {Number} $n - The position in the harmonic series to calculate.
 /// @return {Number} - The nth term of the harmonic series.
-/// 
+///
 @function sequence_harmonic($n) {
     @if $n <= 0 {
         @warn "Index #{$n} is not valid for the harmonic series.";
@@ -159,19 +158,18 @@
     @return 1 / $n;
 }
 
-
 ///
 /// Geometric Sequence
 /// ----------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth term of a geometric series with a ratio of 2.
-/// A geometric series has a constant ratio between successive terms. 
+/// A geometric series has a constant ratio between successive terms.
 /// This function calculates the nth term for a series where each term doubles.
-/// 
+///
 /// @name sequence_geometric
 /// @param {Number} $n - The position in the geometric series to calculate.
 /// @return {Number} - The nth term of the geometric series.
-/// 
+///
 @function sequence_geometric($n) {
     @if $n < 0 {
         @warn "Negative index #{$n} is not valid for the geometric series.";
@@ -180,18 +178,17 @@
     @return pow(2, $n - 1);
 }
 
-
 ///
 /// Superfactorial Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the superfactorial of a number.
 /// The superfactorial of a number n is the product of the first n factorials.
-/// 
+///
 /// @name sequence_superfactorial
 /// @param {Number} $n - The number to calculate the superfactorial for.
 /// @return {Number} - The superfactorial of $n.
-/// 
+///
 @function sequence_superfactorial($n) {
     $result: 1;
     @for $i from 1 through $n {
@@ -204,18 +201,17 @@
     @return $result;
 }
 
-
 ///
 /// Triangular Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth triangular number.
 /// Triangular numbers are the sum of the first n natural numbers.
-/// 
+///
 /// @name sequence_triangular
 /// @param {Number} $n - The position in the triangular series to calculate.
 /// @return {Number} - The nth triangular number.
-/// 
+///
 @function sequence_triangular($n) {
     @if $n <= 0 {
         @warn "Index #{$n} is not valid for the triangular series.";
@@ -224,19 +220,18 @@
     @return $n * ($n + 1) / 2;
 }
 
-
 ///
 /// Square Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth square number.
-/// Square numbers are numbers that can be expressed as the product of an 
+/// Square numbers are numbers that can be expressed as the product of an
 /// integer with itself (n²).
-/// 
+///
 /// @name sequence_square
 /// @param {Number} $n - The position in the square series to calculate.
 /// @return {Number} - The nth square number.
-/// 
+///
 @function sequence_square($n) {
     @if $n < 0 {
         @warn "Negative index #{$n} is not valid for the square series.";
@@ -245,18 +240,17 @@
     @return $n * $n;
 }
 
-
 ///
 /// Pentagonal Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth pentagonal number.
 /// Pentagonal numbers are figurate numbers that represent a pentagon.
-/// 
+///
 /// @name sequence_pentagonal
 /// @param {Number} $n - The position in the pentagonal series to calculate.
 /// @return {Number} - The nth pentagonal number.
-/// 
+///
 @function sequence_pentagonal($n) {
     @if $n <= 0 {
         @warn "Index #{$n} is not valid for the pentagonal series.";
@@ -265,18 +259,17 @@
     @return (3 * $n * $n - $n) / 2;
 }
 
-
 ///
 /// Hexagonal Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth hexagonal number.
 /// Hexagonal numbers are figurate numbers that represent a hexagon.
-/// 
+///
 /// @name sequence_hexagonal
 /// @param {Number} $n - The position in the hexagonal series to calculate.
 /// @return {Number} - The nth hexagonal number.
-/// 
+///
 @function sequence_hexagonal($n) {
     @if $n <= 0 {
         @warn "Index #{$n} is not valid for the hexagonal series.";
@@ -285,18 +278,17 @@
     @return 2 * $n * $n - $n;
 }
 
-
 ///
 /// Cube Number Sequence
 /// ---------------------------------------------------------------------------
-/// 
+///
 /// Calculates the nth cube number.
 /// Cube numbers are numbers raised to the power of three (n³).
-/// 
+///
 /// @name sequence_cube
 /// @param {Number} $n - The position in the cube series to calculate.
 /// @return {Number} - The nth cube number.
-/// 
+///
 @function sequence_cube($n) {
     @if $n < 0 {
         @warn "Negative index #{$n} is not valid for the cube series.";