docs: added change event for switch element (#2439)

anujsingla · anujsi · bennypowers · web-flow · commit ed747e98ed24 · 2023-03-25T17:38:17.000Z
* docs: added change event for switch element

* docs: Update .changeset/pf-switch-2372.md

---------

Co-authored-by: Anuj Singla &lt;asingla@redhat.com&gt;
Co-authored-by: Benny Powers &lt;bennypowers@users.noreply.github.com&gt;
diff --git a/.changeset/pf-switch-2372.md b/.changeset/pf-switch-2372.md
@@ -0,0 +1,5 @@
+---
+"@patternfly/elements": patch
+---
+
+`<pf-switch>`: documented the `change` event
diff --git a/elements/pf-switch/pf-switch.ts b/elements/pf-switch/pf-switch.ts
@@ -8,6 +8,8 @@ import styles from './pf-switch.css';
  * checkboxes can often be used interchangeably, but the switch provides a more
  * explicit, visible representation on a setting.
  *
+ * @fires {Event} change - Fires when the switch selection changes.
+ *
  * @cssprop --pf-c-switch--FontSize {@default `1rem`}
  * @cssprop {<length>} --pf-c-switch--ColumnGap {@default `1rem`}
  * @cssprop --pf-c-switch__toggle-icon--FontSize {@default `calc(1rem * .625)`}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@patternfly/elements": patch
 +---
++
 +`<pf-switch>`: documented the `change` event
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ import styles from './pf-switch.css';`
`8`	`8`	`* checkboxes can often be used interchangeably, but the switch provides a more`
`9`	`9`	`* explicit, visible representation on a setting.`
`10`	`10`	`*`
	`11`	`+ * @fires {Event} change - Fires when the switch selection changes.`
	`12`	`+ *`
`11`	`13`	* @cssprop --pf-c-switch--FontSize {@default `1rem`}
`12`	`14`	* @cssprop {<length>} --pf-c-switch--ColumnGap {@default `1rem`}
`13`	`15`	* @cssprop --pf-c-switch__toggle-icon--FontSize {@default `calc(1rem * .625)`}