mirror of
https://github.com/twbs/bootstrap.git
synced 2025-02-28 00:54:30 +01:00
953 lines
86 KiB
HTML
953 lines
86 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="description" content="The utility API is a Sass-based tool to generate utility classes.">
|
||
<meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors">
|
||
<meta name="generator" content="Hugo 0.88.1">
|
||
|
||
<meta name="docsearch:language" content="en">
|
||
<meta name="docsearch:version" content="5.1">
|
||
|
||
<title>Utility API · Bootstrap v5.1</title>
|
||
|
||
<link rel="canonical" href="https://getbootstrap.com/docs/5.1/utilities/api/">
|
||
|
||
|
||
|
||
<!-- Bootstrap core CSS -->
|
||
<link href="/docs/5.1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
|
||
|
||
<link href="/docs/5.1/assets/css/docs.css" rel="stylesheet">
|
||
|
||
<!-- Favicons -->
|
||
<link rel="apple-touch-icon" href="/docs/5.1/assets/img/favicons/apple-touch-icon.png" sizes="180x180">
|
||
<link rel="icon" href="/docs/5.1/assets/img/favicons/favicon-32x32.png" sizes="32x32" type="image/png">
|
||
<link rel="icon" href="/docs/5.1/assets/img/favicons/favicon-16x16.png" sizes="16x16" type="image/png">
|
||
<link rel="manifest" href="/docs/5.1/assets/img/favicons/manifest.json">
|
||
<link rel="mask-icon" href="/docs/5.1/assets/img/favicons/safari-pinned-tab.svg" color="#7952b3">
|
||
<link rel="icon" href="/docs/5.1/assets/img/favicons/favicon.ico">
|
||
<meta name="theme-color" content="#7952b3">
|
||
|
||
<!-- Twitter -->
|
||
<meta name="twitter:card" content="summary">
|
||
<meta name="twitter:site" content="@getbootstrap">
|
||
<meta name="twitter:creator" content="@getbootstrap">
|
||
<meta name="twitter:title" content="Utility API">
|
||
<meta name="twitter:description" content="The utility API is a Sass-based tool to generate utility classes.">
|
||
<meta name="twitter:image" content="https://getbootstrap.com/docs/5.1/assets/brand/bootstrap-social.png">
|
||
|
||
<!-- Facebook -->
|
||
<meta property="og:url" content="https://getbootstrap.com/docs/5.1/utilities/api/">
|
||
<meta property="og:title" content="Utility API">
|
||
<meta property="og:description" content="The utility API is a Sass-based tool to generate utility classes.">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:image" content="https://getbootstrap.com/docs/5.1/assets/brand/bootstrap-social.png">
|
||
<meta property="og:image:type" content="image/png">
|
||
<meta property="og:image:width" content="1000">
|
||
<meta property="og:image:height" content="500">
|
||
|
||
<script defer src="https://cdn.usefathom.com/script.js" data-site="ITUSEYJG"></script>
|
||
<script>
|
||
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
|
||
ga('create', 'UA-146052-10', 'getbootstrap.com');
|
||
ga('set', 'anonymizeIp', true);
|
||
ga('send', 'pageview');
|
||
</script>
|
||
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
||
|
||
|
||
</head>
|
||
<body>
|
||
<div class="skippy visually-hidden-focusable overflow-hidden">
|
||
<div class="container-xl">
|
||
<a class="d-inline-flex p-2 m-1" href="#content">Skip to main content</a>
|
||
<a class="d-none d-md-inline-flex p-2 m-1" href="#bd-docs-nav">Skip to docs navigation</a>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<header class="navbar navbar-expand-md navbar-dark bd-navbar">
|
||
<nav class="container-xxl flex-wrap flex-md-nowrap" aria-label="Main navigation">
|
||
<a class="navbar-brand p-0 me-2" href="/" aria-label="Bootstrap">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="32" class="d-block my-1" viewBox="0 0 118 94" role="img"><title>Bootstrap</title><path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z" fill="currentColor"/></svg>
|
||
</a>
|
||
|
||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#bdNavbar" aria-controls="bdNavbar" aria-expanded="false" aria-label="Toggle navigation">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" class="bi" fill="currentColor" viewBox="0 0 16 16">
|
||
<path fill-rule="evenodd" d="M2.5 11.5A.5.5 0 0 1 3 11h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5zm0-4A.5.5 0 0 1 3 7h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5zm0-4A.5.5 0 0 1 3 3h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5z"/>
|
||
</svg>
|
||
|
||
</button>
|
||
|
||
<div class="collapse navbar-collapse" id="bdNavbar">
|
||
<ul class="navbar-nav flex-row flex-wrap bd-navbar-nav pt-2 py-md-0">
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Bootstrap');">Home</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2 active" aria-current="true" href="/docs/5.1/getting-started/introduction/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Docs');">Docs</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="/docs/5.1/examples/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Examples');">Examples</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://icons.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Icons');" target="_blank" rel="noopener">Icons</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://themes.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Themes');" target="_blank" rel="noopener">Themes</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://blog.getbootstrap.com/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Blog');" target="_blank" rel="noopener">Blog</a>
|
||
</li>
|
||
</ul>
|
||
|
||
<hr class="d-md-none text-white-50">
|
||
|
||
<ul class="navbar-nav flex-row flex-wrap ms-md-auto">
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://github.com/twbs" target="_blank" rel="noopener">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" class="navbar-nav-svg d-inline-block align-text-top" viewBox="0 0 512 499.36" role="img"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg>
|
||
<small class="d-md-none ms-2">GitHub</small>
|
||
</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://twitter.com/getbootstrap" target="_blank" rel="noopener">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" class="navbar-nav-svg d-inline-block align-text-top" viewBox="0 0 512 416.32" role="img"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg>
|
||
<small class="d-md-none ms-2">Twitter</small>
|
||
</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://bootstrap-slack.herokuapp.com/" target="_blank" rel="noopener">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" class="navbar-nav-svg d-inline-block align-text-top" viewBox="0 0 512 512" role="img"><title>Slack</title><path fill="currentColor" d="M210.787 234.832l68.31-22.883 22.1 65.977-68.309 22.882z"/><path fill="currentColor" d="M490.54 185.6C437.7 9.59 361.6-31.34 185.6 21.46S-31.3 150.4 21.46 326.4 150.4 543.3 326.4 490.54 543.34 361.6 490.54 185.6zM401.7 299.8l-33.15 11.05 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.38-68.36 22.92 11.46 34.38c4.5 13.92-2.87 29.06-16.78 33.56-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18l-11.46-34.43-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.5-13.92 2.87-29.06 16.78-33.56l33.12-11.03-22.1-65.9-33.15 11.05c-2.87.82-6.14 1.64-9 1.23a27.32 27.32 0 0 1-24.56-18c-4.48-13.93 2.89-29.07 16.81-33.58l33.15-11.05-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.46 34.38 68.36-22.92-11.46-34.38c-4.5-13.92 2.87-29.06 16.78-33.56s29.06 2.87 33.56 16.78l11.47 34.42 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.87 29.06-16.78 33.56L329.7 194.6l22.1 65.9 33.15-11.05c13.92-4.5 29.06 2.87 33.56 16.78s-2.88 29.07-16.81 33.57z"/></svg>
|
||
<small class="d-md-none ms-2">Slack</small>
|
||
</a>
|
||
</li>
|
||
<li class="nav-item col-6 col-md-auto">
|
||
<a class="nav-link p-2" href="https://opencollective.com/bootstrap" target="_blank" rel="noopener">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" fill="currentColor" fill-rule="evenodd" class="navbar-nav-svg d-inline-block align-text-top" viewBox="0 0 40 41" role="img"><title>Open Collective</title><path fill-opacity=".4" d="M32.8 21c0 2.4-.8 4.9-2 6.9l5.1 5.1c2.5-3.4 4.1-7.6 4.1-12 0-4.6-1.6-8.8-4-12.2L30.7 14c1.2 2 2 4.3 2 7z"/><path d="M20 33.7a12.8 12.8 0 0 1 0-25.6c2.6 0 5 .7 7 2.1L32 5a20 20 0 1 0 .1 31.9l-5-5.2a13 13 0 0 1-7 2z"/></svg>
|
||
<small class="d-md-none ms-2">Open Collective</small>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
|
||
<a class="btn btn-bd-download d-lg-inline-block my-2 my-md-0 ms-md-3" href="/docs/5.1/getting-started/download/">Download</a>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
|
||
|
||
|
||
<nav class="bd-subnavbar py-2" aria-label="Secondary navigation">
|
||
<div class="container-xxl d-flex align-items-md-center">
|
||
<form class="bd-search position-relative me-auto">
|
||
<input type="search" class="form-control" id="search-input" placeholder="Search docs..." aria-label="Search docs for..." autocomplete="off" data-bd-docs-version="5.1">
|
||
</form>
|
||
|
||
<div class="dropdown ms-3">
|
||
<button class="btn btn-bd-light dropdown-toggle" id="bd-versions" data-bs-toggle="dropdown" aria-expanded="false" data-bs-display="static">
|
||
<span class="d-none d-lg-inline">Bootstrap</span> v5.1
|
||
</button>
|
||
<ul class="dropdown-menu dropdown-menu-end" aria-labelledby="bd-versions">
|
||
<li><a class="dropdown-item current" aria-current="true" href="/docs/5.1/">Latest (5.1.x)</a></li>
|
||
<li><hr class="dropdown-divider"></li>
|
||
<li><a class="dropdown-item" href="https://getbootstrap.com/docs/4.6/">v4.6.x</a></li>
|
||
<li><a class="dropdown-item" href="https://getbootstrap.com/docs/3.4/">v3.4.1</a></li>
|
||
<li><a class="dropdown-item" href="https://getbootstrap.com/2.3.2/">v2.3.2</a></li>
|
||
<li><hr class="dropdown-divider"></li>
|
||
<li><a class="dropdown-item" href="/docs/versions/">All versions</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<button class="btn bd-sidebar-toggle d-md-none py-0 px-1 ms-3 order-3 collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#bd-docs-nav" aria-controls="bd-docs-nav" aria-expanded="false" aria-label="Toggle docs navigation">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" class="bi bi-expand" fill="currentColor" viewBox="0 0 16 16">
|
||
<title>Expand</title>
|
||
<path fill-rule="evenodd" d="M1 8a.5.5 0 0 1 .5-.5h13a.5.5 0 0 1 0 1h-13A.5.5 0 0 1 1 8zM7.646.146a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1-.708.708L8.5 1.707V5.5a.5.5 0 0 1-1 0V1.707L6.354 2.854a.5.5 0 1 1-.708-.708l2-2zM8 10a.5.5 0 0 1 .5.5v3.793l1.146-1.147a.5.5 0 0 1 .708.708l-2 2a.5.5 0 0 1-.708 0l-2-2a.5.5 0 0 1 .708-.708L7.5 14.293V10.5A.5.5 0 0 1 8 10z"/>
|
||
</svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" class="bi bi-collapse" fill="currentColor" viewBox="0 0 16 16">
|
||
<title>Collapse</title>
|
||
<path fill-rule="evenodd" d="M1 8a.5.5 0 0 1 .5-.5h13a.5.5 0 0 1 0 1h-13A.5.5 0 0 1 1 8zm7-8a.5.5 0 0 1 .5.5v3.793l1.146-1.147a.5.5 0 0 1 .708.708l-2 2a.5.5 0 0 1-.708 0l-2-2a.5.5 0 1 1 .708-.708L7.5 4.293V.5A.5.5 0 0 1 8 0zm-.5 11.707l-1.146 1.147a.5.5 0 0 1-.708-.708l2-2a.5.5 0 0 1 .708 0l2 2a.5.5 0 0 1-.708.708L8.5 11.707V15.5a.5.5 0 0 1-1 0v-3.793z"/>
|
||
</svg>
|
||
|
||
</button>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
<div class="container-xxl my-md-4 bd-layout">
|
||
<aside class="bd-sidebar">
|
||
<nav class="collapse bd-links" id="bd-docs-nav" aria-label="Docs navigation"><ul class="list-unstyled mb-0 py-3 pt-md-1">
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#getting-started-collapse" aria-expanded="false">
|
||
Getting started
|
||
</button>
|
||
|
||
<div class="collapse" id="getting-started-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/getting-started/introduction/" class="d-inline-flex align-items-center rounded">Introduction</a></li>
|
||
<li><a href="/docs/5.1/getting-started/download/" class="d-inline-flex align-items-center rounded">Download</a></li>
|
||
<li><a href="/docs/5.1/getting-started/contents/" class="d-inline-flex align-items-center rounded">Contents</a></li>
|
||
<li><a href="/docs/5.1/getting-started/browsers-devices/" class="d-inline-flex align-items-center rounded">Browsers & devices</a></li>
|
||
<li><a href="/docs/5.1/getting-started/javascript/" class="d-inline-flex align-items-center rounded">JavaScript</a></li>
|
||
<li><a href="/docs/5.1/getting-started/webpack/" class="d-inline-flex align-items-center rounded">Webpack</a></li>
|
||
<li><a href="/docs/5.1/getting-started/parcel/" class="d-inline-flex align-items-center rounded">Parcel</a></li>
|
||
<li><a href="/docs/5.1/getting-started/accessibility/" class="d-inline-flex align-items-center rounded">Accessibility</a></li>
|
||
<li><a href="/docs/5.1/getting-started/rfs/" class="d-inline-flex align-items-center rounded">RFS</a></li>
|
||
<li><a href="/docs/5.1/getting-started/rtl/" class="d-inline-flex align-items-center rounded">RTL</a></li>
|
||
<li><a href="/docs/5.1/getting-started/contribute/" class="d-inline-flex align-items-center rounded">Contribute</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#customize-collapse" aria-expanded="false">
|
||
Customize
|
||
</button>
|
||
|
||
<div class="collapse" id="customize-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/customize/overview/" class="d-inline-flex align-items-center rounded">Overview</a></li>
|
||
<li><a href="/docs/5.1/customize/sass/" class="d-inline-flex align-items-center rounded">Sass</a></li>
|
||
<li><a href="/docs/5.1/customize/options/" class="d-inline-flex align-items-center rounded">Options</a></li>
|
||
<li><a href="/docs/5.1/customize/color/" class="d-inline-flex align-items-center rounded">Color</a></li>
|
||
<li><a href="/docs/5.1/customize/components/" class="d-inline-flex align-items-center rounded">Components</a></li>
|
||
<li><a href="/docs/5.1/customize/css-variables/" class="d-inline-flex align-items-center rounded">CSS variables</a></li>
|
||
<li><a href="/docs/5.1/customize/optimize/" class="d-inline-flex align-items-center rounded">Optimize</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#layout-collapse" aria-expanded="false">
|
||
Layout
|
||
</button>
|
||
|
||
<div class="collapse" id="layout-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/layout/breakpoints/" class="d-inline-flex align-items-center rounded">Breakpoints</a></li>
|
||
<li><a href="/docs/5.1/layout/containers/" class="d-inline-flex align-items-center rounded">Containers</a></li>
|
||
<li><a href="/docs/5.1/layout/grid/" class="d-inline-flex align-items-center rounded">Grid</a></li>
|
||
<li><a href="/docs/5.1/layout/columns/" class="d-inline-flex align-items-center rounded">Columns</a></li>
|
||
<li><a href="/docs/5.1/layout/gutters/" class="d-inline-flex align-items-center rounded">Gutters</a></li>
|
||
<li><a href="/docs/5.1/layout/utilities/" class="d-inline-flex align-items-center rounded">Utilities</a></li>
|
||
<li><a href="/docs/5.1/layout/z-index/" class="d-inline-flex align-items-center rounded">Z-index</a></li>
|
||
<li><a href="/docs/5.1/layout/css-grid/" class="d-inline-flex align-items-center rounded">CSS Grid</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#content-collapse" aria-expanded="false">
|
||
Content
|
||
</button>
|
||
|
||
<div class="collapse" id="content-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/content/reboot/" class="d-inline-flex align-items-center rounded">Reboot</a></li>
|
||
<li><a href="/docs/5.1/content/typography/" class="d-inline-flex align-items-center rounded">Typography</a></li>
|
||
<li><a href="/docs/5.1/content/images/" class="d-inline-flex align-items-center rounded">Images</a></li>
|
||
<li><a href="/docs/5.1/content/tables/" class="d-inline-flex align-items-center rounded">Tables</a></li>
|
||
<li><a href="/docs/5.1/content/figures/" class="d-inline-flex align-items-center rounded">Figures</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#forms-collapse" aria-expanded="false">
|
||
Forms
|
||
</button>
|
||
|
||
<div class="collapse" id="forms-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/forms/overview/" class="d-inline-flex align-items-center rounded">Overview</a></li>
|
||
<li><a href="/docs/5.1/forms/form-control/" class="d-inline-flex align-items-center rounded">Form control</a></li>
|
||
<li><a href="/docs/5.1/forms/select/" class="d-inline-flex align-items-center rounded">Select</a></li>
|
||
<li><a href="/docs/5.1/forms/checks-radios/" class="d-inline-flex align-items-center rounded">Checks & radios</a></li>
|
||
<li><a href="/docs/5.1/forms/range/" class="d-inline-flex align-items-center rounded">Range</a></li>
|
||
<li><a href="/docs/5.1/forms/input-group/" class="d-inline-flex align-items-center rounded">Input group</a></li>
|
||
<li><a href="/docs/5.1/forms/floating-labels/" class="d-inline-flex align-items-center rounded">Floating labels</a></li>
|
||
<li><a href="/docs/5.1/forms/layout/" class="d-inline-flex align-items-center rounded">Layout</a></li>
|
||
<li><a href="/docs/5.1/forms/validation/" class="d-inline-flex align-items-center rounded">Validation</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#components-collapse" aria-expanded="false">
|
||
Components
|
||
</button>
|
||
|
||
<div class="collapse" id="components-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/components/accordion/" class="d-inline-flex align-items-center rounded">Accordion</a></li>
|
||
<li><a href="/docs/5.1/components/alerts/" class="d-inline-flex align-items-center rounded">Alerts</a></li>
|
||
<li><a href="/docs/5.1/components/badge/" class="d-inline-flex align-items-center rounded">Badge</a></li>
|
||
<li><a href="/docs/5.1/components/breadcrumb/" class="d-inline-flex align-items-center rounded">Breadcrumb</a></li>
|
||
<li><a href="/docs/5.1/components/buttons/" class="d-inline-flex align-items-center rounded">Buttons</a></li>
|
||
<li><a href="/docs/5.1/components/button-group/" class="d-inline-flex align-items-center rounded">Button group</a></li>
|
||
<li><a href="/docs/5.1/components/card/" class="d-inline-flex align-items-center rounded">Card</a></li>
|
||
<li><a href="/docs/5.1/components/carousel/" class="d-inline-flex align-items-center rounded">Carousel</a></li>
|
||
<li><a href="/docs/5.1/components/close-button/" class="d-inline-flex align-items-center rounded">Close button</a></li>
|
||
<li><a href="/docs/5.1/components/collapse/" class="d-inline-flex align-items-center rounded">Collapse</a></li>
|
||
<li><a href="/docs/5.1/components/dropdowns/" class="d-inline-flex align-items-center rounded">Dropdowns</a></li>
|
||
<li><a href="/docs/5.1/components/list-group/" class="d-inline-flex align-items-center rounded">List group</a></li>
|
||
<li><a href="/docs/5.1/components/modal/" class="d-inline-flex align-items-center rounded">Modal</a></li>
|
||
<li><a href="/docs/5.1/components/navs-tabs/" class="d-inline-flex align-items-center rounded">Navs & tabs</a></li>
|
||
<li><a href="/docs/5.1/components/navbar/" class="d-inline-flex align-items-center rounded">Navbar</a></li>
|
||
<li><a href="/docs/5.1/components/offcanvas/" class="d-inline-flex align-items-center rounded">Offcanvas</a></li>
|
||
<li><a href="/docs/5.1/components/pagination/" class="d-inline-flex align-items-center rounded">Pagination</a></li>
|
||
<li><a href="/docs/5.1/components/placeholders/" class="d-inline-flex align-items-center rounded">Placeholders</a></li>
|
||
<li><a href="/docs/5.1/components/popovers/" class="d-inline-flex align-items-center rounded">Popovers</a></li>
|
||
<li><a href="/docs/5.1/components/progress/" class="d-inline-flex align-items-center rounded">Progress</a></li>
|
||
<li><a href="/docs/5.1/components/scrollspy/" class="d-inline-flex align-items-center rounded">Scrollspy</a></li>
|
||
<li><a href="/docs/5.1/components/spinners/" class="d-inline-flex align-items-center rounded">Spinners</a></li>
|
||
<li><a href="/docs/5.1/components/toasts/" class="d-inline-flex align-items-center rounded">Toasts</a></li>
|
||
<li><a href="/docs/5.1/components/tooltips/" class="d-inline-flex align-items-center rounded">Tooltips</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#helpers-collapse" aria-expanded="false">
|
||
Helpers
|
||
</button>
|
||
|
||
<div class="collapse" id="helpers-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/helpers/clearfix/" class="d-inline-flex align-items-center rounded">Clearfix</a></li>
|
||
<li><a href="/docs/5.1/helpers/colored-links/" class="d-inline-flex align-items-center rounded">Colored links</a></li>
|
||
<li><a href="/docs/5.1/helpers/ratio/" class="d-inline-flex align-items-center rounded">Ratio</a></li>
|
||
<li><a href="/docs/5.1/helpers/position/" class="d-inline-flex align-items-center rounded">Position</a></li>
|
||
<li><a href="/docs/5.1/helpers/stacks/" class="d-inline-flex align-items-center rounded">Stacks</a></li>
|
||
<li><a href="/docs/5.1/helpers/visually-hidden/" class="d-inline-flex align-items-center rounded">Visually hidden</a></li>
|
||
<li><a href="/docs/5.1/helpers/stretched-link/" class="d-inline-flex align-items-center rounded">Stretched link</a></li>
|
||
<li><a href="/docs/5.1/helpers/text-truncation/" class="d-inline-flex align-items-center rounded">Text truncation</a></li>
|
||
<li><a href="/docs/5.1/helpers/vertical-rule/" class="d-inline-flex align-items-center rounded">Vertical rule</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded" data-bs-toggle="collapse" data-bs-target="#utilities-collapse" aria-expanded="true" aria-current="true">
|
||
Utilities
|
||
</button>
|
||
|
||
<div class="collapse show" id="utilities-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/utilities/api/" class="d-inline-flex align-items-center rounded active" aria-current="page">API</a></li>
|
||
<li><a href="/docs/5.1/utilities/background/" class="d-inline-flex align-items-center rounded">Background</a></li>
|
||
<li><a href="/docs/5.1/utilities/borders/" class="d-inline-flex align-items-center rounded">Borders</a></li>
|
||
<li><a href="/docs/5.1/utilities/colors/" class="d-inline-flex align-items-center rounded">Colors</a></li>
|
||
<li><a href="/docs/5.1/utilities/display/" class="d-inline-flex align-items-center rounded">Display</a></li>
|
||
<li><a href="/docs/5.1/utilities/flex/" class="d-inline-flex align-items-center rounded">Flex</a></li>
|
||
<li><a href="/docs/5.1/utilities/float/" class="d-inline-flex align-items-center rounded">Float</a></li>
|
||
<li><a href="/docs/5.1/utilities/interactions/" class="d-inline-flex align-items-center rounded">Interactions</a></li>
|
||
<li><a href="/docs/5.1/utilities/opacity/" class="d-inline-flex align-items-center rounded">Opacity</a></li>
|
||
<li><a href="/docs/5.1/utilities/overflow/" class="d-inline-flex align-items-center rounded">Overflow</a></li>
|
||
<li><a href="/docs/5.1/utilities/position/" class="d-inline-flex align-items-center rounded">Position</a></li>
|
||
<li><a href="/docs/5.1/utilities/shadows/" class="d-inline-flex align-items-center rounded">Shadows</a></li>
|
||
<li><a href="/docs/5.1/utilities/sizing/" class="d-inline-flex align-items-center rounded">Sizing</a></li>
|
||
<li><a href="/docs/5.1/utilities/spacing/" class="d-inline-flex align-items-center rounded">Spacing</a></li>
|
||
<li><a href="/docs/5.1/utilities/text/" class="d-inline-flex align-items-center rounded">Text</a></li>
|
||
<li><a href="/docs/5.1/utilities/vertical-align/" class="d-inline-flex align-items-center rounded">Vertical align</a></li>
|
||
<li><a href="/docs/5.1/utilities/visibility/" class="d-inline-flex align-items-center rounded">Visibility</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#extend-collapse" aria-expanded="false">
|
||
Extend
|
||
</button>
|
||
|
||
<div class="collapse" id="extend-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/extend/approach/" class="d-inline-flex align-items-center rounded">Approach</a></li>
|
||
<li><a href="/docs/5.1/extend/icons/" class="d-inline-flex align-items-center rounded">Icons</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="mb-1">
|
||
<button class="btn d-inline-flex align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#about-collapse" aria-expanded="false">
|
||
About
|
||
</button>
|
||
|
||
<div class="collapse" id="about-collapse">
|
||
<ul class="list-unstyled fw-normal pb-1 small">
|
||
<li><a href="/docs/5.1/about/overview/" class="d-inline-flex align-items-center rounded">Overview</a></li>
|
||
<li><a href="/docs/5.1/about/team/" class="d-inline-flex align-items-center rounded">Team</a></li>
|
||
<li><a href="/docs/5.1/about/brand/" class="d-inline-flex align-items-center rounded">Brand</a></li>
|
||
<li><a href="/docs/5.1/about/license/" class="d-inline-flex align-items-center rounded">License</a></li>
|
||
<li><a href="/docs/5.1/about/translations/" class="d-inline-flex align-items-center rounded">Translations</a></li>
|
||
</ul>
|
||
</div>
|
||
</li>
|
||
<li class="my-3 mx-4 border-top"></li>
|
||
<li>
|
||
<a href="/docs/5.1/migration/" class="d-inline-flex align-items-center rounded">
|
||
Migration
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
|
||
</aside>
|
||
|
||
<main class="bd-main order-1">
|
||
<div class="bd-intro ps-lg-4">
|
||
<div class="d-md-flex flex-md-row-reverse align-items-center justify-content-between">
|
||
<a class="btn btn-sm btn-bd-light mb-2 mb-md-0" href="https://github.com/twbs/bootstrap/blob/main/site/content/docs/5.1/utilities/api.md" title="View and edit this file on GitHub" target="_blank" rel="noopener">View on GitHub</a>
|
||
<h1 class="bd-title" id="content">Utility API</h1>
|
||
</div>
|
||
<p class="bd-lead">The utility API is a Sass-based tool to generate utility classes.</p>
|
||
<script async src="https://cdn.carbonads.com/carbon.js?serve=CKYIKKJL&placement=getbootstrapcom" id="_carbonads_js"></script>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="bd-toc mt-4 mb-5 my-md-0 ps-xl-3 mb-lg-5 text-muted">
|
||
<strong class="d-block h6 my-2 pb-2 border-bottom">On this page</strong>
|
||
<nav id="TableOfContents">
|
||
<ul>
|
||
<li><a href="#api-explained">API explained</a>
|
||
<ul>
|
||
<li><a href="#property">Property</a></li>
|
||
<li><a href="#values">Values</a></li>
|
||
<li><a href="#class">Class</a></li>
|
||
<li><a href="#css-variable-utilities">CSS variable utilities</a></li>
|
||
<li><a href="#local-css-variables">Local CSS variables</a></li>
|
||
<li><a href="#states">States</a></li>
|
||
<li><a href="#responsive">Responsive</a></li>
|
||
<li><a href="#print">Print</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#importance">Importance</a></li>
|
||
<li><a href="#using-the-api">Using the API</a>
|
||
<ul>
|
||
<li><a href="#override-utilities">Override utilities</a></li>
|
||
<li><a href="#add-utilities">Add utilities</a></li>
|
||
<li><a href="#modify-utilities">Modify utilities</a>
|
||
<ul>
|
||
<li><a href="#enable-responsive">Enable responsive</a></li>
|
||
<li><a href="#rename-utilities">Rename utilities</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#remove-utilities">Remove utilities</a>
|
||
<ul>
|
||
<li><a href="#remove-utility-in-rtl">Remove utility in RTL</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
|
||
|
||
<div class="bd-content ps-lg-4">
|
||
|
||
|
||
<p>Bootstrap utilities are generated with our utility API and can be used to modify or extend our default set of utility classes via Sass. Our utility API is based on a series of Sass maps and functions for generating families of classes with various options. If you’re unfamiliar with Sass maps, read up on the <a href="https://sass-lang.com/documentation/values/maps">official Sass docs</a> to get started.</p>
|
||
<p>The <code>$utilities</code> map contains all our utilities and is later merged with your custom <code>$utilities</code> map, if present. The utility map contains a keyed list of utility groups which accept the following options:</p>
|
||
<table class="table text-start">
|
||
<thead>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><a href="#property"><code>property</code></a></td>
|
||
<td><strong>Required</strong></td>
|
||
<td>–</td>
|
||
<td>Name of the property, this can be a string or an array of strings (e.g., horizontal paddings or margins).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#values"><code>values</code></a></td>
|
||
<td><strong>Required</strong></td>
|
||
<td>–</td>
|
||
<td>List of values, or a map if you don’t want the class name to be the same as the value. If <code>null</code> is used as map key, it isn’t compiled.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#class"><code>class</code></a></td>
|
||
<td>Optional</td>
|
||
<td>null</td>
|
||
<td>Name of the generated class. If not provided and <code>property</code> is an array of strings, <code>class</code> will default to the first element of the <code>property</code> array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#css-variable-utilities"><code>css-var</code></a></td>
|
||
<td>Optional</td>
|
||
<td><code>false</code></td>
|
||
<td>Boolean to generate CSS variables instead of CSS rules.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#local-css-variables"><code>local-vars</code></a></td>
|
||
<td>Optional</td>
|
||
<td>null</td>
|
||
<td>Map of local CSS variables to generate in addition to the CSS rules.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#states"><code>state</code></a></td>
|
||
<td>Optional</td>
|
||
<td>null</td>
|
||
<td>List of pseudo-class variants (e.g., <code>:hover</code> or <code>:focus</code>) to generate.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#responsive"><code>responsive</code></a></td>
|
||
<td>Optional</td>
|
||
<td><code>false</code></td>
|
||
<td>Boolean indicating if responsive classes should be generated.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>rfs</code></td>
|
||
<td>Optional</td>
|
||
<td><code>false</code></td>
|
||
<td>Boolean to enable <a href="/docs/5.1/getting-started/rfs/">fluid rescaling with RFS</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="#print"><code>print</code></a></td>
|
||
<td>Optional</td>
|
||
<td><code>false</code></td>
|
||
<td>Boolean indicating if print classes need to be generated.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>rtl</code></td>
|
||
<td>Optional</td>
|
||
<td><code>true</code></td>
|
||
<td>Boolean indicating if utility should be kept in RTL.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<h2 id="api-explained">API explained</h2>
|
||
<p>All utility variables are added to the <code>$utilities</code> variable within our <code>_utilities.scss</code> stylesheet. Each group of utilities looks something like this:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Which outputs the following:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">opacity-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span><span class="p">;</span> <span class="p">}</span>
|
||
</code></pre></div><h3 id="property">Property</h3>
|
||
<p>The required <code>property</code> key must be set for any utility, and it must contain a valid CSS property. This property is used in the generated utility’s ruleset. When the <code>class</code> key is omitted, it also serves as the default class name. Consider the <code>text-decoration</code> utility:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"text-decoration"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">text</span><span class="o">-</span><span class="n">decoration</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="ni">none</span> <span class="ni">underline</span> <span class="ni">line-through</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">text-decoration-none</span> <span class="p">{</span> <span class="k">text-decoration</span><span class="p">:</span> <span class="kc">none</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">text-decoration-underline</span> <span class="p">{</span> <span class="k">text-decoration</span><span class="p">:</span> <span class="kc">underline</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">text-decoration-line-through</span> <span class="p">{</span> <span class="k">text-decoration</span><span class="p">:</span> <span class="kc">line-through</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
</code></pre></div><h3 id="values">Values</h3>
|
||
<p>Use the <code>values</code> key to specify which values for the specified <code>property</code> should be used in the generated class names and rules. Can be a list or map (set in the utilities or in a Sass variable).</p>
|
||
<p>As a list, like with <a href="/docs/5.1/utilities/text/#text-decoration"><code>text-decoration</code> utilities</a>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nt">values</span><span class="nd">:</span> <span class="nt">none</span> <span class="nt">underline</span> <span class="nt">line-through</span>
|
||
</code></pre></div><p>As a map, like with <a href="/docs/5.1/utilities/opacity/"><code>opacity</code> utilities</a>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
</code></pre></div><p>As a Sass variable that sets the list or map, as in our <a href="/docs/5.1/utilities/position/"><code>position</code> utilities</a>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nt">values</span><span class="nd">:</span> <span class="err">$</span><span class="nt">position-values</span>
|
||
</code></pre></div><h3 id="class">Class</h3>
|
||
<p>Use the <code>class</code> option to change the class prefix used in the compiled CSS. For example, to change from <code>.opacity-*</code> to <code>.o-*</code>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="n">o</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">o-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">o-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">o-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">o-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">o-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
</code></pre></div><h3 id="css-variable-utilities">CSS variable utilities</h3>
|
||
<p>Set the <code>css-var</code> boolean option to <code>true</code> and the API will generate local CSS variables for the given selector instead of the usual <code>property: value</code> rules. Consider our <code>.text-opacity-*</code> utilities:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"text-opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">css-var</span><span class="o">:</span> <span class="n">true</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="ni">text</span><span class="o">-</span><span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">text-opacity-25</span> <span class="p">{</span> <span class="nv">--bs-text-opacity</span><span class="p">:</span> <span class="mf">.25</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">text-opacity-50</span> <span class="p">{</span> <span class="nv">--bs-text-opacity</span><span class="p">:</span> <span class="mf">.5</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">text-opacity-75</span> <span class="p">{</span> <span class="nv">--bs-text-opacity</span><span class="p">:</span> <span class="mf">.75</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">text-opacity-100</span> <span class="p">{</span> <span class="nv">--bs-text-opacity</span><span class="p">:</span> <span class="mi">1</span><span class="p">;</span> <span class="p">}</span>
|
||
</code></pre></div><h3 id="local-css-variables">Local CSS variables</h3>
|
||
<p>Use the <code>local-vars</code> option to specify a Sass map that will generate local CSS variables within the utility class’s ruleset. Please note that it may require additional work to consume those local CSS variables in the generated CSS rules. For example, consider our <code>.bg-*</code> utilities:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"background-color"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="n">background-color</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="n">bg</span><span class="o">,</span>
|
||
<span class="na">local-vars</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"bg-opacity"</span><span class="o">:</span> <span class="mi">1</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities-bg-colors</span><span class="o">,</span>
|
||
<span class="p">(</span>
|
||
<span class="s2">"transparent"</span><span class="o">:</span> <span class="ni">transparent</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">bg-primary</span> <span class="p">{</span>
|
||
<span class="nv">--bs-bg-opacity</span><span class="p">:</span> <span class="mi">1</span><span class="p">;</span>
|
||
<span class="k">background-color</span><span class="p">:</span> <span class="nb">rgba</span><span class="p">(</span><span class="nf">var</span><span class="p">(</span><span class="o">--</span><span class="n">bs</span><span class="o">-</span><span class="n">primary</span><span class="o">-</span><span class="n">rgb</span><span class="p">),</span> <span class="nf">var</span><span class="p">(</span><span class="o">--</span><span class="n">bs</span><span class="o">-</span><span class="n">bg</span><span class="o">-</span><span class="n">opacity</span><span class="p">))</span> <span class="cp">!important</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div><h3 id="states">States</h3>
|
||
<p>Use the <code>state</code> option to generate pseudo-class variations. Example pseudo-classes are <code>:hover</code> and <code>:focus</code>. When a list of states are provided, classnames are created for that pseudo-class. For example, to change opacity on hover, add <code>state: hover</code> and you’ll get <code>.opacity-hover:hover</code> in your compiled CSS.</p>
|
||
<p>Need multiple pseudo-classes? Use a space-separated list of states: <code>state: hover focus</code>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">state</span><span class="o">:</span> <span class="n">hover</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">opacity-0-hover</span><span class="p">:</span><span class="nd">hover</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-25-hover</span><span class="p">:</span><span class="nd">hover</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-50-hover</span><span class="p">:</span><span class="nd">hover</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-75-hover</span><span class="p">:</span><span class="nd">hover</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-100-hover</span><span class="p">:</span><span class="nd">hover</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
</code></pre></div><h3 id="responsive">Responsive</h3>
|
||
<p>Add the <code>responsive</code> boolean to generate responsive utilities (e.g., <code>.opacity-md-25</code>) across <a href="/docs/5.1/layout/breakpoints/">all breakpoints</a>.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">responsive</span><span class="o">:</span> <span class="n">true</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">opacity-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">576px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-sm-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-sm-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-sm-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-sm-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-sm-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">768px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-md-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-md-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-md-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-md-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-md-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">992px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-lg-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-lg-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-lg-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-lg-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-lg-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">1200px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-xl-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xl-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xl-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xl-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xl-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">1400px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-xxl-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xxl-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xxl-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xxl-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-xxl-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div><h3 id="print">Print</h3>
|
||
<p>Enabling the <code>print</code> option will <strong>also</strong> generate utility classes for print, which are only applied within the <code>@media print { ... }</code> media query.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"opacity"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="ni">opacity</span><span class="o">,</span>
|
||
<span class="na">print</span><span class="o">:</span> <span class="n">true</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">0</span><span class="o">:</span> <span class="mi">0</span><span class="o">,</span>
|
||
<span class="na">25</span><span class="o">:</span> <span class="mf">.25</span><span class="o">,</span>
|
||
<span class="na">50</span><span class="o">:</span> <span class="mf">.5</span><span class="o">,</span>
|
||
<span class="na">75</span><span class="o">:</span> <span class="mf">.75</span><span class="o">,</span>
|
||
<span class="na">100</span><span class="o">:</span> <span class="mi">1</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">opacity-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="nt">print</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">opacity-print-0</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">0</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-print-25</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.25</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-print-50</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.5</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-print-75</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mf">.75</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">opacity-print-100</span> <span class="p">{</span> <span class="k">opacity</span><span class="p">:</span> <span class="mi">1</span> <span class="cp">!important</span><span class="p">;</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div><h2 id="importance">Importance</h2>
|
||
<p>All utilities generated by the API include <code>!important</code> to ensure they override components and modifier classes as intended. You can toggle this setting globally with the <code>$enable-important-utilities</code> variable (defaults to <code>true</code>).</p>
|
||
<h2 id="using-the-api">Using the API</h2>
|
||
<p>Now that you’re familiar with how the utilities API works, learn how to add your own custom classes and modify our default utilities.</p>
|
||
<h3 id="override-utilities">Override utilities</h3>
|
||
<p>Override existing utilities by using the same key. For example, if you want additional responsive overflow utility classes, you can do this:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"overflow"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">responsive</span><span class="o">:</span> <span class="n">true</span><span class="o">,</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="n">overflow</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="ni">visible</span> <span class="ni">hidden</span> <span class="ni">scroll</span> <span class="ni">auto</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><h3 id="add-utilities">Add utilities</h3>
|
||
<p>New utilities can be added to the default <code>$utilities</code> map with a <code>map-merge</code>. Make sure our required Sass files and <code>_utilities.scss</code> are imported first, then use the <code>map-merge</code> to add your additional utilities. For example, here’s how to add a responsive <code>cursor</code> utility with three values.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="k">@import</span> <span class="s2">"bootstrap/scss/functions"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/variables"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/utilities"</span><span class="p">;</span>
|
||
|
||
<span class="nv">$utilities</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities</span><span class="o">,</span>
|
||
<span class="p">(</span>
|
||
<span class="s2">"cursor"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="n">cursor</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="n">cursor</span><span class="o">,</span>
|
||
<span class="na">responsive</span><span class="o">:</span> <span class="n">true</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="ni">auto</span> <span class="ni">pointer</span> <span class="ni">grab</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><h3 id="modify-utilities">Modify utilities</h3>
|
||
<p>Modify existing utilities in the default <code>$utilities</code> map with <code>map-get</code> and <code>map-merge</code> functions. In the example below, we’re adding an additional value to the <code>width</code> utilities. Start with an initial <code>map-merge</code> and then specify which utility you want to modify. From there, fetch the nested <code>"width"</code> map with <code>map-get</code> to access and modify the utility’s options and values.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="k">@import</span> <span class="s2">"bootstrap/scss/functions"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/variables"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/utilities"</span><span class="p">;</span>
|
||
|
||
<span class="nv">$utilities</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities</span><span class="o">,</span>
|
||
<span class="p">(</span>
|
||
<span class="s2">"width"</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nf">map-get</span><span class="p">(</span><span class="nv">$utilities</span><span class="o">,</span> <span class="s2">"width"</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="p">(</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nf">map-get</span><span class="p">(</span><span class="nf">map-get</span><span class="p">(</span><span class="nv">$utilities</span><span class="o">,</span> <span class="s2">"width"</span><span class="p">)</span><span class="o">,</span> <span class="s2">"values"</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="p">(</span><span class="na">10</span><span class="o">:</span> <span class="mi">10</span><span class="kt">%</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><h4 id="enable-responsive">Enable responsive</h4>
|
||
<p>You can enable responsive classes for an existing set of utilities that are not currently responsive by default. For example, to make the <code>border</code> classes responsive:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="k">@import</span> <span class="s2">"bootstrap/scss/functions"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/variables"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/utilities"</span><span class="p">;</span>
|
||
|
||
<span class="nv">$utilities</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities</span><span class="o">,</span> <span class="p">(</span>
|
||
<span class="s2">"border"</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nf">map-get</span><span class="p">(</span><span class="nv">$utilities</span><span class="o">,</span> <span class="s2">"border"</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="p">(</span> <span class="na">responsive</span><span class="o">:</span> <span class="n">true</span> <span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>This will now generate responsive variations of <code>.border</code> and <code>.border-0</code> for each breakpoint. Your generated CSS will look like this:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="p">.</span><span class="nc">border</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">576px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">border-sm</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-sm-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">768px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">border-md</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-md-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">992px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">border-lg</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-lg-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">1200px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">border-xl</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-xl-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">@</span><span class="k">media</span> <span class="o">(</span><span class="nt">min-width</span><span class="o">:</span> <span class="nt">1400px</span><span class="o">)</span> <span class="p">{</span>
|
||
<span class="p">.</span><span class="nc">border-xxl</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">.</span><span class="nc">border-xxl-0</span> <span class="p">{</span> <span class="err">...</span> <span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre></div><h4 id="rename-utilities">Rename utilities</h4>
|
||
<p>Missing v4 utilities, or used to another naming convention? The utilities API can be used to override the resulting <code>class</code> of a given utility—for example, to rename <code>.ms-*</code> utilities to oldish <code>.ml-*</code>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="k">@import</span> <span class="s2">"bootstrap/scss/functions"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/variables"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/utilities"</span><span class="p">;</span>
|
||
|
||
<span class="nv">$utilities</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities</span><span class="o">,</span> <span class="p">(</span>
|
||
<span class="s2">"margin-start"</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nf">map-get</span><span class="p">(</span><span class="nv">$utilities</span><span class="o">,</span> <span class="s2">"margin-start"</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="p">(</span> <span class="na">class</span><span class="o">:</span> <span class="n">ml</span> <span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><h3 id="remove-utilities">Remove utilities</h3>
|
||
<p>Remove any of the default utilities by setting the group key to <code>null</code>. For example, to remove all our <code>width</code> utilities, create a <code>$utilities</code> <code>map-merge</code> and add <code>"width": null</code> within.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="k">@import</span> <span class="s2">"bootstrap/scss/functions"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/variables"</span><span class="p">;</span>
|
||
<span class="k">@import</span> <span class="s2">"bootstrap/scss/utilities"</span><span class="p">;</span>
|
||
|
||
<span class="nv">$utilities</span><span class="o">:</span> <span class="nf">map-merge</span><span class="p">(</span>
|
||
<span class="nv">$utilities</span><span class="o">,</span>
|
||
<span class="p">(</span>
|
||
<span class="s2">"width"</span><span class="o">:</span> <span class="n">null</span>
|
||
<span class="p">)</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><h4 id="remove-utility-in-rtl">Remove utility in RTL</h4>
|
||
<p>Some edge cases make <a href="https://rtlstyling.com/posts/rtl-styling#common-things-that-might-not-work-for-rtl">RTL styling difficult</a>, such as line breaks in Arabic. Thus utilities can be dropped from RTL output by setting the <code>rtl</code> option to <code>false</code>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-scss" data-lang="scss"><span class="nv">$utilities</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="s2">"word-wrap"</span><span class="o">:</span> <span class="p">(</span>
|
||
<span class="na">property</span><span class="o">:</span> <span class="n">word-wrap</span> <span class="n">word-break</span><span class="o">,</span>
|
||
<span class="na">class</span><span class="o">:</span> <span class="ni">text</span><span class="o">,</span>
|
||
<span class="na">values</span><span class="o">:</span> <span class="p">(</span><span class="na">break</span><span class="o">:</span> <span class="ni">break-word</span><span class="p">)</span><span class="o">,</span>
|
||
<span class="na">rtl</span><span class="o">:</span> <span class="n">false</span>
|
||
<span class="p">)</span><span class="o">,</span>
|
||
<span class="p">);</span>
|
||
</code></pre></div><p>Output:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-css" data-lang="css"><span class="c">/* rtl:begin:remove */</span>
|
||
<span class="p">.</span><span class="nc">text-break</span> <span class="p">{</span>
|
||
<span class="k">word-wrap</span><span class="p">:</span> <span class="kc">break-word</span> <span class="cp">!important</span><span class="p">;</span>
|
||
<span class="k">word-break</span><span class="p">:</span> <span class="kc">break-word</span> <span class="cp">!important</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
<span class="c">/* rtl:end:remove */</span>
|
||
</code></pre></div><p>This doesn’t output anything in RTL, thanks to <a href="https://rtlcss.com/learn/usage-guide/control-directives/#remove">the RTLCSS <code>remove</code> control directive</a>.</p>
|
||
|
||
</div>
|
||
</main>
|
||
</div>
|
||
|
||
|
||
<footer class="bd-footer py-5 mt-5 bg-light">
|
||
<div class="container py-5">
|
||
<div class="row">
|
||
<div class="col-lg-3 mb-3">
|
||
<a class="d-inline-flex align-items-center mb-2 link-dark text-decoration-none" href="/" aria-label="Bootstrap">
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="40" height="32" class="d-block me-2" viewBox="0 0 118 94" role="img"><title>Bootstrap</title><path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z" fill="currentColor"/></svg>
|
||
<span class="fs-5">Bootstrap</span>
|
||
</a>
|
||
<ul class="list-unstyled small text-muted">
|
||
<li class="mb-2">Designed and built with all the love in the world by the <a href="/docs/5.1/about/team/">Bootstrap team</a> with the help of <a href="https://github.com/twbs/bootstrap/graphs/contributors">our contributors</a>.</li>
|
||
<li class="mb-2">Code licensed <a href="https://github.com/twbs/bootstrap/blob/main/LICENSE" target="_blank" rel="license noopener">MIT</a>, docs <a href="https://creativecommons.org/licenses/by/3.0/" target="_blank" rel="license noopener">CC BY 3.0</a>.</li>
|
||
<li class="mb-2">Currently v5.1.3.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="col-6 col-lg-2 offset-lg-1 mb-3">
|
||
<h5>Links</h5>
|
||
<ul class="list-unstyled">
|
||
<li class="mb-2"><a href="/">Home</a></li>
|
||
<li class="mb-2"><a href="/docs/5.1/">Docs</a></li>
|
||
<li class="mb-2"><a href="/docs/5.1/examples/">Examples</a></li>
|
||
<li class="mb-2"><a href="https://themes.getbootstrap.com/">Themes</a></li>
|
||
<li class="mb-2"><a href="https://blog.getbootstrap.com/">Blog</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="col-6 col-lg-2 mb-3">
|
||
<h5>Guides</h5>
|
||
<ul class="list-unstyled">
|
||
<li class="mb-2"><a href="/docs/5.1/getting-started/">Getting started</a></li>
|
||
<li class="mb-2"><a href="/docs/5.1/examples/starter-template/">Starter template</a></li>
|
||
<li class="mb-2"><a href="/docs/5.1/getting-started/webpack/">Webpack</a></li>
|
||
<li class="mb-2"><a href="/docs/5.1/getting-started/parcel/">Parcel</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="col-6 col-lg-2 mb-3">
|
||
<h5>Projects</h5>
|
||
<ul class="list-unstyled">
|
||
<li class="mb-2"><a href="https://github.com/twbs/bootstrap">Bootstrap 5</a></li>
|
||
<li class="mb-2"><a href="https://github.com/twbs/bootstrap/tree/v4-dev">Bootstrap 4</a></li>
|
||
<li class="mb-2"><a href="https://github.com/twbs/icons">Icons</a></li>
|
||
<li class="mb-2"><a href="https://github.com/twbs/rfs">RFS</a></li>
|
||
<li class="mb-2"><a href="https://github.com/twbs/bootstrap-npm-starter">npm starter</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="col-6 col-lg-2 mb-3">
|
||
<h5>Community</h5>
|
||
<ul class="list-unstyled">
|
||
<li class="mb-2"><a href="https://github.com/twbs/bootstrap/issues">Issues</a></li>
|
||
<li class="mb-2"><a href="https://github.com/twbs/bootstrap/discussions">Discussions</a></li>
|
||
<li class="mb-2"><a href="https://github.com/sponsors/twbs">Corporate sponsors</a></li>
|
||
<li class="mb-2"><a href="https://opencollective.com/bootstrap">Open Collective</a></li>
|
||
<li class="mb-2"><a href="https://bootstrap-slack.herokuapp.com/">Slack</a></li>
|
||
<li class="mb-2"><a href="https://stackoverflow.com/questions/tagged/bootstrap-5">Stack Overflow</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<script src="/docs/5.1/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
|
||
|
||
|
||
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
||
|
||
<script src="/docs/5.1/assets/js/docs.min.js"></script>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|