@stratio/egeo
Version:
192 lines (188 loc) • 6.62 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="titlecomponent">{TITLE} (Component)</h1>
<p>InputThis component specifies an input field where the user can enter data.</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>placeholder</td>
<td>String</td>
<td>False</td>
<td>The text that appears as placeholder of the input. It is empty by default</td>
<td>null</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>False</td>
<td>Input name</td>
<td>''</td>
</tr>
<tr>
<td>label</td>
<td>String</td>
<td>False</td>
<td>Label to show over the input. It is empty by default</td>
<td>''</td>
</tr>
<tr>
<td>fieldType</td>
<td>'text' | 'number' | 'password'</td>
<td>False</td>
<td>Input type</td>
<td>'text'</td>
</tr>
<tr>
<td>errors</td>
<td>StInputError</td>
<td>False</td>
<td>Customized error messages</td>
<td></td>
</tr>
<tr>
<td>qaTag</td>
<td>String</td>
<td>False</td>
<td>Id value for qa test</td>
<td>''</td>
</tr>
<tr>
<td>forceValidations</td>
<td>Boolean</td>
<td>False</td>
<td>If you specify it to 'true', the input checks the errors before being modified by user</td>
<td>false</td>
</tr>
<tr>
<td>contextualHelp</td>
<td>String</td>
<td>False</td>
<td>It will be displayed when user clicks on the info button</td>
<td>''</td>
</tr>
<tr>
<td>maxLength</td>
<td>String</td>
<td>False</td>
<td>Define a max-length for input field</td>
<td>''</td>
</tr>
<tr>
<td>min</td>
<td>String</td>
<td>False</td>
<td>Define a minimum number for number inputs</td>
<td>''</td>
</tr>
<tr>
<td>max</td>
<td>String</td>
<td>False</td>
<td>Define a maximum number for number inputs</td>
<td>''</td>
</tr>
<tr>
<td>isFocused</td>
<td>Boolean</td>
<td>False</td>
<td>If true, the input will be focused on view init.</td>
<td>false</td>
</tr>
<tr>
<td>readonly</td>
<td>Boolean</td>
<td>False</td>
<td>This parameter disables the input and it can not be modified by the user</td>
<td>''</td>
</tr>
<tr>
<td>step</td>
<td>String</td>
<td>False</td>
<td>It specifies the interval between legal numbers in the input field</td>
<td>''</td>
</tr>
<tr>
<td>default</td>
<td>String</td>
<td>False</td>
<td>Default value of input</td>
<td></td>
</tr>
<tr>
<td>autocompleteList</td>
<td>(StDropDownMenuItem | StDropDownMenuGroup)[]</td>
<td>False</td>
<td>List to be used for autocomplete feature. It is empty by default</td>
<td>Array()</td>
</tr>
<tr>
<td>charsToShowAutocompleteList</td>
<td>Number</td>
<td>False</td>
<td>Number of characters before displaying autocomplete list. By default is 1</td>
<td>1</td>
</tr>
<tr>
<td>value</td>
<td>Any</td>
<td>False</td>
<td>Value of the input</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>blur</td>
<td></td>
<td>Notify when user leaves a field</td>
</tr>
</tbody>
</table>
<h2 id="example">Example</h2>
<pre><code class="html language-html"><st-input class="st-form-field"
type="text"
formControlName="name"
placeholder="Enter your name"
label="Field"
default="default name"
contextualHelp="This is a normal field">
</st-input>
</code></pre>
<h2 id="models">Models</h2>
<p><em>Error messages</em> (StInputError)</p>
<pre><code class="typescript language-typescript">
</code></pre>
</body>
</html>