carbon-components-angular
Version:
Next generation components
492 lines (427 loc) • 21.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" >FileUploaderModule</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="1174pt" height="396pt"
viewBox="0.00 0.00 1174.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 1170,-391.59 1170,4 -4,4"/>
<text text-anchor="start" x="562.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="349,-10 349,-30 369,-30 369,-10 349,-10"/>
<text text-anchor="start" x="372.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="462,-10 462,-30 482,-30 482,-10 462,-10"/>
<text text-anchor="start" x="485.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="548,-10 548,-30 568,-30 568,-10 548,-10"/>
<text text-anchor="start" x="571.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="645,-10 645,-30 665,-30 665,-10 645,-10"/>
<text text-anchor="start" x="668.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="741,-10 741,-30 761,-30 761,-10 741,-10"/>
<text text-anchor="start" x="764.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_FileUploaderModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-70 8,-379.59 1158,-379.59 1158,-70 8,-70"/>
</g>
<g id="clust4" class="cluster">
<title>cluster_FileUploaderModule_FileUploader_providers</title>
<polygon fill="none" stroke="black" points="492,-78 492,-241.59 1150,-241.59 1150,-78 492,-78"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_FileUploaderModule_declarations</title>
<polygon fill="none" stroke="black" points="364,-189.59 364,-241.59 484,-241.59 484,-189.59 364,-189.59"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_FileUploaderModule_exports</title>
<polygon fill="none" stroke="black" points="185,-319.59 185,-371.59 419,-371.59 419,-319.59 185,-319.59"/>
</g>
<g id="clust5" class="cluster">
<title>cluster_FileUploaderModule_imports</title>
<polygon fill="none" stroke="black" points="16,-189.59 16,-241.59 356,-241.59 356,-189.59 16,-189.59"/>
</g>
<!-- FileComponent -->
<g id="node1" class="node">
<title>FileComponent</title>
<polygon fill="#ffffb3" stroke="black" points="475.61,-233.59 372.39,-233.59 372.39,-197.59 475.61,-197.59 475.61,-233.59"/>
<text text-anchor="middle" x="424" y="-211.39" font-family="Times,serif" font-size="14.00">FileComponent</text>
</g>
<!-- FileUploaderModule -->
<g id="node3" class="node">
<title>FileUploaderModule</title>
<polygon fill="#8dd3c7" stroke="black" points="365.92,-298.59 362.92,-302.59 341.92,-302.59 338.92,-298.59 232.08,-298.59 232.08,-262.59 365.92,-262.59 365.92,-298.59"/>
<text text-anchor="middle" x="299" y="-276.39" font-family="Times,serif" font-size="14.00">FileUploaderModule</text>
</g>
<!-- FileComponent->FileUploaderModule -->
<g id="edge1" class="edge">
<title>FileComponent->FileUploaderModule</title>
<path fill="none" stroke="black" d="M372.36,-215.59C363.34,-215.59 356.77,-215.59 356.77,-215.59 356.77,-215.59 356.77,-252.48 356.77,-252.48"/>
<polygon fill="black" stroke="black" points="353.27,-252.48 356.77,-262.48 360.27,-252.48 353.27,-252.48"/>
</g>
<!-- FileUploader -->
<g id="node2" class="node">
<title>FileUploader</title>
<polygon fill="#ffffb3" stroke="black" points="727.87,-233.59 638.13,-233.59 638.13,-197.59 727.87,-197.59 727.87,-233.59"/>
<text text-anchor="middle" x="683" y="-211.39" font-family="Times,serif" font-size="14.00">FileUploader</text>
</g>
<!-- FileUploader->FileUploaderModule -->
<g id="edge2" class="edge">
<title>FileUploader->FileUploaderModule</title>
<path fill="none" stroke="black" d="M683,-233.7C683,-252.93 683,-280.59 683,-280.59 683,-280.59 375.89,-280.59 375.89,-280.59"/>
<polygon fill="black" stroke="black" points="375.89,-277.09 365.89,-280.59 375.89,-284.09 375.89,-277.09"/>
</g>
<!-- FileComponent -->
<g id="node8" class="node">
<title>FileComponent </title>
<polygon fill="#fb8072" stroke="black" points="411.11,-363.59 304.89,-363.59 304.89,-327.59 411.11,-327.59 411.11,-363.59"/>
<text text-anchor="middle" x="358" y="-341.39" font-family="Times,serif" font-size="14.00">FileComponent </text>
</g>
<!-- FileUploaderModule->FileComponent -->
<g id="edge7" class="edge">
<title>FileUploaderModule->FileComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M335.2,-298.7C335.2,-298.7 335.2,-317.58 335.2,-317.58"/>
<polygon fill="black" stroke="black" points="331.7,-317.58 335.2,-327.58 338.7,-317.58 331.7,-317.58"/>
</g>
<!-- FileUploader -->
<g id="node9" class="node">
<title>FileUploader </title>
<polygon fill="#fb8072" stroke="black" points="286.87,-363.59 193.13,-363.59 193.13,-327.59 286.87,-327.59 286.87,-363.59"/>
<text text-anchor="middle" x="240" y="-341.39" font-family="Times,serif" font-size="14.00">FileUploader </text>
</g>
<!-- FileUploaderModule->FileUploader -->
<g id="edge8" class="edge">
<title>FileUploaderModule->FileUploader </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M259.49,-298.7C259.49,-298.7 259.49,-317.58 259.49,-317.58"/>
<polygon fill="black" stroke="black" points="255.99,-317.58 259.49,-327.58 262.99,-317.58 255.99,-317.58"/>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: FileUploader, multi: true
} -->
<g id="node4" class="node">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: FileUploader, multi: true
}</title>
<ellipse fill="#fdb462" stroke="black" cx="821" cy="-127.3" rx="320.76" ry="41.09"/>
<text text-anchor="middle" x="821" y="-139.9" font-family="Times,serif" font-size="14.00">{</text>
<text text-anchor="middle" x="821" y="-123.1" font-family="Times,serif" font-size="14.00">    provide: NG_VALUE_ACCESSOR, useExisting: FileUploader, multi: true</text>
<text text-anchor="middle" x="821" y="-106.3" font-family="Times,serif" font-size="14.00">}</text>
</g>
<!-- {
   provide: NG_VALUE_ACCESSOR, useExisting: FileUploader, multi: true
}->FileUploader -->
<g id="edge3" class="edge">
<title>{
   provide: NG_VALUE_ACCESSOR, useExisting: FileUploader, multi: true
}->FileUploader</title>
<path fill="none" stroke="black" d="M683,-164.74C683,-164.74 683,-187.34 683,-187.34"/>
<polygon fill="black" stroke="black" points="679.5,-187.34 683,-197.34 686.5,-187.34 679.5,-187.34"/>
</g>
<!-- ButtonModule -->
<g id="node5" class="node">
<title>ButtonModule</title>
<polygon fill="#8dd3c7" stroke="black" points="347.67,-233.59 344.67,-237.59 323.67,-237.59 320.67,-233.59 250.33,-233.59 250.33,-197.59 347.67,-197.59 347.67,-233.59"/>
<text text-anchor="middle" x="299" y="-211.39" font-family="Times,serif" font-size="14.00">ButtonModule</text>
</g>
<!-- ButtonModule->FileUploaderModule -->
<g id="edge4" class="edge">
<title>ButtonModule->FileUploaderModule</title>
<path fill="none" stroke="black" d="M299,-233.7C299,-233.7 299,-252.58 299,-252.58"/>
<polygon fill="black" stroke="black" points="295.5,-252.58 299,-262.58 302.5,-252.58 295.5,-252.58"/>
</g>
<!-- IconModule -->
<g id="node6" class="node">
<title>IconModule</title>
<polygon fill="#8dd3c7" stroke="black" points="232.43,-233.59 229.43,-237.59 208.43,-237.59 205.43,-233.59 147.57,-233.59 147.57,-197.59 232.43,-197.59 232.43,-233.59"/>
<text text-anchor="middle" x="190" y="-211.39" font-family="Times,serif" font-size="14.00">IconModule</text>
</g>
<!-- IconModule->FileUploaderModule -->
<g id="edge5" class="edge">
<title>IconModule->FileUploaderModule</title>
<path fill="none" stroke="black" d="M232.31,-215.59C237.61,-215.59 241.23,-215.59 241.23,-215.59 241.23,-215.59 241.23,-252.48 241.23,-252.48"/>
<polygon fill="black" stroke="black" points="237.73,-252.48 241.23,-262.48 244.73,-252.48 237.73,-252.48"/>
</g>
<!-- LoadingModule -->
<g id="node7" class="node">
<title>LoadingModule</title>
<polygon fill="#8dd3c7" stroke="black" points="130.21,-233.59 127.21,-237.59 106.21,-237.59 103.21,-233.59 23.79,-233.59 23.79,-197.59 130.21,-197.59 130.21,-233.59"/>
<text text-anchor="middle" x="77" y="-211.39" font-family="Times,serif" font-size="14.00">LoadingModule</text>
</g>
<!-- LoadingModule->FileUploaderModule -->
<g id="edge6" class="edge">
<title>LoadingModule->FileUploaderModule</title>
<path fill="none" stroke="black" d="M77,-233.7C77,-252.93 77,-280.59 77,-280.59 77,-280.59 222.09,-280.59 222.09,-280.59"/>
<polygon fill="black" stroke="black" points="222.09,-284.09 232.09,-280.59 222.09,-277.09 222.09,-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/file-uploader/file-uploader.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/FileComponent.html">FileComponent</a>
</li>
<li class="list-group-item">
<a href="../components/FileUploader.html">FileUploader</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/ButtonModule.html">ButtonModule</a>
</li>
<li class="list-group-item">
<a href="../modules/IconModule.html">IconModule</a>
</li>
<li class="list-group-item">
<a href="../modules/LoadingModule.html">LoadingModule</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/FileComponent.html">FileComponent</a>
</li>
<li class="list-group-item">
<a href="../components/FileUploader.html">FileUploader</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 { FileUploader } from "./file-uploader.component";
import { FileComponent } from "./file.component";
import { ButtonModule } from "carbon-components-angular/button";
import { LoadingModule } from "carbon-components-angular/loading";
import { IconModule } from "carbon-components-angular/icon";
@NgModule({
declarations: [FileUploader, FileComponent],
exports: [FileUploader, FileComponent],
imports: [
CommonModule,
ButtonModule,
LoadingModule,
IconModule
]
})
export class FileUploaderModule { }
</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 = 'FileUploaderModule.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>