Object-fit

Object-fit utilities for media elements with module mixins for responsive modifiers.

Utilities (anchor)

Object-fit utility names and property values
Utility name	Property values
Single element
.object-contain	object-fit: contain
.object-cover	object-fit: cover
.object-fill	object-fit: fill
.object-scale-down	object-fit: scale-down
.object-none	object-fit: none
.object-initial	object-fit: initial
Child element
.child-object-contain	object-fit: contain
.child-object-cover	object-fit: cover
.child-object-fill	object-fit: fill
.child-object-scale-down	object-fit: scale-down
.child-object-none	object-fit: none
.child-object-initial	object-fit: initial

Responsive mixins (anchor)

Responsive modifier mixins are provided to include where required in custom breakpoints, the utilities available use the following modifier class naming convention:

.object-cover
.object-cover-xxl
.object-cover-xl
.object-cover-lg
.object-cover-md
.object-cover-sm
.object-cover-xs
.object-cover-xxs

Using the module (anchor)

Load StyleMods as demonstrated (change file path as required) then include the Sass mixin anywhere below.

custom.scss

@use "stylemods/scss" as *;
@include object-fit-css;

// Example breakpoint
@media (width <= 480px) {
  @include object-fit-sm-css;
}

See the using modules page for more information including how to compile the modules in cascade layers and include and reuse them in multiple source files.

Using the framework (anchor)

Using the recommended custom setup enable the styles (and required breakpoints) in an overrides document:

overrides.scss

@use "stylemods/scss/configuration" as *;
$enable-object-fit:      true;
$enable-object-fit-sm:   true;

Include the overrides and the framework styles with your custom document for compiling the framework:

custom.scss

@use "overrides";
@use "stylemods/scss/stylemods";

See using the framework for more information including how the styles can also be compiled within cascade layers.

Source code (anchor)

The modules and framework use the same source code, see Sass maps to learn how to customize the values below.

object-fit.scss

// ---------------------------------------------------------- 
// Object-fit
// ----------------------------------------------------------
$object-fit-values: (
  "contain": contain,
  "cover": cover,
  "fill": fill,
  "scale": scale-down,
  "none": none,
  "initial": initial,
) !default;

@mixin object-fit-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name} {
      object-fit: $value;       
    }   
  }

  @each $name, $value in $object-fit-values {
    .child-object-#{$name} * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-xxl-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-xxl {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-xxl * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-xl-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-xl {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-xl * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-lg-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-lg {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-lg * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-md-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-md {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-md * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-sm-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-sm {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-sm * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-xs-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-xs {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-xs * {
      object-fit: $value;       
    }   
  }  
}

@mixin object-fit-xxs-css {
  @each $name, $value in $object-fit-values {
    .object-#{$name}-xxs {
      object-fit: $value;       
    }   
  }
  
  @each $name, $value in $object-fit-values {
    .child-object-#{$name}-xxs * {
      object-fit: $value;       
    }   
  }  
}