@stratio/egeo
Version:
94 lines (90 loc) • 3.32 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Stratio Egeo - Documentation</title>
<base href="/">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" type="image/png" href="assets/images/favicon.png">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css" integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">
</head>
<body class="container-fluid">
<a href="/index.html">Go Back to index</a><br>
<h1 id="breadcrumbscomponent">Breadcrumbs (Component)</h1>
<p>The breadcrumb is s a type of secondary navigation element that shows a trail for allowing users to keep track of their location.</p>
<h2 id="inputs">Inputs</h2>
<table class="table table-striped">
<thead>
<tr>
<th id="property">Property</th>
<th id="type">Type</th>
<th id="req">Req</th>
<th id="description">Description</th>
<th id="default">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>options</td>
<td>StBreadCrumbItem[]</td>
<td>False</td>
<td>] List of navigation parts for show in breadcrumb</td>
<td>[\</td>
</tr>
<tr>
<td>elementsToShow</td>
<td>Number</td>
<td>False</td>
<td>Max number of elements to show.</td>
<td>5</td>
</tr>
<tr>
<td>mode</td>
<td>StBreadCrumbMode</td>
<td>False</td>
<td>Visualization mode</td>
<td>StBreadCrumbMode.DEFAULT</td>
</tr>
<tr>
<td>qaTag</td>
<td>String</td>
<td>False</td>
<td>Id value for qa test</td>
<td>''</td>
</tr>
</tbody>
</table>
<h2 id="outputs">Outputs</h2>
<table class="table table-striped">
<thead>
<tr>
<th id="property">Property</th>
<th id="type">Type</th>
<th id="description">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>select</td>
<td>Number</td>
<td>Notify any item selection</td>
</tr>
</tbody>
</table>
<h2 id="example">Example</h2>
<pre><code class="html language-html"><st-breadcrumbs [options]="options"
(select)="onSelect($event)"
qaTag="breadcrumbs">
</st-breadcrumbs>
</code></pre>
<h2 id="models">Models</h2>
<p><em>Id, optional label and icon of an option</em> (StBreadCrumbItem)</p>
<pre><code class="typescript language-typescript">export class StBreadCrumbItem {
id: string;
label ? : string;
icon ? : string;
}
</code></pre>
</body>
</html>