@stratio/egeo
Version:
157 lines (153 loc) • 5.49 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="textarecomponent">Textare (Component)</h1>
<p>The textarea component is for use normally inside a form, you can use too outside a form like a template driven form.</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 textarea. It is empty by default</td>
<td>''</td>
</tr>
<tr>
<td>name</td>
<td>String</td>
<td>False</td>
<td>Name of the textarea</td>
<td>''</td>
</tr>
<tr>
<td>label</td>
<td>String</td>
<td>False</td>
<td>Label to show over the textarea. It is empty by default</td>
<td>''</td>
</tr>
<tr>
<td>errors</td>
<td>StTextareaError</td>
<td>False</td>
<td>Error to show for each error case, if you don\'t provide this parameter,the default behaviour is only to change color without message</td>
<td>''</td>
</tr>
<tr>
<td>qaTag</td>
<td>String</td>
<td>False</td>
<td>Id 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 textarea 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 textarea field</td>
<td>''</td>
</tr>
<tr>
<td>isFocused</td>
<td>Boolean</td>
<td>False</td>
<td>If true, the textarea will be focused on view init.</td>
<td>false</td>
</tr>
<tr>
<td>cols</td>
<td>Number</td>
<td>False</td>
<td>Define textarea number of cols</td>
<td>''</td>
</tr>
<tr>
<td>rows</td>
<td>Number</td>
<td>False</td>
<td>Define textarea number of rows</td>
<td>''</td>
</tr>
<tr>
<td>wrap</td>
<td>String</td>
<td>False</td>
<td>Define type of wrap as html standard</td>
<td>'soft'</td>
</tr>
<tr>
<td>default</td>
<td>String</td>
<td>False</td>
<td>Default value of textarea</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-textarea label="Components"
placeholder="Number of components"
[forceValidations]="forceValidations"
[errors]="errorsTextarea"
name="components-template"
qaTag="components-textarea-template"
required
[(ngModel)]="model.components"
contextualHelp="This is the contextual help of the components"
[cols]="50"
[rows]="10">
</st-textarea>
</code></pre>
</body>
</html>