From b63cb74d233cb9948778323de55628200d2fe0e0 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 15:21:45 +0300
Subject: [PATCH] Listbox doc added

---
 src/components/listbox/Listbox.vue |   4 +-
 src/views/listbox/ListboxDemo.vue  |   7 +
 src/views/listbox/ListboxDoc.vue   | 275 +++++++++++++++++++++++++++++
 3 files changed, 284 insertions(+), 2 deletions(-)
 create mode 100644 src/views/listbox/ListboxDoc.vue

diff --git a/src/components/listbox/Listbox.vue b/src/components/listbox/Listbox.vue
index 21784f2ba..7b42c7beb 100644
--- a/src/components/listbox/Listbox.vue
+++ b/src/components/listbox/Listbox.vue
@@ -27,13 +27,13 @@ export default {
     props: {
         value: null,
         options: Array,
+		optionLabel: null,
+		listStyle: null,
         disabled: Boolean,
         dataKey: null,
-        listStyle: null,
         multiple: Boolean,
         metaKeySelection: Boolean,
         filter: Boolean,
-        optionLabel: null,
         optionValue: null,
         optionDisabled: null
     },
diff --git a/src/views/listbox/ListboxDemo.vue b/src/views/listbox/ListboxDemo.vue
index b917b11df..4f209597c 100644
--- a/src/views/listbox/ListboxDemo.vue
+++ b/src/views/listbox/ListboxDemo.vue
@@ -21,10 +21,14 @@
                 </template>
             </Listbox>
         </div>
+
+        <ListboxDoc/>
     </div>
 </template>
 
 <script>
+import ListboxDoc from './ListboxDoc';
+
 export default {
     data() {
         return {
@@ -49,6 +53,9 @@ export default {
                 {brand: 'Volvo', value: 'Volvo'}
             ]
         }
+    },
+    components: {
+        'ListboxDoc': ListboxDoc
     }
 }
 </script>
\ No newline at end of file
diff --git a/src/views/listbox/ListboxDoc.vue b/src/views/listbox/ListboxDoc.vue
new file mode 100644
index 000000000..f8b542cce
--- /dev/null
+++ b/src/views/listbox/ListboxDoc.vue
@@ -0,0 +1,275 @@
+<template>
+	<div class="content-section documentation">
+		<TabView>
+			<TabPanel header="Documentation">
+				<h3>Import</h3>
+<CodeHighlight lang="javascript">
+import Listbox from 'primevue/listbox';
+</CodeHighlight>
+
+				<h3>Getting Started</h3>
+				<p>Listbox 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;Listbox v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; /&gt;
+</CodeHighlight>
+<CodeHighlight lang="js">
+data() {
+	return {
+		selectedCity: null,
+		cities: [
+			{name: 'New York', code: 'NY'},
+			{name: 'Rome', code: 'RM'},
+			{name: 'London', code: 'LDN'},
+			{name: 'Istanbul', code: 'IST'},
+			{name: 'Paris', code: 'PRS'}
+		]
+	}
+}
+</CodeHighlight>
+
+				<h3>Selection</h3>
+				<p>Listbox allows selection of either single or multiple items. In single case, model should be a single object reference whereas in multiple case should be an array. Multiple items can either be selected
+					using metaKey or toggled individually depending on the value of <i>metaKeySelection</i> property value which is true by default. On touch enabled
+					devices metaKeySelection is turned off automatically.</p>
+<CodeHighlight>
+&lt;Listbox v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; :multiple=&quot;true&quot;/&gt;
+</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>
+<CodeHighlight>
+<template v-pre>
+&lt;Listbox v-model=&quot;selectedCars&quot; :options=&quot;cars&quot; :multiple=&quot;true&quot; :filter=&quot;true&quot; optionLabel=&quot;brand&quot; listStyle=&quot;max-height:250px&quot; style=&quot;width:15em&quot;&gt;
+	&lt;template #option=&quot;slotProps&quot;&gt;
+		&lt;div class=&quot;p-clearfix&quot;&gt;
+			&lt;img :alt=&quot;slotProps.option.brand&quot; :src=&quot;'/demo/images/car/' + slotProps.option.brand + '.png'&quot; style=&quot;display:inline-block;margin:5px 0 0 5px;width:48px&quot; /&gt;
+			&lt;span style=&quot;float:right;margin:1.25em .5em 0 0&quot;&gt;{{slotProps.option.brand}}&lt;/span&gt;
+		&lt;/div&gt;
+	&lt;/template&gt;
+&lt;/Listbox&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 <i>filter</i> property.</p>
+<CodeHighlight>
+&lt;Listbox v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; :filter=&quot;true&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>object</td>
+							<td>null</td>
+							<td>Selected value to display.</td>
+						</tr>
+						<tr>
+							<td>options</td>
+							<td>array</td>
+							<td>null</td>
+							<td>An array of objects 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>listStyle</td>
+							<td>string</td>
+							<td>null</td>
+							<td>Inline style of inner list element.</td>
+						</tr>
+						<tr>
+							<td>disabled</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When specified, disables the component.</td>
+						</tr>
+						<tr>
+							<td>dataKey</td>
+							<td>string</td>
+							<td>false</td>
+							<td>A property to uniquely match the value in options for better performance.</td>
+						</tr>
+						<tr>
+							<td>multiple</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When specified, allows selecting multiple values.</td>
+						</tr>
+						<tr>
+							<td>metaKeySelection</td>
+							<td>boolean</td>
+							<td>true</td>
+							<td>Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item
+								can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.</td>
+						</tr>
+						<tr>
+							<td>filter</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When specified, displays a filter input at header.</td>
+						</tr>
+						<tr>
+							<td>optionValue</td>
+							<td>???</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: Single value or an array of values depending on the selection mode <br/>
+							</td>
+							<td>Callback to invoke when value of listbox changes.</td>
+						</tr>
+						<tr>
+							<td>input</td>
+							<td>event: Single value or an array of values depending on the selection mode <br/>
+							</td>
+							<td>Callback to invoke when value of listbox 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-listbox</td>
+							<td>Main container element.</td>
+						</tr>
+						<tr>
+							<td>p-listbox-header</td>
+							<td>Header element.</td>
+						</tr>
+						<tr>
+							<td>p-listbox-list-wrapper</td>
+							<td>Container of list element.</td>
+						</tr>
+						<tr>
+							<td>p-listbox-list</td>
+							<td>List element.</td>
+						</tr>
+						<tr>
+							<td>p-listbox-item</td>
+							<td>An item in the list element.</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/listbox" 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;Listbox&lt;/h1&gt;
+				&lt;p&gt;Listbox is used to select one or more values from a list of items.&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;Single&lt;/h3&gt;
+			&lt;Listbox v-model=&quot;selectedCity&quot; :options=&quot;cities&quot; optionLabel=&quot;name&quot; /&gt;
+
+			&lt;h3&gt;Advanced with Templating, Filtering and Multiple Selection&lt;/h3&gt;
+			&lt;Listbox v-model=&quot;selectedCars&quot; :options=&quot;cars&quot; :multiple=&quot;true&quot; :filter=&quot;true&quot; optionLabel=&quot;brand&quot; listStyle=&quot;max-height:250px&quot; style=&quot;width:15em&quot;&gt;
+				&lt;template #option=&quot;slotProps&quot;&gt;
+					&lt;div class=&quot;p-clearfix&quot;&gt;
+						&lt;img :alt=&quot;slotProps.option.brand&quot; :src=&quot;'/demo/images/car/' + slotProps.option.brand + '.png'&quot; style=&quot;display:inline-block;margin:5px 0 0 5px;width:48px&quot; /&gt;
+						&lt;span style=&quot;float:right;margin:1.25em .5em 0 0&quot;&gt;{{slotProps.option.brand}}&lt;/span&gt;
+					&lt;/div&gt;
+				&lt;/template&gt;
+			&lt;/Listbox&gt;
+		&lt;/div&gt;
+	&lt;/div&gt;
+&lt;/template&gt;
+</template>
+</CodeHighlight>
+
+<CodeHighlight lang="javascript">
+export default {
+	data() {
+		return {
+			selectedCity: null,
+			selectedCars: null,
+			cities: [
+				{name: 'New York', code: 'NY'},
+				{name: 'Rome', code: 'RM'},
+				{name: 'London', code: 'LDN'},
+				{name: 'Istanbul', code: 'IST'},
+				{name: 'Paris', code: 'PRS'}
+			],
+			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>
+			</TabPanel>
+		</TabView>
+	</div>
+</template>
\ No newline at end of file