carbon-components-angular
Version:
Next generation components
494 lines (429 loc) • 20.6 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 module">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Modules</li>
<li class="breadcrumb-item" >RadioModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.0 (20210316.0004)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="1406pt" height="396pt"
viewBox="0.00 0.00 1406.00 395.59" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 391.59)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-391.59 1402,-391.59 1402,4 -4,4"/>
<text text-anchor="start" x="678.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="465,-10 465,-30 485,-30 485,-10 465,-10"/>
<text text-anchor="start" x="488.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="578,-10 578,-30 598,-30 598,-10 578,-10"/>
<text text-anchor="start" x="601.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="664,-10 664,-30 684,-30 684,-10 664,-10"/>
<text text-anchor="start" x="687.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="761,-10 761,-30 781,-30 781,-10 761,-10"/>
<text text-anchor="start" x="784.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="857,-10 857,-30 877,-30 877,-10 857,-10"/>
<text text-anchor="start" x="880.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_RadioModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 1390,-379.59 1390,-70 8,-70"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_RadioModule_imports</title>
<polygon fill="none" stroke="black" points="1282,-189.59 1282,-241.59 1382,-241.59 1382,-189.59 1282,-189.59"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_RadioModule_RadioGroup_providers</title>
<polygon fill="none" stroke="black" points="624,-78 624,-241.59 1274,-241.59 1274,-78 624,-78"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_RadioModule_declarations</title>
<polygon fill="none" stroke="black" points="413,-189.59 413,-241.59 483,-241.59 483,-189.59 413,-189.59"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_RadioModule_exports</title>
<polygon fill="none" stroke="black" points="853,-319.59 853,-371.59 1029,-371.59 1029,-319.59 853,-319.59"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_RadioModule_Radio_providers</title>
<polygon fill="none" stroke="black" points="16,-78 16,-176.59 616,-176.59 616,-78 16,-78"/>
</g>
<!-- Radio -->
<g id="node1" class="node">
<title>Radio</title>
<polygon fill="#ffffb3" stroke="black" points="475,-233.59 421,-233.59 421,-197.59 475,-197.59 475,-233.59"/>
<text text-anchor="middle" x="448" y="-211.39" font-family="Times,serif" font-size="14.00">Radio</text>
</g>
<!-- RadioModule -->
<g id="node3" class="node">
<title>RadioModule</title>
<polygon fill="#8dd3c7" stroke="black" points="995.49,-298.59 992.49,-302.59 971.49,-302.59 968.49,-298.59 902.51,-298.59 902.51,-262.59 995.49,-262.59 995.49,-298.59"/>
<text text-anchor="middle" x="949" y="-276.39" font-family="Times,serif" font-size="14.00">RadioModule</text>
</g>
<!-- Radio->RadioModule -->
<g id="edge1" class="edge">
<title>Radio->RadioModule</title>
<path fill="none" stroke="black" d="M448,-233.7C448,-252.93 448,-280.59 448,-280.59 448,-280.59 892.32,-280.59 892.32,-280.59"/>
<polygon fill="black" stroke="black" points="892.32,-284.09 902.32,-280.59 892.32,-277.09 892.32,-284.09"/>
</g>
<!-- RadioGroup -->
<g id="node2" class="node">
<title>RadioGroup</title>
<polygon fill="#ffffb3" stroke="black" points="991.71,-233.59 906.29,-233.59 906.29,-197.59 991.71,-197.59 991.71,-233.59"/>
<text text-anchor="middle" x="949" y="-211.39" font-family="Times,serif" font-size="14.00">RadioGroup</text>
</g>
<!-- RadioGroup->RadioModule -->
<g id="edge3" class="edge">
<title>RadioGroup->RadioModule</title>
<path fill="none" stroke="black" d="M949,-233.7C949,-233.7 949,-252.58 949,-252.58"/>
<polygon fill="black" stroke="black" points="945.5,-252.58 949,-262.58 952.5,-252.58 945.5,-252.58"/>
</g>
<!-- Radio -->
<g id="node7" class="node">
<title>Radio </title>
<polygon fill="#fb8072" stroke="black" points="1021,-363.59 967,-363.59 967,-327.59 1021,-327.59 1021,-363.59"/>
<text text-anchor="middle" x="994" y="-341.39" font-family="Times,serif" font-size="14.00">Radio </text>
</g>
<!-- RadioModule->Radio -->
<g id="edge6" class="edge">
<title>RadioModule->Radio </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M981.25,-298.7C981.25,-298.7 981.25,-317.58 981.25,-317.58"/>
<polygon fill="black" stroke="black" points="977.75,-317.58 981.25,-327.58 984.75,-317.58 977.75,-317.58"/>
</g>
<!-- RadioGroup -->
<g id="node8" class="node">
<title>RadioGroup </title>
<polygon fill="#fb8072" stroke="black" points="949.21,-363.59 860.79,-363.59 860.79,-327.59 949.21,-327.59 949.21,-363.59"/>
<text text-anchor="middle" x="905" y="-341.39" font-family="Times,serif" font-size="14.00">RadioGroup </text>
</g>
<!-- RadioModule->RadioGroup -->
<g id="edge7" class="edge">
<title>RadioModule->RadioGroup </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M925.93,-298.7C925.93,-298.7 925.93,-317.58 925.93,-317.58"/>
<polygon fill="black" stroke="black" points="922.43,-317.58 925.93,-327.58 929.43,-317.58 922.43,-317.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Radio, multi: true
} -->
<g id="node4" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Radio, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="316" cy="-127.3" rx="292.09" ry="41.09"/>
<text text-anchor="middle" x="316" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="316" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: Radio, multi: true</text>
<text text-anchor="middle" x="316" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Radio, multi: true
}->Radio -->
<g id="edge2" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Radio, multi: true
}->Radio</title>
<path fill="none" stroke="black" d="M448,-164.23C448,-164.23 448,-187.58 448,-187.58"/>
<polygon fill="black" stroke="black" points="444.5,-187.58 448,-197.58 451.5,-187.58 444.5,-187.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: RadioGroup, multi: true
} -->
<g id="node5" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: RadioGroup, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="949" cy="-127.3" rx="317.17" ry="41.09"/>
<text text-anchor="middle" x="949" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="949" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: RadioGroup, multi: true</text>
<text text-anchor="middle" x="949" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: RadioGroup, multi: true
}->RadioGroup -->
<g id="edge4" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: RadioGroup, multi: true
}->RadioGroup</title>
<path fill="none" stroke="black" d="M949,-168.6C949,-168.6 949,-187.26 949,-187.26"/>
<polygon fill="black" stroke="black" points="945.5,-187.26 949,-197.26 952.5,-187.26 945.5,-187.26"/>
</g>
<!-- IconModule -->
<g id="node6" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="1374.43,-233.59 1371.43,-237.59 1350.43,-237.59 1347.43,-233.59 1289.57,-233.59 1289.57,-197.59 1374.43,-197.59 1374.43,-233.59"/>
<text text-anchor="middle" x="1332" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->RadioModule -->
<g id="edge5" class="edge">
<title>IconModule->RadioModule</title>
<path fill="none" stroke="black" d="M1332,-233.7C1332,-252.93 1332,-280.59 1332,-280.59 1332,-280.59 1005.58,-280.59 1005.58,-280.59"/>
<polygon fill="black" stroke="black" points="1005.58,-277.09 995.58,-280.59 1005.58,-284.09 1005.58,-277.09"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group size-buttons">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<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/radio/radio.module.ts</code>
</p>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank" rel="noopener noreferrer"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/Radio.html">Radio</a>
</li>
<li class="list-group-item">
<a href="../components/RadioGroup.html">RadioGroup</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" rel="noopener noreferrer"
title="Official documentation about module imports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../modules/IconModule.html">IconModule</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" rel="noopener noreferrer"
title="Official documentation about module exports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/Radio.html">Radio</a>
</li>
<li class="list-group-item">
<a href="../components/RadioGroup.html">RadioGroup</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">// modules
import { NgModule } from "@angular/core";
import { FormsModule } from "@angular/forms";
import { CommonModule } from "@angular/common";
// imports
import { Radio } from "./radio.component";
import { RadioGroup } from "./radio-group.component";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [
Radio,
RadioGroup
],
exports: [
Radio,
RadioGroup
],
imports: [
CommonModule,
FormsModule,
IconModule
]
})
export class RadioModule { }
</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 = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'RadioModule.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>