carbon-components-angular
Version:
Next generation components
597 lines (547 loc) • 24.5 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 miscellaneous-typealiases">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Miscellaneous</li>
<li class="breadcrumb-item">Type aliases</li>
</ol>
<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">
<ul class="index-list">
<li>
<a href="#ButtonSize" title="src/button/button.types.ts" ><b>ButtonSize</b> (src/.../button.types.ts)</a>
</li>
<li>
<a href="#ButtonType" title="src/button/button.types.ts" ><b>ButtonType</b> (src/.../button.types.ts)</a>
</li>
<li>
<a href="#CheckboxValue" title="src/checkbox/checkbox.types.ts" ><b>CheckboxValue</b> (src/.../checkbox.types.ts)</a>
</li>
<li>
<a href="#ComboButtonPlacement" title="src/combo-button/combo-button.component.ts" ><b>ComboButtonPlacement</b> (src/.../combo-button.component.ts)</a>
</li>
<li>
<a href="#DangerButtonType" title="src/button/button.types.ts" ><b>DangerButtonType</b> (src/.../button.types.ts)</a>
</li>
<li>
<a href="#EventHandler" title="src/utils/types.ts" ><b>EventHandler</b> (src/.../types.ts)</a>
</li>
<li>
<a href="#HeaderType" title="src/table/table-model.class.ts" ><b>HeaderType</b> (src/.../table-model.class.ts)</a>
</li>
<li>
<a href="#MenuButtonPlacement" title="src/menu-button/menu-button.component.ts" ><b>MenuButtonPlacement</b> (src/.../menu-button.component.ts)</a>
</li>
<li>
<a href="#NotificationType" title="src/notification/notification-content.interface.ts" ><b>NotificationType</b> (src/.../notification-content.interface.ts)</a>
</li>
<li>
<a href="#NotificationVariants" title="src/notification/notification-content.interface.ts" ><b>NotificationVariants</b> (src/.../notification-content.interface.ts)</a>
</li>
<li>
<a href="#oldPlacement" title="src/popover/popover.directive.ts" ><b>oldPlacement</b> (src/.../popover.directive.ts)</a>
</li>
<li>
<a href="#SortType" title="src/table/table-header-item.class.ts" ><b>SortType</b> (src/.../table-header-item.class.ts)</a>
</li>
<li>
<a href="#TableRowSize" title="src/table/table.types.ts" ><b>TableRowSize</b> (src/.../table.types.ts)</a>
</li>
<li>
<a href="#TagType" title="src/tag/tag.component.ts" ><b>TagType</b> (src/.../tag.component.ts)</a>
</li>
<li>
<a href="#ThemeType" title="src/theme/theme.directive.ts" ><b>ThemeType</b> (src/.../theme.directive.ts)</a>
</li>
<li>
<a href="#TooltipAlignments" title="src/tooltip/tooltip.interface.ts" ><b>TooltipAlignments</b> (src/.../tooltip.interface.ts)</a>
</li>
<li>
<a href="#TranslationStrings" title="src/i18n/i18n.service.ts" ><b>TranslationStrings</b> (src/.../i18n.service.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/button/button.types.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ButtonSize"></a>
<span class="name "><b>ButtonSize</b><a href="#ButtonSize"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"sm" | "md" | "lg" | "xl" | "2xl"</code>
</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ButtonType"></a>
<span class="name "><b>ButtonType</b><a href="#ButtonType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code><a href="../directives/Button.html" target="_self" >"primary" | "secondary" | "tertiary" | "ghost" | "danger" | DangerButtonType</a></code>
</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="DangerButtonType"></a>
<span class="name "><b>DangerButtonType</b><a href="#DangerButtonType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"danger--primary" | "danger--tertiary" | "danger--ghost"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/checkbox/checkbox.types.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="CheckboxValue"></a>
<span class="name "><b>CheckboxValue</b><a href="#CheckboxValue"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>boolean | "on" | "off"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/combo-button/combo-button.component.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ComboButtonPlacement"></a>
<span class="name "><b>ComboButtonPlacement</b><a href="#ComboButtonPlacement"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/utils/types.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="EventHandler"></a>
<span class="name "><b>EventHandler</b><a href="#EventHandler"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/table/table-model.class.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="HeaderType"></a>
<span class="name "><b>HeaderType</b><a href="#HeaderType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>number | "select" | "expand"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/menu-button/menu-button.component.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="MenuButtonPlacement"></a>
<span class="name "><b>MenuButtonPlacement</b><a href="#MenuButtonPlacement"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/notification/notification-content.interface.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="NotificationType"></a>
<span class="name "><b>NotificationType</b><a href="#NotificationType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"</code>
</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="NotificationVariants"></a>
<span class="name "><b>NotificationVariants</b><a href="#NotificationVariants"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"inline" | "toast"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/popover/popover.directive.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="oldPlacement"></a>
<span class="name "><b>oldPlacement</b><a href="#oldPlacement"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"top-left" | "top-right" | "bottom-left" | "bottom-right" | "left-bottom" | "left-top" | "right-bottom" | "right-top"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/table/table-header-item.class.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="SortType"></a>
<span class="name "><b>SortType</b><a href="#SortType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"ASCENDING" | "DESCENDING" | "NONE"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/table/table.types.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TableRowSize"></a>
<span class="name "><b>TableRowSize</b><a href="#TableRowSize"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"xs" | "sm" | "md" | "lg" | "xl"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/tag/tag.component.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TagType"></a>
<span class="name "><b>TagType</b><a href="#TagType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Supported tag types for carbon v10</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"red" | "magenta" | "purple" | "blue" | "cyan" | "teal" | "green" | "gray" | "cool-gray" | "warm-gray" | "high-contrast" | "outline"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/theme/theme.directive.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ThemeType"></a>
<span class="name "><b>ThemeType</b><a href="#ThemeType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"white" | "g10" | "g90" | "g100"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/tooltip/tooltip.interface.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TooltipAlignments"></a>
<span class="name "><b>TooltipAlignments</b><a href="#TooltipAlignments"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>"top" | "top-left" | "top-right" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-bottom" | "left-top" | "right" | "right-bottom" | "right-top"</code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/i18n/i18n.service.ts</h3>
<section data-compodoc="block-typealias">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TranslationStrings"></a>
<span class="name "><b>TranslationStrings</b><a href="#TranslationStrings"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>An object of strings, should follow the same format as src/i18n/en.json</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code>literal type</code>
</code>
</td>
</tr>
</tbody>
</table>
</section>
</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 = 'miscellaneous-typealiases';
var COMPODOC_CURRENT_PAGE_URL = 'typealiases.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>