@stratio/egeo
Version:
107 lines (103 loc) • 3.66 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="checkboxcomponent">Checkbox (Component)</h1>
<p>The checkbox component represents a custom input of the checkbox type.</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>checked</td>
<td>Boolean</td>
<td>False</td>
<td></td>
<td>''</td>
</tr>
<tr>
<td>name</td>
<td>Boolean</td>
<td>False</td>
<td>This parameter shows the final name of the input</td>
<td>''</td>
</tr>
<tr>
<td>qaTag</td>
<td>Boolean</td>
<td>False</td>
<td>Id value for qa test</td>
<td>''</td>
</tr>
<tr>
<td>disabled</td>
<td>Boolean</td>
<td>False</td>
<td>It allows to disable the input component of the checkbox</td>
<td>''</td>
</tr>
<tr>
<td>required</td>
<td>Boolean</td>
<td>False</td>
<td>It converts the component into a mandatory field in a form</td>
<td>''</td>
</tr>
<tr>
<td>readonly</td>
<td>Boolean</td>
<td>False</td>
<td>This parameter disables the checkbox and it can not be modified by the user</td>
<td>''</td>
</tr>
<tr>
<td>value</td>
<td>Any</td>
<td>False</td>
<td>The value of the checkbox</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>change</td>
<td>{ checked: boolean, value: any</td>
<td>} This is emitted when user clicks on the checkbox</td>
</tr>
</tbody>
</table>
<h2 id="example">Example</h2>
<pre><code class="html language-html"><st-checkbox name="option"
value="1">
Option 1
</st-checkbox>
</code></pre>
</body>
</html>