carbon-components-angular
Version:
Next generation components
1,038 lines (900 loc) • 39.9 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>carbon-components-angular documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
<style>
footer.carbon {
position: absolute;
bottom: 0;
width: 100%;
z-index: 9999;
}
#root > div {
/*
* Subtracting the height of the footer to prevent
* overlaying the footer ontop of content
*/
height: calc(100vh - 48px);
}
</style>
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">carbon-components-angular documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content directive">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Directives</li>
<li class="breadcrumb-item" >AspectRatioDirective</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/aspect-ratio/aspect-ratio.directive.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Applies Carbon aspect ratio box classes (<code>cds--aspect-ratio</code>) to the host element.</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-html"><div cdsAspectRatio ratio="16x9">...</div></code></pre></div><b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { AspectRatioModule } from 'carbon-components-angular';</code></pre></div>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">Selector</td>
<td class="col-md-9"><code>[cdsAspectRatio], [ibmAspectRatio]</code></td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#aspectRatioBase" >aspectRatioBase</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#ratio" >ratio</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>HostBindings</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#class.cds--aspect-ratio" >class.cds--aspect-ratio</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--16x9" >class.cds--aspect-ratio--16x9</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--1x1" >class.cds--aspect-ratio--1x1</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--1x2" >class.cds--aspect-ratio--1x2</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--2x1" >class.cds--aspect-ratio--2x1</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--2x3" >class.cds--aspect-ratio--2x3</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--3x2" >class.cds--aspect-ratio--3x2</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--3x4" >class.cds--aspect-ratio--3x4</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--4x3" >class.cds--aspect-ratio--4x3</a>
</li>
<li>
<a href="#class.cds--aspect-ratio--9x16" >class.cds--aspect-ratio--9x16</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#ratio1x1" >ratio1x1</a>
</li>
<li>
<a href="#ratio2x3" >ratio2x3</a>
</li>
<li>
<a href="#ratio3x2" >ratio3x2</a>
</li>
<li>
<a href="#ratio3x4" >ratio3x4</a>
</li>
<li>
<a href="#ratio4x3" >ratio4x3</a>
</li>
<li>
<a href="#ratio1x2" >ratio1x2</a>
</li>
<li>
<a href="#ratio2x1" >ratio2x1</a>
</li>
<li>
<a href="#ratio9x16" >ratio9x16</a>
</li>
<li>
<a href="#ratio16x9" >ratio16x9</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio"></a>
<b>ratio</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#AspectRatioValue" target="_self" >AspectRatioValue</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"1x1"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:32</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set aspect ratio</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3>HostBindings</h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio</b></span>
<a href="#class.cds--aspect-ratio"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>true</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>true</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="35" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:35</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--16x9"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--16x9</b></span>
<a href="#class.cds--aspect-ratio--16x9"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="64" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:64</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--1x1"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--1x1</b></span>
<a href="#class.cds--aspect-ratio--1x1"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="40" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:40</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set ratio class based on <code>ratio</code> input</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--1x2"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--1x2</b></span>
<a href="#class.cds--aspect-ratio--1x2"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="55" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:55</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--2x1"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--2x1</b></span>
<a href="#class.cds--aspect-ratio--2x1"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:58</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--2x3"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--2x3</b></span>
<a href="#class.cds--aspect-ratio--2x3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:43</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--3x2"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--3x2</b></span>
<a href="#class.cds--aspect-ratio--3x2"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="46" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:46</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--3x4"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--3x4</b></span>
<a href="#class.cds--aspect-ratio--3x4"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="49" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:49</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--4x3"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--4x3</b></span>
<a href="#class.cds--aspect-ratio--4x3"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:52</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="class.cds--aspect-ratio--9x16"></a>
<span class="name">
<span ><b>class.cds--aspect-ratio--9x16</b></span>
<a href="#class.cds--aspect-ratio--9x16"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:61</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="aspectRatioBase"></a>
<span class="name">
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>aspectRatioBase</b></span>
<a href="#aspectRatioBase"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>true</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>
@HostBinding('class.cds--aspect-ratio')<br />
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="35" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:35</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-accessors">
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio1x1"></a>
<span class="name"><b>ratio1x1</b><a href="#ratio1x1"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio1x1()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="40" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:40</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set ratio class based on <code>ratio</code> input</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio2x3"></a>
<span class="name"><b>ratio2x3</b><a href="#ratio2x3"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio2x3()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:43</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio3x2"></a>
<span class="name"><b>ratio3x2</b><a href="#ratio3x2"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio3x2()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="46" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:46</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio3x4"></a>
<span class="name"><b>ratio3x4</b><a href="#ratio3x4"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio3x4()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="49" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:49</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio4x3"></a>
<span class="name"><b>ratio4x3</b><a href="#ratio4x3"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio4x3()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="52" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:52</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio1x2"></a>
<span class="name"><b>ratio1x2</b><a href="#ratio1x2"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio1x2()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="55" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:55</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio2x1"></a>
<span class="name"><b>ratio2x1</b><a href="#ratio2x1"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio2x1()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:58</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio9x16"></a>
<span class="name"><b>ratio9x16</b><a href="#ratio9x16"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio9x16()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="61" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:61</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ratio16x9"></a>
<span class="name"><b>ratio16x9</b><a href="#ratio16x9"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>ratio16x9()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="64" class="link-to-prism">src/aspect-ratio/aspect-ratio.directive.ts:64</a></div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Directive, HostBinding, Input } from "@angular/core";
export type AspectRatioValue =
| "1x1"
| "2x3"
| "3x2"
| "3x4"
| "4x3"
| "1x2"
| "2x1"
| "9x16"
| "16x9";
/**
* Applies Carbon aspect ratio box classes (`cds--aspect-ratio`) to the host element.
*
* ```html
* <div cdsAspectRatio ratio="16x9">...</div>
* ```
*
* ```typescript
* import { AspectRatioModule } from 'carbon-components-angular';
* ```
*/
@Directive({
selector: "[cdsAspectRatio], [ibmAspectRatio]"
})
export class AspectRatioDirective {
/**
* Set aspect ratio
*/
@Input() ratio: AspectRatioValue = "1x1";
// Set base class
@HostBinding("class.cds--aspect-ratio") readonly aspectRatioBase = true;
/**
* Set ratio class based on `ratio` input
*/
@HostBinding("class.cds--aspect-ratio--1x1") get ratio1x1() {
return this.ratio === "1x1";
}
@HostBinding("class.cds--aspect-ratio--2x3") get ratio2x3() {
return this.ratio === "2x3";
}
@HostBinding("class.cds--aspect-ratio--3x2") get ratio3x2() {
return this.ratio === "3x2";
}
@HostBinding("class.cds--aspect-ratio--3x4") get ratio3x4() {
return this.ratio === "3x4";
}
@HostBinding("class.cds--aspect-ratio--4x3") get ratio4x3() {
return this.ratio === "4x3";
}
@HostBinding("class.cds--aspect-ratio--1x2") get ratio1x2() {
return this.ratio === "1x2";
}
@HostBinding("class.cds--aspect-ratio--2x1") get ratio2x1() {
return this.ratio === "2x1";
}
@HostBinding("class.cds--aspect-ratio--9x16") get ratio9x16() {
return this.ratio === "9x16";
}
@HostBinding("class.cds--aspect-ratio--16x9") get ratio16x9() {
return this.ratio === "16x9";
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'directive';
var COMPODOC_CURRENT_PAGE_URL = 'AspectRatioDirective.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
<footer class="carbon">
<dds-footer-container key="footer" disable-locale-button="true" size="micro" />
</footer>
<script
key="8"
type="module"
src="https://1.www.s81c.com/common/carbon-for-ibm-dotcom/tag/v1/latest/footer.min.js">
</script>
<!-- Storybook override -->
<script>
document.title = "Carbon Components Angular";
</script>
<script
src="//1.www.s81c.com/common/stats/ibm-common.js"
type="text/javascript"
async="async">
</script>
</body>
</html>