From eb56958a973a100cf1754c6aac2cc316f99cbe58 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Merve=20=C3=96z=C3=A7if=C3=A7i?= <merveozcifci7@gmail.com>
Date: Mon, 25 Mar 2019 17:43:00 +0300
Subject: [PATCH] MultiSelect doc added

---
 src/components/multiselect/MultiSelect.vue |  19 +-
 src/views/multiselect/MultiSelectDemo.vue  |   7 +
 src/views/multiselect/MultiSelectDoc.vue   | 348 +++++++++++++++++++++
 3 files changed, 364 insertions(+), 10 deletions(-)
 create mode 100644 src/views/multiselect/MultiSelectDoc.vue

diff --git a/src/components/multiselect/MultiSelect.vue b/src/components/multiselect/MultiSelect.vue
index 6a706d9c7..d2f10800a 100644
--- a/src/components/multiselect/MultiSelect.vue
+++ b/src/components/multiselect/MultiSelect.vue
@@ -60,19 +60,18 @@ export default {
     props: {
         value: null,
         options: Array,
+		optionLabel: null,
+		scrollHeight: {
+			type: String,
+			default: '200px'
+		},
+		placeholder: String,
+		disabled: Boolean,
+		filter: Boolean,
+		tabindex: String,
         dataKey: null,
-        filter: Boolean,
-        optionLabel: null,
         optionValue: null,
         optionDisabled: null,
-        disabled: Boolean,
-        tabindex: String,
-        editable: Boolean,
-        placeholder: String,
-        scrollHeight: {
-            type: String,
-            default: '200px'
-        },
         filterPlaceholder: String
     },
     data() {
diff --git a/src/views/multiselect/MultiSelectDemo.vue b/src/views/multiselect/MultiSelectDemo.vue
index 84e06e15a..cb766f11a 100644
--- a/src/views/multiselect/MultiSelectDemo.vue
+++ b/src/views/multiselect/MultiSelectDemo.vue
@@ -30,10 +30,14 @@
                 </template>
             </MultiSelect>
         </div>
+
+        <MultiSelectDoc/>
     </div>
 </template>
 
 <script>
+import MultiSelectDoc from './MultiSelectDoc';
+
 export default {
     data() {
         return {
@@ -51,6 +55,9 @@ export default {
                 {brand: 'Volvo', value: 'Volvo'}
             ]
         }
+    },
+    components: {
+        'MultiSelectDoc': MultiSelectDoc
     }
 }
 </script>
diff --git a/src/views/multiselect/MultiSelectDoc.vue b/src/views/multiselect/MultiSelectDoc.vue
new file mode 100644
index 000000000..e49ea14a2
--- /dev/null
+++ b/src/views/multiselect/MultiSelectDoc.vue
@@ -0,0 +1,348 @@
+<template>
+	<div class="content-section documentation">
+		<TabView>
+			<TabPanel header="Documentation">
+				<h3>Import</h3>
+<CodeHighlight lang="javascript">
+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>
+<CodeHighlight>
+&lt;MultiSelect v-model=&quot;selectedCars&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select Brands&quot; /&gt;
+</CodeHighlight>
+
+<CodeHighlight lang="js">
+data() {
+	return {
+		selectedCars: null,
+		cars: [
+			{brand: 'Audi', value: 'Audi'},
+			{brand: 'Bmw', value: 'Bmw'},
+			{brand: 'Fiat', value: 'Fiat'},
+			{brand: 'Honda', value: 'Honda'},
+			{brand: 'Jaguar', value: 'Jaguar'},
+			{brand: 'Mercedes', value: 'Mercedes'},
+			{brand: 'Renault', value: 'Renault'},
+			{brand: 'Volkswagen', value: 'Volkswagen'},
+			{brand: 'Volvo', value: 'Volvo'}
+		]
+	}
+}
+</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>
+<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;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;
+			&lt;span&gt;{{option.brand}}&lt;/span&gt;
+		&lt;/div&gt;
+		&lt;div class=&quot;p-multiselect-empty-car-token&quot; v-if=&quot;!slotProps.value || slotProps.value.length === 0&quot;&gt;
+			Select Brands
+		&lt;/div&gt;
+	&lt;/template&gt;
+	&lt;template #option=&quot;slotProps&quot;&gt;
+		&lt;div class=&quot;p-multiselect-car-option&quot;&gt;
+			&lt;img :alt=&quot;slotProps.option.brand&quot; :src=&quot;'/demo/images/car/' + slotProps.option.brand + '.png'&quot; /&gt;
+			&lt;span&gt;{{slotProps.option.brand}}&lt;/span&gt;
+		&lt;/div&gt;
+	&lt;/template&gt;
+&lt;/MultiSelect&gt;
+</template>
+</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>
+<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>
+
+				<h3>Properties</h3>
+				<div class="doc-tablewrapper">
+					<table class="doc-table">
+						<thead>
+						<tr>
+							<th>Name</th>
+							<th>Type</th>
+							<th>Default</th>
+							<th>Description</th>
+						</tr>
+						</thead>
+						<tbody>
+						<tr>
+							<td>value</td>
+							<td>array</td>
+							<td>null</td>
+							<td>Value of the component.</td>
+						</tr>
+						<tr>
+							<td>options</td>
+							<td>array</td>
+							<td>null</td>
+							<td>An array of selectitems to display as the available options.</td>
+						</tr>
+						<tr>
+							<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>
+						</tr>
+						<tr>
+							<td>scrollHeight</td>
+							<td>string</td>
+							<td>200px</td>
+							<td>Height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value.</td>
+						</tr>
+						<tr>
+							<td>placeholder</td>
+							<td>string</td>
+							<td>null</td>
+							<td>Label to display when there are no selections.</td>
+						</tr>
+						<tr>
+							<td>disabled</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When present, it specifies that the component should be disabled.</td>
+						</tr>
+						<tr>
+							<td>filter</td>
+							<td>boolean</td>
+							<td>true</td>
+							<td>When specified, displays an input field to filter the items on keyup.</td>
+						</tr>
+						<tr>
+							<td>tabIndex</td>
+							<td>string</td>
+							<td>null</td>
+							<td>Index of the element in tabbing order.</td>
+						</tr>
+						<tr>
+							<td>dataKey</td>
+							<td>string</td>
+							<td>null</td>
+							<td>A property to uniquely match the value in options for better performance.</td>
+						</tr>
+						<tr>
+							<td>filterPlaceholder</td>
+							<td>string</td>
+							<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>
+
+				<h3>Events</h3>
+				<div class="doc-tablewrapper">
+					<table class="doc-table">
+						<thead>
+						<tr>
+							<th>Name</th>
+							<th>Parameters</th>
+							<th>Description</th>
+						</tr>
+						</thead>
+						<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>
+						</tr>
+						<tr>
+							<td>input</td>
+							<td>event: Current selected values<br />
+							</td>
+							<td>Callback to invoke when value changes.</td>
+						</tr>
+						</tbody>
+					</table>
+				</div>
+
+				<h3>Styling</h3>
+				<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>
+				<div class="doc-tablewrapper">
+					<table class="doc-table">
+						<thead>
+						<tr>
+							<th>Name</th>
+							<th>Element</th>
+						</tr>
+						</thead>
+						<tbody>
+						<tr>
+							<td>p-multiselect</td>
+							<td>Container element.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-label-container</td>
+							<td>Container of the label to display selected items.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-label-container</td>
+							<td>Label to display selected items.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-trigger</td>
+							<td>Dropdown button.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-filter-container</td>
+							<td>Container of filter input.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-panel</td>
+							<td>Overlay panel for items.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-items</td>
+							<td>List container of items.</td>
+						</tr>
+						<tr>
+							<td>p-multiselect-item</td>
+							<td>An item in the list.</td>
+						</tr>
+						</tbody>
+					</table>
+				</div>
+
+				<h3>Dependencies</h3>
+				<p>None.</p>
+			</TabPanel>
+
+			<TabPanel header="Source">
+				<a href="https://github.com/primefaces/primevue/tree/master/src/views/multiselect" class="btn-viewsource" target="_blank" rel="noopener noreferrer">
+					<span>View on GitHub</span>
+				</a>
+<CodeHighlight>
+<template v-pre>
+&lt;template&gt;
+	&lt;div&gt;
+		&lt;div class=&quot;content-section introduction&quot;&gt;
+			&lt;div class=&quot;feature-intro&quot;&gt;
+				&lt;h1&gt;MultiSelect&lt;/h1&gt;
+				&lt;p&gt;MultiSelect is used to multiple values from a list of options.&lt;/p&gt;
+			&lt;/div&gt;
+		&lt;/div&gt;
+
+		&lt;div class=&quot;content-section implementation&quot;&gt;
+			&lt;h3 class=&quot;first&quot;&gt;Basic&lt;/h3&gt;
+			&lt;MultiSelect v-model=&quot;selectedCars1&quot; :options=&quot;cars&quot; optionLabel=&quot;brand&quot; placeholder=&quot;Select Brands&quot; /&gt;
+
+			&lt;h3&gt;Advanced with Templating and Filtering&lt;/h3&gt;
+			&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;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;
+						&lt;span&gt;{{option.brand}}&lt;/span&gt;
+					&lt;/div&gt;
+					&lt;div class=&quot;p-multiselect-empty-car-token&quot; v-if=&quot;!slotProps.value || slotProps.value.length === 0&quot;&gt;
+						Select Brands
+					&lt;/div&gt;
+				&lt;/template&gt;
+				&lt;template #option=&quot;slotProps&quot;&gt;
+					&lt;div class=&quot;p-multiselect-car-option&quot;&gt;
+						&lt;img :alt=&quot;slotProps.option.brand&quot; :src=&quot;'/demo/images/car/' + slotProps.option.brand + '.png'&quot; /&gt;
+						&lt;span&gt;{{slotProps.option.brand}}&lt;/span&gt;
+					&lt;/div&gt;
+				&lt;/template&gt;
+			&lt;/MultiSelect&gt;
+		&lt;/div&gt;
+	&lt;/div&gt;
+&lt;/template&gt;
+</template>
+</CodeHighlight>
+
+<CodeHighlight lang="javascript">
+export default {
+	data() {
+		return {
+			selectedCars1: null,
+			selectedCars2: null,
+			cars: [
+				{brand: 'Audi', value: 'Audi'},
+				{brand: 'Bmw', value: 'Bmw'},
+				{brand: 'Fiat', value: 'Fiat'},
+				{brand: 'Honda', value: 'Honda'},
+				{brand: 'Jaguar', value: 'Jaguar'},
+				{brand: 'Mercedes', value: 'Mercedes'},
+				{brand: 'Renault', value: 'Renault'},
+				{brand: 'Volkswagen', value: 'Volkswagen'},
+				{brand: 'Volvo', value: 'Volvo'}
+			]
+		}
+	}
+}
+</CodeHighlight>
+
+<CodeHighlight lang="css">
+.p-multiselect {
+	min-width: 15em;
+}
+
+.p-multiselect-car-option {
+	display: inline-block;
+	vertical-align: middle;
+
+	img {
+		vertical-align: middle;
+		margin-right: .5em;
+		width: 24px;
+	}
+
+	span {
+		margin-top: .125em;
+	}
+}
+
+.p-multiselect-car-token,
+.p-multiselect-empty-car-token {
+	padding: 2px 4px;
+	margin: 0 0.286em 0 0;
+	display: inline-block;
+	vertical-align: middle;
+	height: 1.857em;
+	border-radius: 3px;
+}
+
+.p-multiselect-car-token img {
+	width: 20px;
+	vertical-align: middle;
+	margin-right: .5em
+}
+
+.p-multiselect-car-token {
+	background: #007ad9;
+	color: #ffffff;
+}
+
+.p-multiselect-empty-car-token {
+	background: #d95f00;
+	color: #ffffff;
+}
+</CodeHighlight>
+			</TabPanel>
+		</TabView>
+	</div>
+</template>
\ No newline at end of file