@stratio/egeo
Version:
109 lines (105 loc) • 3.96 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="filterselectorcomponent">Filter selector (Component)</h1>
<p>The filter selector allows display a filter with a list of options</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>openFilter</td>
<td>Boolean</td>
<td>False</td>
<td>This boolean is needed to specify the status of the filter (open or closed)</td>
<td>false</td>
</tr>
<tr>
<td>filterList</td>
<td>StDropDownMenuItem[]</td>
<td>False</td>
<td>List of options</td>
<td></td>
</tr>
<tr>
<td>selected</td>
<td>StDropDownMenuItem</td>
<td>False</td>
<td>Selected option</td>
<td></td>
</tr>
<tr>
<td>menuAlignedToRight</td>
<td>Boolean</td>
<td>False</td>
<td>Boolean to indicate if menu has to be displayed aligned to the right</td>
<td>false</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>clickFilter</td>
<td>StDropDownMenuItem</td>
<td>Event emitted when an option is selected</td>
</tr>
<tr>
<td>changeFilterVisibility</td>
<td>Boolean</td>
<td>Event emitted when visibility of options changes</td>
</tr>
<tr>
<td>closeFilter</td>
<td>Boolean</td>
<td>Event emitted when option menu is closed</td>
</tr>
<tr>
<td>itemMouseEnter</td>
<td>StDropDownMenuItem</td>
<td>Event emitted when mouse is over an item</td>
</tr>
<tr>
<td>itemMouseLeave</td>
<td>StDropDownMenuItem</td>
<td>Event emitted when mouse leaves an item</td>
</tr>
</tbody>
</table>
<h2 id="example">Example</h2>
<pre><code class="html language-html"><st-filter-selector [filterList]="filter"
[openFilter]="openFilter"
[selected]="selectedFilter"
(clickFilter)="onFilter($event)"
(changeFilterVisibility)="onChangeFilterVisibility()"
(closeFilter)="onCloseFilter()">
</st-filter-selector>
</code></pre>
</body>
</html>