carbon-components-angular
Version:
Next generation components
1,177 lines (1,028 loc) • 64.1 kB
HTML
<!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">
<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 component">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Components</li>
<li class="breadcrumb-item"
>
ProgressIndicator</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info" 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>
<li class="nav-item">
<a href="#tree" class="nav-link"
role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</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/progress-indicator/progress-indicator.component.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Get started with importing the module:</p>
<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { ProgressIndicatorModule } from 'carbon-components-angular';</code></pre></div><p><a href="../../?path=/story/components-progress-indicator--basic">See demo</a></p>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">selector</td>
<td class="col-md-9"><code>cds-progress-indicator, ibm-progress-indicator</code></td>
</tr>
<tr>
<td class="col-md-3">template</td>
<td class="col-md-9"><pre class="line-numbers"><code class="language-html"><ul
data-progress
data-progress-current
class="cds--progress"
[ngClass]="{
'cds--skeleton': skeleton,
'cds--progress--vertical': (orientation === 'vertical'),
'cds--progress--space-equal': spacing === 'equal' && orientation !== 'vertical'
}">
<li
class="cds--progress-step"
*ngFor="let step of steps; let i = index"
[ngClass]="{
'cds--progress-step--disabled' : step.disabled,
'cds--progress-step--complete' : step.complete,
'cds--progress-step--incomplete' : !step.complete && i !== current,
'cds--progress-step--current': i === current
}">
<button
type="button"
class="cds--progress-step-button"
[ngClass]="{
'cds--progress-step-button--unclickable': !step.onClick || current === i
}"
[disabled]="step.disabled"
[attr.aria-disabled]="step.disabled"
[tabindex]="(current !== i && step.onClick && !step.disabled) ? 0 : -1"
[title]="step.label"
(click)="onClick(i)">
<span class="cds--assistive-text">
{{this.translations[getCurrentState(i)?.toUpperCase()]}}
</span>
<svg
[cdsIcon]="statusIcons[getCurrentState(i)]"
size="16"
[ngClass]="{
'cds--progress__warning': step.invalid && i !== current
}">
<title *ngIf="step.description">{{step.description}}</title>
</svg>
<div class="cds--progress-text">
<p class="cds--progress-label">{{step.label}}</p>
<p *ngIf="step.secondaryLabel" class="cds--progress-optional">{{step.secondaryLabel}}</p>
</div>
<span class="cds--progress-line"></span>
</button>
</li>
</ul>
</code></pre></td>
</tr>
</tbody>
</table>
</section>
<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">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Private</span>
<a href="#_current" >_current</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#statusIcons" >statusIcons</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#getCurrentState" >getCurrentState</a>
</li>
<li>
<a href="#onClick" >onClick</a>
</li>
<li>
<span class="modifier">Private</span>
<a href="#setProgressIndicatorStates" >setProgressIndicatorStates</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#skeletonSteps" >skeletonSteps</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#current" >current</a>
</li>
<li>
<a href="#orientation" >orientation</a>
</li>
<li>
<a href="#skeleton" >skeleton</a>
</li>
<li>
<a href="#spacing" >spacing</a>
</li>
<li>
<a href="#steps" >steps</a>
</li>
<li>
<a href="#translations" >translations</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Outputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#stepSelected" >stepSelected</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#current" >current</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="105" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:105</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>i18n</td>
<td>
<code><a href="../injectables/I18n.html" target="_self" >I18n</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="current"></a>
<b>current</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="73" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:73</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="orientation"></a>
<b>orientation</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"horizontal" | "vertical"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"horizontal"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="93" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:93</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="skeleton"></a>
<b>skeleton</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="94" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:94</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="spacing"></a>
<b>spacing</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>"default" | "equal"</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>"default"</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="95" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:95</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="steps"></a>
<b>steps</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/Step.html" target="_self" >Array<Step></a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="89" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:89</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="translations"></a>
<b>translations</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.i18n.get().PROGRESS_INDICATOR</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="92" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:92</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-outputs">
<h3 id="outputs">Outputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="stepSelected"></a>
<b>stepSelected</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>EventEmitter</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="90" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:90</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getCurrentState"></a>
<span class="name">
<span ><b>getCurrentState</b></span>
<a href="#getCurrentState"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getCurrentState(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="129"
class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:129</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Gets current state based on weight of the state
Weight of state goes from error, incomplete, current, and complete</p>
<p>This function is used to determine which icon & translation string to display</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>index</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
<td>
<p>number</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>"current" | "invalid" | "complete" | "incomplete"</code>
</div>
<div class="io-description">
<p>string</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="onClick"></a>
<span class="name">
<span ><b>onClick</b></span>
<a href="#onClick"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>onClick(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="114"
class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:114</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Executes click function if <code>onClick</code> exists for step
<code>Current</code> step functions will not be executed</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>index</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
<td>
<p>number</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setProgressIndicatorStates"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>setProgressIndicatorStates</b></span>
<a href="#setProgressIndicatorStates"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>setProgressIndicatorStates()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="141"
class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:141</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="skeletonSteps"></a>
<span class="name">
<span class="modifier">Static</span>
<span ><b>skeletonSteps</b></span>
<a href="#skeletonSteps"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>skeletonSteps(stepCount: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="80"
class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:80</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>stepCount</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>{}</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="_current"></a>
<span class="name">
<span class="modifier">Private</span>
<span ><b>_current</b></span>
<a href="#_current"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="105" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:105</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="statusIcons"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>statusIcons</b></span>
<a href="#statusIcons"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/object" target="_blank" >object</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{
current: "incomplete",
complete: "checkmark--outline",
invalid: "warning",
incomplete: "circle-dash"
}</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="98" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:98</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-accessors">
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="current"></a>
<span class="name"><b>current</b><a href="#current"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>current()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="73" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:73</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>set</b><code>current(current: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="76" class="link-to-prism">src/progress-indicator/progress-indicator.component.ts:76</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>current</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
Component,
Input,
Output,
EventEmitter
} from "@angular/core";
import { I18n } from "carbon-components-angular/i18n";
import { Step } from "./progress-indicator-step.interface";
/**
* Get started with importing the module:
*
* ```typescript
* import { ProgressIndicatorModule } from 'carbon-components-angular';
* ```
*
* [See demo](../../?path=/story/components-progress-indicator--basic)
*/
@Component({
selector: "cds-progress-indicator, ibm-progress-indicator",
template: `
<ul
data-progress
data-progress-current
class="cds--progress"
[ngClass]="{
'cds--skeleton': skeleton,
'cds--progress--vertical': (orientation === 'vertical'),
'cds--progress--space-equal': spacing === 'equal' && orientation !== 'vertical'
}">
<li
class="cds--progress-step"
*ngFor="let step of steps; let i = index"
[ngClass]="{
'cds--progress-step--disabled' : step.disabled,
'cds--progress-step--complete' : step.complete,
'cds--progress-step--incomplete' : !step.complete && i !== current,
'cds--progress-step--current': i === current
}">
<button
type="button"
class="cds--progress-step-button"
[ngClass]="{
'cds--progress-step-button--unclickable': !step.onClick || current === i
}"
[disabled]="step.disabled"
[attr.aria-disabled]="step.disabled"
[tabindex]="(current !== i && step.onClick && !step.disabled) ? 0 : -1"
[title]="step.label"
(click)="onClick(i)">
<span class="cds--assistive-text">
{{this.translations[getCurrentState(i)?.toUpperCase()]}}
</span>
<svg
[cdsIcon]="statusIcons[getCurrentState(i)]"
size="16"
[ngClass]="{
'cds--progress__warning': step.invalid && i !== current
}">
<title *ngIf="step.description">{{step.description}}</title>
</svg>
<div class="cds--progress-text">
<p class="cds--progress-label">{{step.label}}</p>
<p *ngIf="step.secondaryLabel" class="cds--progress-optional">{{step.secondaryLabel}}</p>
</div>
<span class="cds--progress-line"></span>
</button>
</li>
</ul>
`
})
export class ProgressIndicator {
@Input() get current() {
return this._current;
}
set current(current: number) {
this._current = current;
this.setProgressIndicatorStates();
}
static skeletonSteps(stepCount: number) {
const steps = [];
for (let i = 0; i < stepCount; i++) {
steps.push({ complete: false });
}
return steps;
}
@Input() steps: Array<Step>;
@Output() stepSelected = new EventEmitter<{ step: Step, index: number }>();
@Input() translations = this.i18n.get().PROGRESS_INDICATOR;
@Input() orientation: "horizontal" | "vertical" = "horizontal";
@Input() skeleton = false;
@Input() spacing: "default" | "equal" = "default";
// Get icon names based for each status
readonly statusIcons = {
current: "incomplete",
complete: "checkmark--outline",
invalid: "warning",
incomplete: "circle-dash"
};
private _current: number;
constructor(protected i18n: I18n) { }
/**
* Executes click function if `onClick` exists for step
* `Current` step functions will not be executed
* @param index number
*/
onClick(index: number) {
if (index !== this.current && typeof this.steps[index].onClick === "function") {
this.steps[index].onClick();
}
this.stepSelected.emit({ step: this.steps[index], index });
}
/**
* Gets current state based on weight of the state
* Weight of state goes from error, incomplete, current, and complete
*
* This function is used to determine which icon & translation string to display
* @param index number
* @returns string
*/
getCurrentState(index: number) {
if (index === this.current) {
return "current";
} else if (this.steps[index].invalid) {
return "invalid";
} else if (this.steps[index].complete) {
return "complete";
}
return "incomplete";
}
private setProgressIndicatorStates() {
if (this.steps === undefined) {
return;
}
// Set all preceding steps to `complete` & following to `incomplete`
this.steps.forEach((step: Step, index) => {
if (index < this.current) {
step.complete = true;
} else {
step.complete = false;
}
});
}
}
</code></pre>
</div>
<div class="tab-pane fade " id="tree">
<div id="tree-container"></div>
<div class="tree-legend">
<div class="title">
<b>Legend</b>
</div>
<div>
<div class="color htmlelement"></div><span>Html element</span>
</div>
<div>
<div class="color component"></div><span>Component</span>
</div>
<div>
<div class="color directive"></div><span>Html element with directive</span>
</div>
</div>
</div>
</div>
<script src="../js/libs/vis.min.js"></script>
<script src="../js/libs/htmlparser.js"></script>
<script src="../js/libs/deep-iterator.js"></script>
<script>
var COMPONENT_TEMPLATE = '<div><ul data-progress data-progress-current class="cds--progress" [ngClass]="{ \'cds--skeleton\': skeleton, \'cds--progress--vertical\': (orientation === \'vertical\'), \'cds--progress--space-equal\': spacing === \'equal\' && orientation !== \'vertical\' }"> <li class="cds--progress-step" *ngFor="let step of steps; let i = index" [ngClass]="{ \'cds--progress-step--disabled\' : step.disabled, \'cds--progress-step--complete\' : step.complete, \'cds--progress-step--incomplete\' : !step.complete && i !== current, \'cds--progress-step--current\': i === current }"> <button type="button" class="cds--progress-step-button" [ngClass]="{ \'cds--progress-step-button--unclickable\': !step.onClick || current === i }" [disabled]="step.disabled" [attr.aria-disabled]="step.disabled" [tabindex]="(current !== i && step.onClick && !step.disabled) ? 0 : -1" [title]="step.label" (click)="onClick(i)"> <span class="cds--assistive-text"> {{this.translations[getCurrentState(i)?.toUpperCase()]}} </span> <svg [cdsIcon]="statusIcons[getCurrentState(i)]" size="16" [ngClass]="{ \'cds--progress__warning\': step.invalid && i !== current }"> <title *ngIf="step.description">{{step.description}}</title> </svg> <div class="cds--progress-text"> <p class="cds--progress-label">{{step.label}}</p> <p *ngIf="step.secondaryLabel" class="cds--progress-optional">{{step.secondaryLabel}}</p> </div> <span class="cds--progress-line"></span> </button> </li></ul></div>'
var COMPONENTS = [{'name': 'Accordion', 'selector': 'cds-accordion, ibm-accordion'},{'name': 'AccordionItem', 'selector': 'cds-accordion-item, ibm-accordion-item'},{'name': 'ActionableNotification', 'selector': 'cds-actionable-notification, ibm-actionable-notification'},{'name': 'AlertModal', 'selector': 'cds-alert-modal, ibm-alert-modal'},{'name': 'BaseIconButton', 'selector': ''},{'name': 'BaseNotification', 'selector': ''},{'name': 'BaseTabHeader', 'selector': ''},{'name': 'Breadcrumb', 'selector': 'cds-breadcrumb, ibm-breadcrumb'},{'name': 'BreadcrumbItemComponent', 'selector': 'cds-breadcrumb-item, ibm-breadcrumb-item'},{'name': 'ButtonSet', 'selector': 'cds-button-set, ibm-button-set'},{'name': 'Checkbox', 'selector': 'cds-checkbox, ibm-checkbox'},{'name': 'ClickableTile', 'selector': 'cds-clickable-tile, ibm-clickable-tile'},{'name': 'CodeSnippet', 'selector': 'cds-code-snippet, ibm-code-snippet'},{'name': 'ComboBox', 'selector': 'cds-combo-box, ibm-combo-box'},{'name': 'ComboButtonComponent', 'selector': 'cds-combo-button'},{'name': 'ContainedList', 'selector': 'cds-contained-list, ibm-contained-list'},{'name': 'ContainedListItem', 'selector': 'cds-contained-list-item, ibm-contained-list-item'},{'name': 'ContentSwitcher', 'selector': 'cds-content-switcher, ibm-content-switcher'},{'name': 'ContextMenuComponent', 'selector': 'cds-menu, cds-context-menu, ibm-context-menu'},{'name': 'ContextMenuDividerComponent', 'selector': 'cds-menu-divider, cds-context-menu-divider, ibm-context-menu-divider'},{'name': 'ContextMenuGroupComponent', 'selector': 'cds-menu-group, cds-context-menu-group, ibm-context-menu-group'},{'name': 'ContextMenuItemComponent', 'selector': 'cds-menu-item, cds-context-menu-item, ibm-context-menu-item'},{'name': 'DatePicker', 'selector': 'cds-date-picker, ibm-date-picker'},{'name': 'DatePickerInput', 'selector': 'cds-date-picker-input, ibm-date-picker-input'},{'name': 'Dialog', 'selector': 'cds-dialog, ibm-dialog'},{'name': 'Documentation', 'selector': 'cds-documentation'},{'name': 'Dropdown', 'selector': 'cds-dropdown, ibm-dropdown'},{'name': 'DropdownList', 'selector': 'cds-dropdown-list, ibm-dropdown-list'},{'name': 'ExpandableTile', 'selector': 'cds-expandable-tile, ibm-expandable-tile'},{'name': 'FileComponent', 'selector': 'cds-file, ibm-file'},{'name': 'FileUploader', 'selector': 'cds-file-uploader, ibm-file-uploader'},{'name': 'Hamburger', 'selector': 'cds-hamburger, ibm-hamburger'},{'name': 'Header', 'selector':