@uibit/scratch-reveal 0.1.1 → 0.2.0

package/dist/frameworks/angular/index.ts

@@ -1,34 +1,37 @@
 import { Component, ChangeDetectionStrategy, ElementRef, input, effect, output, numberAttribute } from '@angular/core';
 import '@uibit/scratch-reveal';
 import type { ScratchReveal as HTMLElementClass } from '@uibit/scratch-reveal';
-
 @Component({
-  selector: 'uibit-scratch-reveal',
-  template: '<ng-content></ng-content>',
-  changeDetection: ChangeDetectionStrategy.OnPush,
-  standalone: true,
-  host: {
-    '(scratch-progress)': 'scratchProgress.emit($event)',
-    '(scratch-reveal)': 'scratchReveal.emit($event)'
-  }
+    selector: 'uibit-scratch-reveal',
+    template: '<ng-content></ng-content>',
+    changeDetection: ChangeDetectionStrategy.OnPush,
+    standalone: true,
+    host: {
+        '(scratch-progress)': 'scratchProgress.emit($event)',
+        '(scratch-reveal)': 'scratchReveal.emit($event)'
+    }
 })
 export class NgxScratchReveal {
-  constructor(private el: ElementRef<HTMLElementClass>) {
-    effect(() => {
-      if (this.el.nativeElement) {
-        this.el.nativeElement.revealThreshold = this.revealThreshold();
-      }
+    constructor(private el: ElementRef<HTMLElementClass>){
+        effect(()=>{
+            if (this.el.nativeElement) {
+                this.el.nativeElement.revealThreshold = this.revealThreshold();
+            }
+        });
+        effect(()=>{
+            if (this.el.nativeElement) {
+                this.el.nativeElement.locale = this.locale();
+            }
+        });
+    }
+    readonly revealThreshold = input<number, any>(50, {
+        transform: numberAttribute
     });
-    effect(() => {
-      if (this.el.nativeElement) {
-        this.el.nativeElement.locale = this.locale();
-      }
-    });
-  }
-
-  readonly revealThreshold = input<number, any>(50, { transform: numberAttribute });
-  readonly locale = input<string, any>('');
-
-  readonly scratchProgress = output<CustomEvent<{ percentage: number }>>();
-  readonly scratchReveal = output<CustomEvent<{ percentage: number }>>();
+    readonly locale = input<string>('');
+    readonly scratchProgress = output<CustomEvent<{
+        percentage: number;
+    }>>();
+    readonly scratchReveal = output<CustomEvent<{
+        percentage: number;
+    }>>();
 }

package/dist/frameworks/astro/index.d.ts

@@ -4,7 +4,12 @@ import '@uibit/scratch-reveal';
 declare global {
   namespace astroHTML.JSX {
     interface IntrinsicElements {
-      'uibit-scratch-reveal': Partial<HTMLElementClass> & astroHTML.JSX.HTMLAttributes;
+      'uibit-scratch-reveal': Partial<HTMLElementClass> & astroHTML.JSX.HTMLAttributes & {
+      revealThreshold?: number;
+      locale?: string;
+      "on:scratch-progress"?: (event: CustomEvent<{ percentage: number }>) => void;
+      "on:scratch-reveal"?: (event: CustomEvent<{ percentage: number }>) => void;
+      };
     }
   }
 }

package/dist/frameworks/preact/index.d.ts

@@ -8,6 +8,10 @@ declare module 'preact' {
       'uibit-scratch-reveal': JSX.HTMLAttributes<HTMLElementClass> & {
       revealThreshold?: number;
       locale?: string;
+      onScratchProgress?: (event: CustomEvent<{ percentage: number }>) => void;
+      "on:scratch-progress"?: (event: CustomEvent<{ percentage: number }>) => void;
+      onScratchReveal?: (event: CustomEvent<{ percentage: number }>) => void;
+      "on:scratch-reveal"?: (event: CustomEvent<{ percentage: number }>) => void;
       };
     }
   }

package/dist/frameworks/react/index.ts

@@ -0,0 +1,101 @@
+import React, { useRef, useEffect, useLayoutEffect, useImperativeHandle } from 'react';
+import type { ScratchReveal as HTMLElementClass } from '@uibit/scratch-reveal';
+import '@uibit/scratch-reveal';
+const useTypeOfLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect;
+export interface ScratchRevealProps extends Omit<React.HTMLAttributes<HTMLElementClass>, 'revealThreshold' | 'locale' | 'onScratchProgress' | 'onScratchReveal'> {
+    children?: React.ReactNode;
+    revealThreshold?: number;
+    locale?: string;
+    onScratchProgress?: (event: CustomEvent<{
+        percentage: number;
+    }>) => void;
+    onScratchReveal?: (event: CustomEvent<{
+        percentage: number;
+    }>) => void;
+}
+export const ScratchReveal = ({ ref, children, ...props }: ScratchRevealProps & {
+    ref?: React.Ref<HTMLElementClass>;
+})=>{
+    const innerRef = useRef<HTMLElementClass>(null);
+    const propsRef = useRef(props);
+    propsRef.current = props;
+    useImperativeHandle(ref, ()=>innerRef.current!);
+    useTypeOfLayoutEffect(()=>{
+        const element = innerRef.current;
+        if (element && props.revealThreshold !== undefined) {
+            (element as any).revealThreshold = props.revealThreshold;
+        }
+    }, [
+        props.revealThreshold
+    ]);
+    useTypeOfLayoutEffect(()=>{
+        const element = innerRef.current;
+        if (element && props.locale !== undefined) {
+            (element as any).locale = props.locale;
+        }
+    }, [
+        props.locale
+    ]);
+    useTypeOfLayoutEffect(()=>{
+        const element = innerRef.current;
+        if (!element) return;
+        const handleEvent = (event: Event)=>{
+            if (propsRef.current.onScratchProgress) {
+                propsRef.current.onScratchProgress(event as any);
+            }
+        };
+        element.addEventListener('scratch-progress', handleEvent);
+        return ()=>{
+            element.removeEventListener('scratch-progress', handleEvent);
+        };
+    }, []);
+    useTypeOfLayoutEffect(()=>{
+        const element = innerRef.current;
+        if (!element) return;
+        const handleEvent = (event: Event)=>{
+            if (propsRef.current.onScratchReveal) {
+                propsRef.current.onScratchReveal(event as any);
+            }
+        };
+        element.addEventListener('scratch-reveal', handleEvent);
+        return ()=>{
+            element.removeEventListener('scratch-reveal', handleEvent);
+        };
+    }, []);
+    const domProps = {
+        ...props
+    };
+    const customPropNames = [
+        'revealThreshold',
+        'locale',
+        'onScratchProgress',
+        'onScratchReveal'
+    ];
+    for (const key of customPropNames){
+        delete (domProps as any)[key];
+    }
+    return React.createElement('uibit-scratch-reveal', {
+        ref: innerRef,
+        ...domProps
+    }, children);
+};
+declare global {
+    namespace React {
+        namespace JSX {
+            interface IntrinsicElements {
+                'uibit-scratch-reveal': React.ClassAttributes<HTMLElementClass> & React.HTMLAttributes<HTMLElementClass> & {
+                    children?: React.ReactNode;
+                    class?: string;
+                    revealThreshold?: number;
+                    locale?: string;
+                    onScratchProgress?: (event: CustomEvent<{
+                        percentage: number;
+                    }>) => void;
+                    onScratchReveal?: (event: CustomEvent<{
+                        percentage: number;
+                    }>) => void;
+                };
+            }
+        }
+    }
+}

package/dist/frameworks/solid/index.d.ts

@@ -8,8 +8,8 @@ declare module 'solid-js' {
       'uibit-scratch-reveal': Partial<HTMLElementClass> & JSX.HTMLAttributes<HTMLElementClass> & {
               revealThreshold?: number;
       locale?: string;
-      "on:scratch-progress"?: (event: CustomEvent) => void;
-      "on:scratch-reveal"?: (event: CustomEvent) => void;
+      "on:scratch-progress"?: (event: CustomEvent<{ percentage: number }>) => void;
+      "on:scratch-reveal"?: (event: CustomEvent<{ percentage: number }>) => void;
       };
     }
   }

package/dist/frameworks/stencil/index.d.ts

@@ -7,6 +7,10 @@ declare module '@stencil/core' {
       'uibit-scratch-reveal': HTMLElementClass & {
     revealThreshold?: number;
     locale?: string;
+    onScratchProgress?: (event: CustomEvent<{ percentage: number }>) => void;
+    "on:scratch-progress"?: (event: CustomEvent<{ percentage: number }>) => void;
+    onScratchReveal?: (event: CustomEvent<{ percentage: number }>) => void;
+    "on:scratch-reveal"?: (event: CustomEvent<{ percentage: number }>) => void;
       };
     }
   }

package/dist/frameworks/svelte/index.svelte

@@ -1,32 +1,58 @@
 <script lang="ts">
   import '@uibit/scratch-reveal';
   import type { ScratchReveal as HTMLElementClass } from '@uibit/scratch-reveal';
-  
-  let {
-    revealThreshold = undefined,
-      locale = undefined,
-      children
+
+let {
+    revealThreshold = $bindable(),
+    locale = $bindable(),
+    children,
+    ...restProps
   } = $props<{
-    children?: any;
+    children?: import('svelte').Snippet;
     revealThreshold?: number;
     locale?: string;
-  
+
+    [key: string]: any;
   }>();
-  
-  let elementRef: HTMLElementClass | null = $state(null);
-  
-  $effect(() => {
-    if (elementRef && revealThreshold !== undefined) {
+
+let elementRef: HTMLElementClass | null = $state(null);
+
+$effect(() => {
+    if (elementRef && revealThreshold !== undefined && elementRef.revealThreshold !== revealThreshold) {
       elementRef.revealThreshold = revealThreshold;
     }
-    if (elementRef && locale !== undefined) {
+    if (elementRef && locale !== undefined && elementRef.locale !== locale) {
       elementRef.locale = locale;
     }
   });
-  
+
+$effect(() => {
+    const element = elementRef;
+    if (!element) return;
+
+    const handleEvent = () => {
+      if (revealThreshold !== element.revealThreshold) {
+        revealThreshold = element.revealThreshold as any;
+      }
+      if (locale !== element.locale) {
+        locale = element.locale as any;
+      }
+    };
+
+    const events = ['change', 'input', 'scratch-progress', 'scratch-reveal'];
+    for (const event of events) {
+      element.addEventListener(event, handleEvent);
+    }
+    return () => {
+      for (const event of events) {
+        element.removeEventListener(event, handleEvent);
+      }
+    };
+  });
+
 </script>
 
-<uibit-scratch-reveal bind:this={elementRef} {...$$restProps}>
+<uibit-scratch-reveal bind:this={elementRef} {...restProps}>
 
   {#if children}
     {@render children()}

package/dist/frameworks/vue/index.ts

@@ -1,28 +1,73 @@
-import { defineComponent, h } from 'vue';
+import { defineComponent, h, ref, watch } from 'vue';
 import type { ScratchReveal as HTMLElementClass } from '@uibit/scratch-reveal';
 import '@uibit/scratch-reveal';
-
 export const ScratchReveal = defineComponent({
-  name: 'ScratchReveal',
-  props: {
-    revealThreshold: { type: [String, Number, Boolean, Array, Object] as any },
-    locale: { type: [String, Number, Boolean, Array, Object] as any }
-  },
-  emits: ['scratch-progress', 'scratch-reveal'],
-  setup(props, { slots, emit }) {
-    return () => {
-      const eventListeners: Record<string, any> = {};
-      eventListeners['onScratch-progress'] = (event: Event) => {
-        emit('scratch-progress', event);
-      };
-      eventListeners['onScratch-reveal'] = (event: Event) => {
-        emit('scratch-reveal', event);
-      };
-
-      return h('uibit-scratch-reveal', {
-        ...props,
-        ...eventListeners
-      }, slots.default?.());
-    };
-  }
+    name: 'ScratchReveal',
+    props: {
+        revealThreshold: {
+            type: [
+                String,
+                Number,
+                Boolean,
+                Array,
+                Object
+            ] as any
+        },
+        locale: {
+            type: [
+                String,
+                Number,
+                Boolean,
+                Array,
+                Object
+            ] as any
+        }
+    },
+    emits: [
+        'scratch-progress',
+        'scratch-reveal'
+    ],
+    setup (props, { slots, emit }) {
+        const elementRef = ref<HTMLElementClass | null>(null);
+        if (false) {
+            watch(()=>props.modelValue, (newVal)=>{
+                if (elementRef.value && newVal !== undefined && elementRef.value.value !== newVal) {
+                    elementRef.value.value = newVal;
+                }
+            });
+            watch(()=>props.value, (newVal)=>{
+                if (elementRef.value && newVal !== undefined && elementRef.value.value !== newVal) {
+                    elementRef.value.value = newVal;
+                }
+            });
+        }
+        watch(()=>props.revealThreshold, (newVal)=>{
+            if (elementRef.value && newVal !== undefined) {
+                (elementRef.value as any).revealThreshold = newVal;
+            }
+        });
+        watch(()=>props.locale, (newVal)=>{
+            if (elementRef.value && newVal !== undefined) {
+                (elementRef.value as any).locale = newVal;
+            }
+        });
+        return ()=>{
+            const eventListeners: Record<string, any> = {};
+            eventListeners['onScratch-progress'] = (event: Event)=>{
+                emit('scratch-progress', event);
+            };
+            eventListeners['onScratch-reveal'] = (event: Event)=>{
+                emit('scratch-reveal', event);
+            };
+            const mergedProps = {
+                ...props,
+                ...eventListeners,
+                ref: elementRef
+            };
+            if (false && props.modelValue !== undefined) {
+                (mergedProps as any).value = props.modelValue;
+            }
+            return h('uibit-scratch-reveal', mergedProps, slots.default?.());
+        };
+    }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uibit/scratch-reveal",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A gamified, accessible scratch-off panel component that reveals hidden content. Users can scratch off the overlay canvas layer by dragging or touching.",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,7 +12,7 @@
     },
     "./scratch-reveal.css": "./dist/scratch-reveal.css",
     "./custom-elements.json": "./custom-elements.json",
-    "./react": "./dist/frameworks/react/index.d.ts",
+    "./react": "./dist/frameworks/react/index.ts",
     "./vue": "./dist/frameworks/vue/index.ts",
     "./svelte": "./dist/frameworks/svelte/index.svelte",
     "./angular": "./dist/frameworks/angular/index.ts",
@@ -54,7 +54,7 @@
     "@types/node": "^20.19.43",
     "lit": "^3.3.3",
     "typescript": "7.0.2",
-    "@uibit/codegen": "0.1.0"
+    "@uibit/codegen": "0.2.0"
   },
   "peerDependencies": {
     "lit": "^3.0.0",

package/dist/frameworks/react/index.d.ts

@@ -1,20 +0,0 @@
-import type { HTMLAttributes, ClassAttributes } from 'react';
-import type { ScratchReveal as HTMLElementClass } from '@uibit/scratch-reveal';
-import '@uibit/scratch-reveal';
-
-declare global {
-  namespace React {
-    namespace JSX {
-      interface IntrinsicElements {
-        'uibit-scratch-reveal': ClassAttributes<HTMLElementClass> & HTMLAttributes<HTMLElementClass> & {
-          children?: React.ReactNode;
-          class?: string;
-      revealThreshold?: number;
-      locale?: string;
-      onScratchProgress?: (event: any) => void;
-      onScratchReveal?: (event: any) => void;
-        };
-      }
-    }
-  }
-}