@idealyst/components 1.2.58 → 1.2.59

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idealyst/components",
-  "version": "1.2.58",
+  "version": "1.2.59",
   "description": "Shared component library for React and React Native",
   "documentation": "https://github.com/IdealystIO/idealyst-framework/tree/main/packages/components#readme",
   "readme": "README.md",
@@ -56,7 +56,7 @@
     "publish:npm": "npm publish"
   },
   "peerDependencies": {
-    "@idealyst/theme": "^1.2.58",
+    "@idealyst/theme": "^1.2.59",
     "@mdi/js": ">=7.0.0",
     "@mdi/react": ">=1.0.0",
     "@react-native-vector-icons/common": ">=12.0.0",
@@ -107,7 +107,7 @@
   },
   "devDependencies": {
     "@idealyst/blur": "^1.2.40",
-    "@idealyst/theme": "^1.2.58",
+    "@idealyst/theme": "^1.2.59",
     "@idealyst/tooling": "^1.2.30",
     "@mdi/react": "^1.6.1",
     "@types/react": "^19.1.0",

package/src/Keyboard/Keyboard.native.ts

@@ -0,0 +1,18 @@
+/**
+ * Native implementation - re-exports the React Native Keyboard module.
+ */
+export { Keyboard } from 'react-native';
+
+// Re-export types for convenience
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  BaseKeyboardEvent,
+  AndroidKeyboardEvent,
+  IOSKeyboardEvent,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './types';

package/src/Keyboard/Keyboard.web.ts

@@ -0,0 +1,80 @@
+import type {
+  KeyboardStatic,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardEvent,
+  KeyboardMetrics,
+} from './types';
+
+/**
+ * Web implementation of the Keyboard API.
+ * This is a noop implementation since web doesn't have a virtual keyboard API
+ * in the same way as React Native.
+ *
+ * All methods are safe to call but have no effect on web.
+ */
+export const Keyboard: KeyboardStatic = {
+  /**
+   * Noop on web - there's no virtual keyboard to dismiss.
+   * On web, you can blur the active element instead: document.activeElement?.blur()
+   */
+  dismiss(): void {
+    // Noop on web
+    // Optionally blur the active element to simulate keyboard dismiss
+    if (typeof document !== 'undefined' && document.activeElement) {
+      (document.activeElement as HTMLElement).blur?.();
+    }
+  },
+
+  /**
+   * Noop on web - returns a subscription that does nothing.
+   * The VirtualKeyboard API exists in some browsers but has limited support.
+   */
+  addListener(
+    _eventType: KeyboardEventName,
+    _listener: KeyboardEventListener
+  ): KeyboardSubscription {
+    // Return a noop subscription
+    return {
+      remove: () => {
+        // Noop
+      },
+    };
+  },
+
+  /**
+   * Noop on web - no keyboard animations to sync with.
+   */
+  scheduleLayoutAnimation(_event: KeyboardEvent): void {
+    // Noop on web
+  },
+
+  /**
+   * Always returns false on web - no virtual keyboard visibility tracking.
+   */
+  isVisible(): boolean {
+    return false;
+  },
+
+  /**
+   * Always returns undefined on web - no keyboard metrics available.
+   */
+  metrics(): KeyboardMetrics | undefined {
+    return undefined;
+  },
+};
+
+// Re-export types for convenience
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  BaseKeyboardEvent,
+  AndroidKeyboardEvent,
+  IOSKeyboardEvent,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './types';

package/src/Keyboard/index.native.ts

@@ -0,0 +1,13 @@
+export { Keyboard } from './Keyboard.native';
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  BaseKeyboardEvent,
+  AndroidKeyboardEvent,
+  IOSKeyboardEvent,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './types';

package/src/Keyboard/index.ts

@@ -0,0 +1,13 @@
+export { Keyboard } from './Keyboard.web';
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  BaseKeyboardEvent,
+  AndroidKeyboardEvent,
+  IOSKeyboardEvent,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './types';

package/src/Keyboard/types.ts

@@ -0,0 +1,117 @@
+/**
+ * Keyboard metrics describing the keyboard position and size.
+ */
+export interface KeyboardMetrics {
+  screenX: number;
+  screenY: number;
+  width: number;
+  height: number;
+}
+
+/**
+ * Easing values for keyboard animations.
+ */
+export type KeyboardEventEasing =
+  | 'easeIn'
+  | 'easeInEaseOut'
+  | 'easeOut'
+  | 'linear'
+  | 'keyboard';
+
+/**
+ * Base keyboard event properties available on all platforms.
+ */
+export interface BaseKeyboardEvent {
+  duration: number;
+  easing: KeyboardEventEasing;
+  endCoordinates: KeyboardMetrics;
+}
+
+/**
+ * Android-specific keyboard event (duration is always 0).
+ */
+export interface AndroidKeyboardEvent extends BaseKeyboardEvent {
+  duration: 0;
+  easing: 'keyboard';
+}
+
+/**
+ * iOS-specific keyboard event with additional properties.
+ */
+export interface IOSKeyboardEvent extends BaseKeyboardEvent {
+  startCoordinates: KeyboardMetrics;
+  isEventFromThisApp: boolean;
+}
+
+/**
+ * Keyboard event passed to listeners.
+ */
+export type KeyboardEvent = AndroidKeyboardEvent | IOSKeyboardEvent;
+
+/**
+ * Keyboard event names.
+ * Note: 'keyboardWillShow' and 'keyboardWillHide' are iOS-only.
+ * On Android with adjustResize/adjustNothing, only 'keyboardDidShow' and 'keyboardDidHide' fire.
+ */
+export type KeyboardEventName =
+  | 'keyboardWillShow'
+  | 'keyboardDidShow'
+  | 'keyboardWillHide'
+  | 'keyboardDidHide'
+  | 'keyboardWillChangeFrame'
+  | 'keyboardDidChangeFrame';
+
+/**
+ * Listener function for keyboard events.
+ */
+export type KeyboardEventListener = (event: KeyboardEvent) => void;
+
+/**
+ * Subscription returned by addListener, used to unsubscribe.
+ */
+export interface KeyboardSubscription {
+  remove(): void;
+}
+
+/**
+ * Static Keyboard API interface.
+ */
+export interface KeyboardStatic {
+  /**
+   * Dismisses the active keyboard and removes focus.
+   */
+  dismiss(): void;
+
+  /**
+   * Connects a JavaScript function to an identified native keyboard notification event.
+   * Returns a subscription that can be used to unsubscribe.
+   *
+   * @param eventType - The keyboard event to listen for
+   * @param listener - Callback function when the event fires
+   * @returns Subscription with remove() method
+   */
+  addListener(
+    eventType: KeyboardEventName,
+    listener: KeyboardEventListener
+  ): KeyboardSubscription;
+
+  /**
+   * Useful for syncing TextInput (or other keyboard accessory view) size
+   * or position changes with keyboard movements.
+   *
+   * @param event - The keyboard event to schedule animation for
+   */
+  scheduleLayoutAnimation(event: KeyboardEvent): void;
+
+  /**
+   * Returns whether the keyboard is last known to be visible.
+   */
+  isVisible(): boolean;
+
+  /**
+   * Returns the metrics of the soft-keyboard if visible.
+   *
+   * @returns KeyboardMetrics if keyboard is visible, undefined otherwise
+   */
+  metrics(): KeyboardMetrics | undefined;
+}

package/src/index.native.ts

@@ -113,6 +113,9 @@ export * from './Link/types';
 export { default as Platform } from './Platform';
 export * from './Platform/types';
 
+export { Keyboard } from './Keyboard';
+export * from './Keyboard/types';
+
 export type { ButtonProps } from './Button/types';
 export type { IconButtonProps } from './IconButton/types';
 export type { TextProps } from './Text/types';
@@ -149,6 +152,15 @@ export type { ChipProps, ChipSize, ChipIntent } from './Chip/types';
 export type { BreadcrumbProps, BreadcrumbItem } from './Breadcrumb/types';
 export type { LinkProps } from './Link/types';
 export type { PlatformAPI, PlatformSystem, PlatformSelectSpec } from './Platform/types';
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './Keyboard/types';
 
 // Event utilities
 export * from './utils/events';

package/src/index.ts

@@ -121,6 +121,9 @@ export * from './Breadcrumb/types';
 export { default as Platform } from './Platform';
 export * from './Platform/types';
 
+export { Keyboard } from './Keyboard';
+export * from './Keyboard/types';
+
 export type { ButtonProps } from './Button/types';
 export type { IconButtonProps } from './IconButton/types';
 export type { TextProps } from './Text/types';
@@ -158,6 +161,15 @@ export type { SkeletonProps, SkeletonGroupProps, SkeletonShape, SkeletonAnimatio
 export type { ChipProps, ChipSize, ChipIntent } from './Chip/types';
 export type { BreadcrumbProps, BreadcrumbItem } from './Breadcrumb/types';
 export type { PlatformAPI, PlatformSystem, PlatformSelectSpec } from './Platform/types';
+export type {
+  KeyboardMetrics,
+  KeyboardEventEasing,
+  KeyboardEvent,
+  KeyboardEventName,
+  KeyboardEventListener,
+  KeyboardSubscription,
+  KeyboardStatic,
+} from './Keyboard/types';
 
 export { useMergeRefs };