carbon-components-angular
Version:
Next generation components
448 lines (383 loc) • 18.3 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" >SearchModule</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="858pt" height="396pt"
viewBox="0.00 0.00 858.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 854,-391.59 854,4 -4,4"/>
<text text-anchor="start" x="404.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="191,-10 191,-30 211,-30 211,-10 191,-10"/>
<text text-anchor="start" x="214.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="304,-10 304,-30 324,-30 324,-10 304,-10"/>
<text text-anchor="start" x="327.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="390,-10 390,-30 410,-30 410,-10 390,-10"/>
<text text-anchor="start" x="413.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="487,-10 487,-30 507,-30 507,-10 487,-10"/>
<text text-anchor="start" x="510.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="583,-10 583,-30 603,-30 603,-10 583,-10"/>
<text text-anchor="start" x="606.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_SearchModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 842,-379.59 842,-70 8,-70"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_SearchModule_Search_providers</title>
<polygon fill="none" stroke="black" points="228,-78 228,-241.59 834,-241.59 834,-78 228,-78"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_SearchModule_exports</title>
<polygon fill="none" stroke="black" points="132,-319.59 132,-371.59 206,-371.59 206,-319.59 132,-319.59"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_SearchModule_imports</title>
<polygon fill="none" stroke="black" points="16,-189.59 16,-241.59 220,-241.59 220,-189.59 16,-189.59"/>
</g>
<!-- Search -->
<g id="node1" class="node">
<title>Search</title>
<polygon fill="#ffffb3" stroke="black" points="424.09,-233.59 369.91,-233.59 369.91,-197.59 424.09,-197.59 424.09,-233.59"/>
<text text-anchor="middle" x="397" y="-211.39" font-family="Times,serif" font-size="14.00">Search</text>
</g>
<!-- SearchModule -->
<g id="node2" class="node">
<title>SearchModule</title>
<polygon fill="#8dd3c7" stroke="black" points="217.64,-298.59 214.64,-302.59 193.64,-302.59 190.64,-298.59 120.36,-298.59 120.36,-262.59 217.64,-262.59 217.64,-298.59"/>
<text text-anchor="middle" x="169" y="-276.39" font-family="Times,serif" font-size="14.00">SearchModule</text>
</g>
<!-- Search->SearchModule -->
<g id="edge1" class="edge">
<title>Search->SearchModule</title>
<path fill="none" stroke="black" d="M397,-233.7C397,-252.93 397,-280.59 397,-280.59 397,-280.59 227.91,-280.59 227.91,-280.59"/>
<polygon fill="black" stroke="black" points="227.91,-277.09 217.91,-280.59 227.91,-284.09 227.91,-277.09"/>
</g>
<!-- Search -->
<g id="node6" class="node">
<title>Search </title>
<polygon fill="#fb8072" stroke="black" points="197.59,-363.59 140.41,-363.59 140.41,-327.59 197.59,-327.59 197.59,-363.59"/>
<text text-anchor="middle" x="169" y="-341.39" font-family="Times,serif" font-size="14.00">Search </text>
</g>
<!-- SearchModule->Search -->
<g id="edge5" class="edge">
<title>SearchModule->Search </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M169,-298.7C169,-298.7 169,-317.58 169,-317.58"/>
<polygon fill="black" stroke="black" points="165.5,-317.58 169,-327.58 172.5,-317.58 165.5,-317.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Search, multi: true
} -->
<g id="node3" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Search, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="531" cy="-127.3" rx="295.16" ry="41.09"/>
<text text-anchor="middle" x="531" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="531" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: Search, multi: true</text>
<text text-anchor="middle" x="531" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: Search, multi: true
}->Search -->
<g id="edge2" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: Search, multi: true
}->Search</title>
<path fill="none" stroke="black" d="M397,-164.23C397,-164.23 397,-187.58 397,-187.58"/>
<polygon fill="black" stroke="black" points="393.5,-187.58 397,-197.58 400.5,-187.58 393.5,-187.58"/>
</g>
<!-- I18nModule -->
<g id="node4" class="node">
<title>I18nModule</title>
<polygon fill="#8dd3c7" stroke="black" points="211.71,-233.59 208.71,-237.59 187.71,-237.59 184.71,-233.59 126.29,-233.59 126.29,-197.59 211.71,-197.59 211.71,-233.59"/>
<text text-anchor="middle" x="169" y="-211.39" font-family="Times,serif" font-size="14.00">I18nModule</text>
</g>
<!-- I18nModule->SearchModule -->
<g id="edge3" class="edge">
<title>I18nModule->SearchModule</title>
<path fill="none" stroke="black" d="M169,-233.7C169,-233.7 169,-252.58 169,-252.58"/>
<polygon fill="black" stroke="black" points="165.5,-252.58 169,-262.58 172.5,-252.58 165.5,-252.58"/>
</g>
<!-- IconModule -->
<g id="node5" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="108.43,-233.59 105.43,-237.59 84.43,-237.59 81.43,-233.59 23.57,-233.59 23.57,-197.59 108.43,-197.59 108.43,-233.59"/>
<text text-anchor="middle" x="66" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->SearchModule -->
<g id="edge4" class="edge">
<title>IconModule->SearchModule</title>
<path fill="none" stroke="black" d="M66,-233.7C66,-252.93 66,-280.59 66,-280.59 66,-280.59 110.21,-280.59 110.21,-280.59"/>
<polygon fill="black" stroke="black" points="110.21,-284.09 120.21,-280.59 110.21,-277.09 110.21,-284.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/search/search.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/Search.html">Search</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>
<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/Search.html">Search</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 { I18nModule } from "carbon-components-angular/i18n";
import { Search } from "./search.component";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [
Search
],
exports: [
Search
],
imports: [
FormsModule,
CommonModule,
I18nModule,
IconModule
]
})
export class SearchModule { }
</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 = 'SearchModule.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>