Prune events (#8)

* feat: remove mouse, keydown events from Toggle * chore: formatting * chore: update docs
metonym · Dec 5, 2020 · 068e39b · 068e39b
1 parent fc2755c
commit 068e39b
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -138,12 +138,8 @@ The `Toggle` component dispatches a "toggle" event.
 ## Forwarded events
 
 - on:click
-- on:mouseover
-- on:mouseenter
-- on:mouseout
 - on:focus
 - on:blur
-- on:keydown
 
 ## TypeScript
 

diff --git a/src/Toggle.svelte b/src/Toggle.svelte
@@ -134,12 +134,8 @@
       {disabled}
       on:click
       on:click={() => (toggled = !toggled)}
-      on:mouseover
-      on:mouseenter
-      on:mouseout
       on:focus
-      on:blur
-      on:keydown />
+      on:blur />
     <slot {toggled}>
       {#if on && off}<span>{toggled ? on : off}</span>{/if}
     </slot>

diff --git a/test.svelte b/test.svelte
@@ -10,7 +10,16 @@
   on="On"
   off="Off"
   on:toggle={(e) => {
-    console.log(e.detail);
+    console.log(e.detail); // boolean
+  }}
+  on:click={(e) => {
+    console.log(e); // MouseEvent
+  }}
+  on:focus={(e) => {
+    console.log(e); // FocusEvent
+  }}
+  on:blur={(e) => {
+    console.log(e); // FocusEvent
   }} />
 
 <Toggle let:toggled={isToggled}>

diff --git a/types/Toggle.d.ts b/types/Toggle.d.ts
@@ -59,12 +59,8 @@ export default class Toggle extends SvelteComponentTyped<
   {
     toggle: CustomEvent<boolean>;
     click: WindowEventMap["click"];
-    mouseover: WindowEventMap["mouseover"];
-    mouseenter: WindowEventMap["mouseenter"];
-    mouseout: WindowEventMap["mouseout"];
     focus: WindowEventMap["focus"];
     blur: WindowEventMap["blur"];
-    keydown: WindowEventMap["keydown"];
   },
   { default: { toggled: boolean } }
 > {}