From a1265c7b9b0be9d14e4455a4ebadbe75d805f769 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Merve=20=C3=96z=C3=A7if=C3=A7i?= <merveozcifci7@gmail.com>
Date: Fri, 22 Mar 2019 11:09:04 +0300
Subject: [PATCH] Checkbox doc added

---
 src/components/checkbox/Checkbox.vue |   4 +-
 src/views/checkbox/CheckboxDemo.vue  |  17 +-
 src/views/checkbox/CheckboxDoc.vue   | 258 +++++++++++++++++++++++++++
 3 files changed, 272 insertions(+), 7 deletions(-)
 create mode 100644 src/views/checkbox/CheckboxDoc.vue

diff --git a/src/components/checkbox/Checkbox.vue b/src/components/checkbox/Checkbox.vue
index a813d38d9..d4aa9fc7b 100644
--- a/src/components/checkbox/Checkbox.vue
+++ b/src/components/checkbox/Checkbox.vue
@@ -1,7 +1,7 @@
 <template>
    <div class="p-checkbox p-component" @click="onClick($event)">
        <div class="p-hidden-accessible">
-           <input ref="input" :id="inputId" type="checkbox" :name="name" :checked="checked" :disabled="disabled" @focus="onFocus()" @blur="onBlur()"
+           <input ref="input" :id="inputId" type="checkbox" :name="name" :checked="checked" :disabled="disabled" @focus="onFocus($event)" @blur="onBlur($event)"
                     :autocomplete="autocomplete" :autofocus="autofocus">
         </div>
         <div ref="box" :class="['p-checkbox-box p-component', {'p-highlight': checked, 'p-disabled': disabled, 'p-focus': focused}]">
@@ -57,7 +57,7 @@ export default {
             this.focused = true;
             this.$emit('focus', event);
         },
-        onBlur() {
+        onBlur(event) {
             this.focused = false;
             this.$emit('blur', event);
         }
diff --git a/src/views/checkbox/CheckboxDemo.vue b/src/views/checkbox/CheckboxDemo.vue
index f0519ff2b..7bfdb36d8 100644
--- a/src/views/checkbox/CheckboxDemo.vue
+++ b/src/views/checkbox/CheckboxDemo.vue
@@ -9,25 +9,25 @@
 
         <div class="content-section implementation">
             <h3 class="first">Basic</h3>
-            <Checkbox inputId="binary" v-model="checked" />
+            <Checkbox id="binary" inputId="binary" v-model="checked"/>
             <label for="binary" class="p-checkbox-label" style="font-weight: bold">{{checked}}</label>
 
             <h3>Multiple</h3>
             <div class="p-grid">
                 <div class="p-col-12">
-                    <Checkbox inputId="city1" name="city" value="Chicago" v-model="cities" />
+                    <Checkbox id="city1" inputId="city1" name="city" value="Chicago" v-model="cities" />
                     <label for="city1" class="p-checkbox-label">Chicago</label>
                 </div>
                 <div class="p-col-12">
-                    <Checkbox inputId="city2" name="city" value="Los Angeles" v-model="cities" />
+                    <Checkbox id="city2" inputId="city2" name="city" value="Los Angeles" v-model="cities" />
                     <label for="city2" class="p-checkbox-label">Los Angeles</label>
                 </div>
                 <div class="p-col-12">
-                    <Checkbox inputId="city3" name="city" value="New York" v-model="cities" />
+                    <Checkbox id="city3" inputId="city3" name="city" value="New York" v-model="cities" />
                     <label for="city3" class="p-checkbox-label">New York</label>
                 </div>
                 <div class="p-col-12">
-                    <Checkbox inputId="city4" name="city" value="San Francisco" v-model="cities" />
+                    <Checkbox id="city4" inputId="city4" name="city" value="San Francisco" v-model="cities" />
                     <label for="city4" class="p-checkbox-label">San Francisco</label>
                 </div>
             </div>
@@ -42,10 +42,14 @@
             </div>
             <p>Selected Themes: <span style="font-weight: bold">{{this.selectedThemes}}</span></p>
         </div>
+
+        <CheckboxDoc/>
     </div>
 </template>
 
 <script>
+import CheckboxDoc from './CheckboxDoc';
+
 export default {
     data() {
         return {
@@ -57,6 +61,9 @@ export default {
     },
     created() {
         this.selectedThemes = this.themes.slice(1,3);
+    },
+    components: {
+        'CheckboxDoc': CheckboxDoc
     }
 }
 </script>
diff --git a/src/views/checkbox/CheckboxDoc.vue b/src/views/checkbox/CheckboxDoc.vue
new file mode 100644
index 000000000..632c4e743
--- /dev/null
+++ b/src/views/checkbox/CheckboxDoc.vue
@@ -0,0 +1,258 @@
+<template>
+	<div class="content-section documentation">
+		<TabView>
+			<TabPanel header="Documentation">
+				<h3>Import</h3>
+<CodeHighlight lang="javascript">
+import Checkbox from 'primevue/checkbox';
+</CodeHighlight>
+
+				<h3>Getting Started</h3>
+				<p>Checkbox can either be used in multiple selection with other checkboxes or as a single checkbox to provide a boolean value.</p>
+<CodeHighlight>
+&lt;Checkbox id=&quot;binary&quot; inputId=&quot;binary&quot; v-model=&quot;checked&quot; /&gt;
+</CodeHighlight>
+
+				<h3>Multiple Values</h3>
+				<p>Multiple mode is enabled by default, v-model property refers to an array to bind the selected values.</p>
+<CodeHighlight>
+&lt;Checkbox id=&quot;city1&quot; inputId=&quot;city1&quot; name=&quot;city&quot; value=&quot;Chicago&quot; v-model=&quot;cities&quot; /&gt;
+&lt;Checkbox id=&quot;city2&quot; inputId=&quot;city2&quot; name=&quot;city&quot; value=&quot;Los Angeles&quot; v-model=&quot;cities&quot; /&gt;
+&lt;Checkbox id=&quot;city3&quot; inputId=&quot;city3&quot; name=&quot;city&quot; value=&quot;New York&quot; v-model=&quot;cities&quot; /&gt;
+&lt;Checkbox id=&quot;city4&quot; inputId=&quot;city4&quot; name=&quot;city&quot; value=&quot;San Francisco&quot; v-model=&quot;cities&quot; /&gt;
+</CodeHighlight>
+
+<CodeHighlight lang="js">
+export default {
+	data() {
+		return {
+			cities: []
+		}
+	}
+}
+</CodeHighlight>
+
+
+				<p>As v-model is two-way binding enabled, prepopulating the model array with values is enough to display the related
+					checkboxes as checked by default.</p>
+<CodeHighlight lang="js">
+export default {
+	data() {
+		return {
+			themes: [{name: 'Apollo', key: 'A'}, {name: 'Babylon', key: 'B'}, {name: 'Serenity', key: 'S'}, {name: 'Ultima', key: 'U'}],
+			selectedThemes: []
+		}
+	},
+	created() {
+		this.selectedThemes = this.themes.slice(1,3);
+	}
+}
+</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>inputId</td>
+							<td>string</td>
+							<td>null</td>
+							<td>Unique identifier of the inner native checkbox.</td>
+						</tr>
+						<tr>
+							<td>value</td>
+							<td>any</td>
+							<td>null</td>
+							<td>Value of the checkbox.</td>
+						</tr>
+						<tr>
+							<td>name</td>
+							<td>string</td>
+							<td>null</td>
+							<td>Name of the checkbox element .</td>
+						</tr>
+						<tr>
+							<td>disabled</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When present, it specifies that the element value cannot be altered.</td>
+						</tr>
+						<tr>
+							<td>modelValue</td>
+							<td>any</td>
+							<td>null</td>
+							<td>Value of the checkbox.</td>
+						</tr>
+						<tr>
+							<td>autocomplete</td>
+							<td>string</td>
+							<td>null</td>
+							<td>When specifies, whether or not an the element should have autocomplete enabled.</td>
+						</tr>
+						<tr>
+							<td>autofocus</td>
+							<td>boolean</td>
+							<td>false</td>
+							<td>When present, it specifies that the element should automatically get focus when the page loads.</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: Browser event</td>
+							<td>Callback to invoke on value change.</td>
+						</tr>
+						<tr>
+							<td>input</td>
+							<td>event: Value of checkbox</td>
+							<td>Callback to invoke on click.</td>
+						</tr>
+						<tr>
+							<td>click</td>
+							<td>event: Browser event</td>
+							<td>Callback to invoke click.</td>
+						</tr>
+						<tr>
+							<td>focus</td>
+							<td>event: Browser event</td>
+							<td>Callback to invoke on focus.</td>
+						</tr>
+						<tr>
+							<td>blur</td>
+							<td>event: Browser event</td>
+							<td>Callback to invoke on blur.</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-chkbox</td>
+							<td>Container element</td>
+						</tr>
+						<tr>
+							<td>p-chkbox-box</td>
+							<td>Container of icon.</td>
+						</tr>
+						<tr>
+							<td>p-chkbox-icon</td>
+							<td>Icon element.</td>
+						</tr>
+						<tr>
+							<td>p-chkbox-label</td>
+							<td>Label 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/inputtext" 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;Checkbox&lt;/h1&gt;
+				&lt;p&gt;Checkbox is an extension to standard checkbox element with theming.&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;Checkbox id=&quot;binary&quot; inputId=&quot;binary&quot; v-model=&quot;checked&quot;/&gt;
+			&lt;label for=&quot;binary&quot; class=&quot;p-checkbox-label&quot; style=&quot;font-weight: bold&quot;&gt;{{checked}}&lt;/label&gt;
+
+			&lt;h3&gt;Multiple&lt;/h3&gt;
+			&lt;div class=&quot;p-grid&quot;&gt;
+				&lt;div class=&quot;p-col-12&quot;&gt;
+					&lt;Checkbox id=&quot;city1&quot; inputId=&quot;city1&quot; name=&quot;city&quot; value=&quot;Chicago&quot; v-model=&quot;cities&quot; /&gt;
+					&lt;label for=&quot;city1&quot; class=&quot;p-checkbox-label&quot;&gt;Chicago&lt;/label&gt;
+				&lt;/div&gt;
+				&lt;div class=&quot;p-col-12&quot;&gt;
+					&lt;Checkbox id=&quot;city2&quot; inputId=&quot;city2&quot; name=&quot;city&quot; value=&quot;Los Angeles&quot; v-model=&quot;cities&quot; /&gt;
+					&lt;label for=&quot;city2&quot; class=&quot;p-checkbox-label&quot;&gt;Los Angeles&lt;/label&gt;
+				&lt;/div&gt;
+				&lt;div class=&quot;p-col-12&quot;&gt;
+					&lt;Checkbox id=&quot;city3&quot; inputId=&quot;city3&quot; name=&quot;city&quot; value=&quot;New York&quot; v-model=&quot;cities&quot; /&gt;
+					&lt;label for=&quot;city3&quot; class=&quot;p-checkbox-label&quot;&gt;New York&lt;/label&gt;
+				&lt;/div&gt;
+				&lt;div class=&quot;p-col-12&quot;&gt;
+					&lt;Checkbox id=&quot;city4&quot; inputId=&quot;city4&quot; name=&quot;city&quot; value=&quot;San Francisco&quot; v-model=&quot;cities&quot; /&gt;
+					&lt;label for=&quot;city4&quot; class=&quot;p-checkbox-label&quot;&gt;San Francisco&lt;/label&gt;
+				&lt;/div&gt;
+			&lt;/div&gt;
+			&lt;p&gt;Selected Cities : &lt;span style=&quot;font-weight: bold&quot;&gt;{{cities}}&lt;/span&gt;&lt;/p&gt;
+
+			&lt;h3&gt;Dynamic Values, Preselection, Value Binding and Disabled Option&lt;/h3&gt;
+			&lt;div class=&quot;p-grid&quot;&gt;
+				&lt;div v-for=&quot;theme of themes&quot; :key=&quot;theme.key&quot; class=&quot;p-col-12&quot;&gt;
+					&lt;Checkbox :inputId=&quot;theme.key&quot; name=&quot;theme&quot; :value=&quot;theme&quot; v-model=&quot;selectedThemes&quot; :disabled=&quot;theme.key === 'U'&quot;/&gt;
+					&lt;label :for=&quot;theme.key&quot; class=&quot;p-checkbox-label&quot;&gt;{{theme.name}}&lt;/label&gt;
+				&lt;/div&gt;
+			&lt;/div&gt;
+			&lt;p&gt;Selected Themes: &lt;span style=&quot;font-weight: bold&quot;&gt;{{this.selectedThemes}}&lt;/span&gt;&lt;/p&gt;
+		&lt;/div&gt;
+	&lt;/div&gt;
+&lt;/template&gt;
+</template>
+</CodeHighlight>
+
+<CodeHighlight lang="javascript">
+export default {
+	data() {
+		return {
+			checked: false,
+			cities: [],
+			themes: [{name: 'Apollo', key: 'A'}, {name: 'Babylon', key: 'B'}, {name: 'Serenity', key: 'S'}, {name: 'Ultima', key: 'U'}],
+			selectedThemes: []
+		}
+	},
+	created() {
+		this.selectedThemes = this.themes.slice(1,3);
+	}
+}
+</CodeHighlight>
+			</TabPanel>
+		</TabView>
+	</div>
+</template>
\ No newline at end of file