carbon-components-angular
Version:
Next generation components
764 lines (713 loc) • 30.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-enumerations">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Miscellaneous</li>
<li class="breadcrumb-item">Enumerations</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="#AlertModalType" title="src/modal/alert-modal.interface.ts" ><b>AlertModalType</b> (src/.../alert-modal.interface.ts)</a>
</li>
<li>
<a href="#CheckboxState" title="src/checkbox/checkbox.component.ts" ><b>CheckboxState</b> (src/.../checkbox.component.ts)</a>
</li>
<li>
<a href="#CloseReasons" title="src/dialog/dialog-config.interface.ts" ><b>CloseReasons</b> (src/.../dialog-config.interface.ts)</a>
</li>
<li>
<a href="#ContainedListKind" title="src/contained-list/contained-list.enums.ts" ><b>ContainedListKind</b> (src/.../contained-list.enums.ts)</a>
</li>
<li>
<a href="#ContainedListSize" title="src/contained-list/contained-list.enums.ts" ><b>ContainedListSize</b> (src/.../contained-list.enums.ts)</a>
</li>
<li>
<a href="#InlineLoadingState" title="src/inline-loading/inline-loading.component.ts" ><b>InlineLoadingState</b> (src/.../inline-loading.component.ts)</a>
</li>
<li>
<a href="#ModalButtonType" title="src/modal/alert-modal.interface.ts" ><b>ModalButtonType</b> (src/.../alert-modal.interface.ts)</a>
</li>
<li>
<a href="#SnippetType" title="src/code-snippet/code-snippet.component.ts" ><b>SnippetType</b> (src/.../code-snippet.component.ts)</a>
</li>
<li>
<a href="#TableDomSpanDirection" title="src/table/table-adapter.class.ts" ><b>TableDomSpanDirection</b> (src/.../table-adapter.class.ts)</a>
</li>
<li>
<a href="#Target" title="src/dialog/overflow-menu/overflow-menu-option.component.ts" ><b>Target</b> (src/.../overflow-menu-option.component.ts)</a>
</li>
<li>
<a href="#ToggleState" title="src/toggle/toggle.component.ts" class="deprecated-name"><b>ToggleState</b> (src/.../toggle.component.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/modal/alert-modal.interface.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="AlertModalType"></a>
<span class="name "><b>AlertModalType</b><a href="#AlertModalType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
default
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>default</code>
</td>
</tr>
<tr>
<td class="col-md-4">
danger
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>danger</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ModalButtonType"></a>
<span class="name "><b>ModalButtonType</b><a href="#ModalButtonType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
primary
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>primary</code>
</td>
</tr>
<tr>
<td class="col-md-4">
secondary
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>secondary</code>
</td>
</tr>
<tr>
<td class="col-md-4">
tertiary
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>tertiary</code>
</td>
</tr>
<tr>
<td class="col-md-4">
ghost
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>ghost</code>
</td>
</tr>
<tr>
<td class="col-md-4">
danger
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>danger</code>
</td>
</tr>
<tr>
<td class="col-md-4">
danger_primary
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>danger--primary</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/checkbox/checkbox.component.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="CheckboxState"></a>
<span class="name "><b>CheckboxState</b><a href="#CheckboxState"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Defines the set of states for a checkbox component.</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
Init
</td>
</tr>
<tr>
<td class="col-md-4">
Indeterminate
</td>
</tr>
<tr>
<td class="col-md-4">
Checked
</td>
</tr>
<tr>
<td class="col-md-4">
Unchecked
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/dialog/dialog-config.interface.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="CloseReasons"></a>
<span class="name "><b>CloseReasons</b><a href="#CloseReasons"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>An enum of the various reasons a dialog may close. For use with <code>CloseMeta</code> and <code>shouldClose</code></p>
<p>It's expected that <code>interaction</code> will be a common closure reason.</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
destroyed
</td>
</tr>
<tr>
<td class="col-md-4">
programmatic
</td>
</tr>
<tr>
<td class="col-md-4">
interaction
</td>
</tr>
<tr>
<td class="col-md-4">
hidden
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/contained-list/contained-list.enums.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ContainedListKind"></a>
<span class="name "><b>ContainedListKind</b><a href="#ContainedListKind"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
OnPage
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>on-page</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Disclosed
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>disclosed</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ContainedListSize"></a>
<span class="name "><b>ContainedListSize</b><a href="#ContainedListSize"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
Small
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>sm</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Medium
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>md</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Large
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>lg</code>
</td>
</tr>
<tr>
<td class="col-md-4">
ExtraLarge
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>xl</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/inline-loading/inline-loading.component.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="InlineLoadingState"></a>
<span class="name "><b>InlineLoadingState</b><a href="#InlineLoadingState"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
Hidden
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>hidden</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Inactive
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>inactive</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Active
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>active</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Finished
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>finished</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Error
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>error</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/code-snippet/code-snippet.component.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="SnippetType"></a>
<span class="name "><b>SnippetType</b><a href="#SnippetType"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
single
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>single</code>
</td>
</tr>
<tr>
<td class="col-md-4">
multi
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>multi</code>
</td>
</tr>
<tr>
<td class="col-md-4">
inline
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>inline</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/table/table-adapter.class.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TableDomSpanDirection"></a>
<span class="name "><b>TableDomSpanDirection</b><a href="#TableDomSpanDirection"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
colSpan
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>colSpan</code>
</td>
</tr>
<tr>
<td class="col-md-4">
rowSpan
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>rowSpan</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/dialog/overflow-menu/overflow-menu-option.component.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="Target"></a>
<span class="name "><b>Target</b><a href="#Target"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Available HTML anchor targets</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
self
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>_self</code>
</td>
</tr>
<tr>
<td class="col-md-4">
blank
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>_blank</code>
</td>
</tr>
<tr>
<td class="col-md-4">
parent
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>_parent</code>
</td>
</tr>
<tr>
<td class="col-md-4">
top
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Value : </i><code>_top</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/toggle/toggle.component.ts</h3>
<section data-compodoc="block-enums">
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ToggleState"></a>
<span class="name deprecated-name"><b>ToggleState</b><a href="#ToggleState"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4 deprecated">
since v5 - Use boolean
Defines the set of states for a toggle component.
</td>
</tr>
<tr>
<td class="col-md-4">
Init
</td>
</tr>
<tr>
<td class="col-md-4">
Checked
</td>
</tr>
<tr>
<td class="col-md-4">
Unchecked
</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-enumerations';
var COMPODOC_CURRENT_PAGE_URL = 'enumerations.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>