vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Doc refactor for Dropdown

pull/12/head
cagataycivici 2019-05-22 16:38:59 +03:00
parent af502f91a1
commit c869e4b98a
1 changed files with 151 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/views/dropdown/DropdownDoc.vue
View File

@ -8,7 +8,7 @@ import Dropdown from 'primevue/dropdown';
</CodeHighlight> </CodeHighlight>
<h3>Getting Started</h3> <h3>Getting Started</h3>
<p>Dropdown requires a value to bind, optionLabel and a collection of options. How to define the options property; Providing an array of arbitrary objects along with the <i>optionLabel</i> property to specify the field name of the option.</p> <p>Dropdown requires a value to bind and a collection of arbitrary objects along with the <i>optionLabel</i> property to specify the field name of the option.</p>
<CodeHighlight> <CodeHighlight>
&lt;Dropdown v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; placeholder=&quot;Select a City&quot; /&gt; &lt;Dropdown v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; placeholder=&quot;Select a City&quot; /&gt;
</CodeHighlight> </CodeHighlight>
@ -81,7 +81,19 @@ data() {
<td>optionLabel</td> <td>optionLabel</td>
<td>string</td> <td>string</td>
<td>null</td> <td>null</td>
<td>Name of the label field of an option when an arbitrary objects instead of SelectItems are used as options.</td> <td>Property name to use as the label of an option.</td>
</tr>
<tr>
<td>optionValue</td>
<td>string</td>
<td>null</td>
<td>Property name to use as the value of an option, defaults to the option itself when not defined.</td>
</tr>
<tr>
<td>optionDisabled</td>
<td>boolean</td>
<td>null</td>
<td>Property name to use as the disabled flag of an option, defaults to false when not defined.</td>
</tr> </tr>
<tr> <tr>
<td>scrollHeight</td> <td>scrollHeight</td>
@ -137,18 +149,6 @@ data() {
<td>null</td> <td>null</td>
<td>Index of the element in tabbing order.</td> <td>Index of the element in tabbing order.</td>
</tr> </tr>
<tr>
<td>optionValue</td>
<td>string</td>
<td>null</td>
<td>???</td>
</tr>
<tr>
<td>optionDisabled</td>
<td>boolean</td>
<td>null</td>
<td>???</td>
</tr>
</tbody> </tbody>
</table> </table>
</div> </div>
@ -168,12 +168,12 @@ data() {
<td>change</td> <td>change</td>
<td>event.originalEvent: Original event <br /> <td>event.originalEvent: Original event <br />
event.value: Selected option value </td> event.value: Selected option value </td>
<td>Callback to invoke on value change</td> <td>Callback to invoke on value change.</td>
</tr> </tr>
<tr> <tr>
<td>input</td> <td>input</td>
<td>event: Input field value</td> <td>value: New value</td>
<td>Callback to invoke on input event of input field (editable mode).</td> <td>Callback to invoke on value change.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>