@stratio/egeo
Version:
93 lines (89 loc) • 3.14 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="tagcomponent">Tag (Component)</h1>
<p>The tag component allows to display small texts.</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>tag</td>
<td>StTagItem</td>
<td>False</td>
<td>Item that contains the tag info</td>
<td></td>
</tr>
<tr>
<td>removable</td>
<td>Boolean</td>
<td>False</td>
<td>Boolean to display or not the cross icon to remove tag</td>
<td></td>
</tr>
<tr>
<td>clickable</td>
<td>Boolean</td>
<td>False</td>
<td>Boolean to set tag as clicklable or not</td>
<td>true</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>remove</td>
<td>StTagItem</td>
<td>Even emitted when cross icon is clicked</td>
</tr>
<tr>
<td>click</td>
<td>StTagItem</td>
<td>Event emitted when tag is clicked</td>
</tr>
</tbody>
</table>
<h2 id="example">Example</h2>
<pre><code class="html language-html"><st-tag [tag]="simpleTag"
class="small"
[removable]="true"></st-tag>
</code></pre>
<h2 id="models">Models</h2>
<p><em>StTagItem</em> (StTagItem)</p>
<pre><code class="typescript language-typescript">export class StTagItem {
id: any;
text: string;
icon ? : string;
bubble ? : string;
[key: string]: any;
}
</code></pre>
</body>
</html>