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

Doc refactor for MultiSelect and Dropdown

pull/12/head
cagataycivici 2019-05-22 16:49:45 +03:00
parent f1c9783bde
commit 9b2cdeae83
3 changed files with 139 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/components/multiselect/MultiSelect.vue
View File

@ -61,6 +61,8 @@ export default {
value: null,
options: Array,
optionLabel: null,
optionValue: null,
optionDisabled: null,
scrollHeight: {
type: String,
default: '200px'
@ -70,8 +72,6 @@ export default {
filter: Boolean,
tabindex: String,
dataKey: null,
optionValue: null,
optionDisabled: null,
filterPlaceholder: String
},
data() {

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

@ -39,7 +39,7 @@ data() {
</CodeHighlight>
<h3>Custom Content</h3>
<p>Label of an option is used as the display text of an item by default, for custom content support define an <i>item</i> template that gets the option instance as a parameter and returns the content.</p>
<p>Label of an option is used as the display text of an item by default, for custom content support define an <i>option</i> template that gets the option instance as a parameter.</p>
<CodeHighlight>
<template v-pre>
&lt;Dropdown v-model=&quot;selectedCar&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select a Car&quot; :filter=&quot;true&quot; :showClear=&quot;true&quot;&gt;

53
src/views/multiselect/MultiSelectDoc.vue
View File

@ -8,7 +8,7 @@ import MultiSelect from 'primevue/multiselect';
</CodeHighlight>
<h3>Getting Started</h3>
<p>MultiSelect 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>MultiSelect 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>
&lt;MultiSelect v-model=&quot;selectedCars&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select Brands&quot; /&gt;
</CodeHighlight>
@ -33,12 +33,11 @@ data() {
</CodeHighlight>
<h3>Custom Content</h3>
<p>Label of an option is used as the display text of an item by default, for custom content support define a template where
the local template variable refers to an option in the options collection. </p>
<p>In addition <i>#value</i> can be used to customize the selected values display instead of the default comma separated list.</p>
<p>Label of an option is used as the display text of an item by default, for custom content support define an <i>option</i> template that gets the option instance as a parameter.</p>
<p>In addition the <i>value</i> template can be used to customize the selected values display instead of the default comma separated list.</p>
<CodeHighlight>
<template v-pre>
&lt;MultiSelect v-model=&quot;selectedCars2&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select a Car&quot; :filter=&quot;true&quot;&gt;
&lt;MultiSelect v-model=&quot;selectedCars2&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select a Car&quot;&gt;
&lt;template #value=&quot;slotProps&quot;&gt;
&lt;div class=&quot;p-multiselect-car-token&quot; v-for=&quot;option of slotProps.value&quot; :key=&quot;option.brand&quot;&gt;
&lt;img :alt=&quot;option.brand&quot; :src=&quot;'/demo/images/car/' + option.brand + '.png'&quot; /&gt;
@ -59,7 +58,7 @@ data() {
</CodeHighlight>
<h3>Filter</h3>
<p>Filtering allows searching items in the list using an input field at the header. In order to use filtering, enable filter property.</p>
<p>Filtering allows searching items in the list using an input field at the header. In order to use filtering, enable the <i>filter</i> property.</p>
<CodeHighlight>
&lt;MultiSelect v-model=&quot;selectedCars&quot; :options=&quot;cars&quot; :filter=&quot;true&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select Brands&quot;/&gt;
</CodeHighlight>
@ -78,7 +77,7 @@ data() {
<tbody>
<tr>
<td>value</td>
<td>array</td>
<td>any</td>
<td>null</td>
<td>Value of the component.</td>
</tr>
@ -92,7 +91,19 @@ data() {
<td>optionLabel</td>
<td>string</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>
<td>scrollHeight</td>
@ -119,7 +130,7 @@ data() {
<td>When specified, displays an input field to filter the items on keyup.</td>
</tr>
<tr>
<td>tabIndex</td>
<td>tabindex</td>
<td>string</td>
<td>null</td>
<td>Index of the element in tabbing order.</td>
@ -136,18 +147,6 @@ data() {
<td>null</td>
<td>Placeholder text to show when filter input is empty.</td>
</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>
</table>
</div>
@ -165,16 +164,14 @@ data() {
<tbody>
<tr>
<td>change</td>
<td>event.originalEvent: Browser event<br />
event.value: Current selected values<br />
</td>
<td>Callback to invoke when value changes.</td>
<td>event.originalEvent: Original event <br />
event.value: Selected option value </td>
<td>Callback to invoke on value change.</td>
</tr>
<tr>
<td>input</td>
<td>event: Current selected values<br />
</td>
<td>Callback to invoke when value changes.</td>
<td>value: New value</td>
<td>Callback to invoke on value change.</td>
</tr>
</tbody>
</table>