carbon-components-angular

<!doctype 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"> </head> <body> <div class="navbar navbar-default navbar-fixed-top d-block d-sm-none"> <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 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="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content module"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Modules</li> <li class="breadcrumb-item" >SideNavModule</li> </ol> <div class="text-center module-graph-container"> <div id="module-graph-svg"> <?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">   <svg width="504pt" height="284pt" viewBox="0.00 0.00 504.00 284.00" 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 280)"> <title>dependencies</title> <polygon fill="white" stroke="transparent" points="-4,4 -4,-280 500,-280 500,4 -4,4"/> <text text-anchor="start" x="227.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text> <polygon fill="#ffffb3" stroke="transparent" points="14,-10 14,-30 34,-30 34,-10 14,-10"/> <text text-anchor="start" x="37.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text> <polygon fill="#8dd3c7" stroke="transparent" points="127,-10 127,-30 147,-30 147,-10 127,-10"/> <text text-anchor="start" x="150.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text> <polygon fill="#80b1d3" stroke="transparent" points="213,-10 213,-30 233,-30 233,-10 213,-10"/> <text text-anchor="start" x="236.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text> <polygon fill="#fdb462" stroke="transparent" points="310,-10 310,-30 330,-30 330,-10 310,-10"/> <text text-anchor="start" x="333.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text> <polygon fill="#fb8072" stroke="transparent" points="406,-10 406,-30 426,-30 426,-10 406,-10"/> <text text-anchor="start" x="429.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text> <g id="clust1" class="cluster"> <title>cluster_SideNavModule</title> <polygon fill="none" stroke="black" stroke-dasharray="1,5" points="34,-70 34,-268 462,-268 462,-70 34,-70"/> </g> <g id="clust2" class="cluster"> <title>cluster_SideNavModule_declarations</title> <polygon fill="none" stroke="black" points="152,-78 152,-130 454,-130 454,-78 152,-78"/> </g> <g id="clust7" class="cluster"> <title>cluster_SideNavModule_exports</title> <polygon fill="none" stroke="black" points="91,-208 91,-260 405,-260 405,-208 91,-208"/> </g> <g id="clust6" class="cluster"> <title>cluster_SideNavModule_imports</title> <polygon fill="none" stroke="black" points="42,-78 42,-130 144,-130 144,-78 42,-78"/> </g>  <g id="node1" class="node"> <title>SideNav</title> <polygon fill="#ffffb3" stroke="black" points="446.21,-122 381.79,-122 381.79,-86 446.21,-86 446.21,-122"/> <text text-anchor="middle" x="414" y="-99.8" font-family="Times,serif" font-size="14.00">SideNav</text> </g>  <g id="node4" class="node"> <title>SideNavModule</title> <polygon fill="#8dd3c7" stroke="black" points="317.76,-187 314.76,-191 293.76,-191 290.76,-187 210.24,-187 210.24,-151 317.76,-151 317.76,-187"/> <text text-anchor="middle" x="264" y="-164.8" font-family="Times,serif" font-size="14.00">SideNavModule</text> </g>  <g id="edge1" class="edge"> <title>SideNav->SideNavModule</title> <path fill="none" stroke="black" d="M389.38,-122.11C389.38,-141.34 389.38,-169 389.38,-169 389.38,-169 327.9,-169 327.9,-169"/> <polygon fill="black" stroke="black" points="327.9,-165.5 317.9,-169 327.9,-172.5 327.9,-165.5"/> </g>  <g id="node2" class="node"> <title>SideNavItem</title> <polygon fill="#ffffb3" stroke="black" points="363.87,-122 274.13,-122 274.13,-86 363.87,-86 363.87,-122"/> <text text-anchor="middle" x="319" y="-99.8" font-family="Times,serif" font-size="14.00">SideNavItem</text> </g>  <g id="edge2" class="edge"> <title>SideNavItem->SideNavModule</title> <path fill="none" stroke="black" d="M295.97,-122.11C295.97,-122.11 295.97,-140.99 295.97,-140.99"/> <polygon fill="black" stroke="black" points="292.47,-140.99 295.97,-150.99 299.47,-140.99 292.47,-140.99"/> </g>  <g id="node3" class="node"> <title>SideNavMenu</title> <polygon fill="#ffffb3" stroke="black" points="256.37,-122 159.63,-122 159.63,-86 256.37,-86 256.37,-122"/> <text text-anchor="middle" x="208" y="-99.8" font-family="Times,serif" font-size="14.00">SideNavMenu</text> </g>  <g id="edge3" class="edge"> <title>SideNavMenu->SideNavModule</title> <path fill="none" stroke="black" d="M233.28,-122.11C233.28,-122.11 233.28,-140.99 233.28,-140.99"/> <polygon fill="black" stroke="black" points="229.78,-140.99 233.28,-150.99 236.78,-140.99 229.78,-140.99"/> </g>  <g id="node6" class="node"> <title>SideNav </title> <polygon fill="#fb8072" stroke="black" points="396.71,-252 329.29,-252 329.29,-216 396.71,-216 396.71,-252"/> <text text-anchor="middle" x="363" y="-229.8" font-family="Times,serif" font-size="14.00">SideNav </text> </g>  <g id="edge5" class="edge"> <title>SideNavModule->SideNav </title> <path fill="none" stroke="black" stroke-dasharray="5,2" d="M314.28,-187.11C314.28,-206.34 314.28,-234 314.28,-234 314.28,-234 319.16,-234 319.16,-234"/> <polygon fill="black" stroke="black" points="319.16,-237.5 329.16,-234 319.16,-230.5 319.16,-237.5"/> </g>  <g id="node7" class="node"> <title>SideNavItem </title> <polygon fill="#fb8072" stroke="black" points="310.87,-252 217.13,-252 217.13,-216 310.87,-216 310.87,-252"/> <text text-anchor="middle" x="264" y="-229.8" font-family="Times,serif" font-size="14.00">SideNavItem </text> </g>  <g id="edge6" class="edge"> <title>SideNavModule->SideNavItem </title> <path fill="none" stroke="black" stroke-dasharray="5,2" d="M264,-187.11C264,-187.11 264,-205.99 264,-205.99"/> <polygon fill="black" stroke="black" points="260.5,-205.99 264,-215.99 267.5,-205.99 260.5,-205.99"/> </g>  <g id="node8" class="node"> <title>SideNavMenu </title> <polygon fill="#fb8072" stroke="black" points="199.37,-252 98.63,-252 98.63,-216 199.37,-216 199.37,-252"/> <text text-anchor="middle" x="149" y="-229.8" font-family="Times,serif" font-size="14.00">SideNavMenu </text> </g>  <g id="edge7" class="edge"> <title>SideNavModule->SideNavMenu </title> <path fill="none" stroke="black" stroke-dasharray="5,2" d="M213.72,-187.11C213.72,-206.34 213.72,-234 213.72,-234 213.72,-234 209.36,-234 209.36,-234"/> <polygon fill="black" stroke="black" points="209.36,-230.5 199.36,-234 209.36,-237.5 209.36,-230.5"/> </g>  <g id="node5" class="node"> <title>I18nModule</title> <polygon fill="#8dd3c7" stroke="black" points="135.71,-122 132.71,-126 111.71,-126 108.71,-122 50.29,-122 50.29,-86 135.71,-86 135.71,-122"/> <text text-anchor="middle" x="93" y="-99.8" font-family="Times,serif" font-size="14.00">I18nModule</text> </g>  <g id="edge4" class="edge"> <title>I18nModule->SideNavModule</title> <path fill="none" stroke="black" d="M117.21,-122.11C117.21,-141.34 117.21,-169 117.21,-169 117.21,-169 200.17,-169 200.17,-169"/> <polygon fill="black" stroke="black" points="200.17,-172.5 210.17,-169 200.17,-165.5 200.17,-172.5"/> </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/ui-shell/sidenav/sidenav.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/SideNav.html">SideNav</a> </li> <li class="list-group-item"> <a href="../components/SideNavItem.html">SideNavItem</a> </li> <li class="list-group-item"> <a href="../components/SideNavMenu.html">SideNavMenu</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/I18nModule.html">I18nModule</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/SideNav.html">SideNav</a> </li> <li class="list-group-item"> <a href="../components/SideNavItem.html">SideNavItem</a> </li> <li class="list-group-item"> <a href="../components/SideNavMenu.html">SideNavMenu</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">import { NgModule } from "@angular/core"; import { CommonModule } from "@angular/common"; import { RouterModule } from "@angular/router"; import { I18nModule } from "carbon-components-angular/i18n"; import { SideNav } from "./sidenav.component"; import { SideNavItem } from "./sidenav-item.component"; import { SideNavMenu } from "./sidenav-menu.component"; export { SideNavItemInterface } from "./sidenav-item.interface"; export { SideNav, SideNavItem, SideNavMenu }; @NgModule({ declarations: [ SideNav, SideNavItem, SideNavMenu ], imports: [CommonModule, I18nModule, RouterModule], exports: [ SideNav, SideNavItem, SideNavMenu ] }) export class SideNavModule { } </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>  </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 = 'SideNavModule.html'; var MAX_SEARCH_RESULTS = 15; </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> </body> </html>