@lynx-js/types 0.0.1 → 3.2.0

package/types/common/element/methods.d.ts

@@ -0,0 +1,84 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { BaseMethod, Callback } from '../events';
+import { AutoScrollMethod, ScrollToPositionMethod } from './list';
+import { ScrollToMethod } from './scroll-view';
+
+export type ListParams = ScrollToPositionMethod;
+
+export type ScrollViewParams = ScrollToMethod | AutoScrollMethod;
+
+interface BoundingClientRectMethod extends BaseMethod {
+  method: 'boundingClientRect';
+  success?: Callback<{
+    /**
+     *  Node ID.
+     */
+    id: string;
+
+    /**
+     *  Dataset of nodes.
+     */
+    dataset: object;
+
+    /**
+     * Left boundary coordinate of the node (in pixels)
+     */
+    left: number;
+
+    /**
+     *  The right boundary coordinates of the node.
+     */
+    right: number;
+
+    /**
+     *  Upper boundary coordinate of the node.
+     */
+    top: number;
+
+    /**
+     *  The lower boundary coordinates of the node
+     */
+    bottom: number;
+
+    /**
+     *  Width of the node.
+     */
+    width: number;
+
+    /**
+     * height of the node.
+     */
+    height: number;
+  }>;
+}
+
+interface SetFocusMethod extends BaseMethod {
+  method: 'setFocus';
+  params: {
+    /**  Set whether the element gains focus, `false` means the element loses focus.*/
+    focus: boolean;
+    /**   Whether to scroll the element into the visible area at the same time, default is `true`.*/
+    scroll?: boolean;
+  };
+}
+
+interface IsAnimatingMethod extends BaseMethod {
+  method: 'isAnimating';
+  success?: Callback<{ data: boolean }>;
+}
+
+interface ScrollIntoViewMethod extends BaseMethod {
+  method: 'scrollIntoView';
+  params: {
+    scrollIntoViewOptions: {
+      block: 'start' | 'center' | 'end';
+      inline: 'start' | 'center' | 'end';
+      behavior?: 'smooth';
+    };
+  };
+}
+
+export type InvokeParams = ListParams | ScrollViewParams | BoundingClientRectMethod | SetFocusMethod | IsAnimatingMethod | ScrollIntoViewMethod;

package/types/common/element/page.d.ts

@@ -0,0 +1,10 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { StandardProps } from '../props';
+
+/**
+ *  View container, used to hold other components.
+ */
+export interface PageProps extends StandardProps {}

package/types/common/element/scroll-view.d.ts

@@ -0,0 +1,280 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { BaseEvent, BaseMethod, EventHandler } from '../events';
+import { StandardProps } from '../props';
+import { AutoScrollMethod } from './list';
+import {
+  ContentSizeChangedEvent,
+  ScrollEndEvent,
+  BaseScrollInfo,
+  ScrollEvent,
+  ScrollToNormalStateEvent,
+  ScrollToLowerEvent,
+  ScrollToUpperEvent,
+  ScrollToUpperEdgeEvent,
+  ScrollToLowerEdgeEvent,
+} from './common';
+
+export interface ScrollViewProps extends StandardProps {
+  /**
+   * Scroll horizontaly.
+   * @defaultValue false
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-x'?: boolean;
+
+  /**
+   * Scroll vertically
+   * @defaultValue false
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-y'?: boolean;
+
+  /**
+   * Replacement of scroll-x and scroll-y
+   * @since 3.0
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-orientation'?: 'vertical' | 'horizontal';
+
+  /**
+   * Enable bounce effect
+   * @defaultValue false
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  bounces?: boolean;
+
+  /**
+   * Enable dragging
+   * @defaultValue false
+   * @since 1.4
+   * @iOS
+   * @Android 2.2
+   * @H
+   */
+  'enable-scroll'?: boolean;
+
+  /**
+   * Enable scrollbar
+   * @defaultValue false
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-bar-enable'?: boolean;
+
+  /**
+   * Not recommended to use. Please use upper-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
+   * @defaultValue 0
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  'upper-threshold'?: number;
+
+  /**
+   * Not recommended to use. Please use lower-threshold-item-count instead. Set upper threshold to bindscrolltoupper event.
+   * @defaultValue 0
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  'lower-threshold'?: number;
+
+  /**
+   * Please use initial-scroll-offset or ScrollTo method. Set the content offset from the top.
+   * @defaultValue 0
+   * @since 1.4
+   * @deprecated 2.17
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-top'?: number;
+
+  /**
+   * Please use initial-scroll-offset or ScrollTo method. Set the content offset from the left.
+   * @defaultValue 0
+   * @since 1.4
+   * @deprecated 2.17
+   * @iOS
+   * @Android
+   * @H
+   */
+  'scroll-left'?: number;
+
+  /**
+   * Initial scroll position, only effective once
+   * @defaultValue 0
+   * @since 2.17
+   * @iOS
+   * @Android
+   * @H
+   */
+  'initial-scroll-offset'?: number;
+
+  /**
+   * Please use initial-scroll-index or ScrollTo method。Set the first item at the first screen
+   * @defaultValue 0
+   * @since 2.1
+   * @deprecated 2.17
+   * @iOS
+   * @Android
+   */
+  'scroll-to-index'?: number;
+
+  /**
+   * Scroll to specified child node on first screen, only effective once. All direct child nodes must be flatten=false.
+   * @defaultValue 0
+   * @since 2.17
+   * @iOS
+   * @Android
+   * @H
+   */
+  'initial-scroll-to-index'?: number;
+
+  /**
+   * On iOS, force-can-scroll should be used with ios-block-gesture-class and ios-recognized-view-tag. Can be used alone on Android.
+   * @defaultValue false
+   * @since 2.10.1
+   * @iOS
+   * @Android
+   * @H
+   */
+  'force-can-scroll'?: boolean;
+
+  /**
+   * Force-can-scroll should be used with ios-block-gesture-class、ios-recognized-view-tag. Specify the class name of scrollable container that should be blocked by force-can-scroll. Given by container's developer.
+   * @defaultValue none
+   * @since 2.10.1
+   * @iOS
+   */
+  'ios-block-gesture-class'?: string;
+
+  /**
+   *  force-can-scroll should be used with ios-block-gesture-class、ios-recognized-view-tag. Specify scrollable container's tag, the UIView's tag. Set and given by container's developer.
+   * @defaultValue none
+   * @since 2.10.1
+   * @iOS
+   */
+  'ios-recognized-view-tag'?: number;
+
+  /**
+   * This event is triggered when the upper/left edge of the scrolling area intersects with the visible area defined by the upperThreshold.
+   * @defaultValue none
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrolltoupper?: EventHandler<ScrollToUpperEvent>;
+
+  /**
+   * This event is triggered when the lower/right edge of the scrolling area intersects with the visible area defined by the lowerThreshold.
+   * @defaultValue none
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrolltolower?: EventHandler<ScrollToLowerEvent>;
+
+  /**
+   * This event is triggered when the scrollview is scrolling.
+   * @defaultValue none
+   * @since 1.4
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscroll?: EventHandler<ScrollEvent>;
+
+  /**
+   * This event is triggered when the scrollview's scroll ended.
+   * @defaultValue none
+   * @since 1.6
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrollend?: EventHandler<ScrollEndEvent>;
+
+  /**
+   * This event is triggered when the scrollview's content size changed.
+   * @defaultValue none
+   * @since 1.6
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindcontentsizechanged?: EventHandler<ContentSizeChangedEvent>;
+
+  /**
+   * scrollview scrolls to upper edge
+   * @defaultValue none
+   * @since 3.0
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrolltoupperedge?: EventHandler<ScrollToUpperEdgeEvent>;
+
+  /**
+   * scrollview scrolls to lower edge
+   * @defaultValue none
+   * @since 3.0
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrolltoloweredge?: EventHandler<ScrollToLowerEdgeEvent>;
+
+  /**
+   * scrollview scrolls to normal position. Not at upper or lower edge
+   * @defaultValue none
+   * @since 3.0
+   * @iOS
+   * @Android
+   * @H
+   */
+  bindscrolltonormalstate?: EventHandler<ScrollToNormalStateEvent>;
+}
+
+export interface ScrollToMethod extends BaseMethod {
+  method: 'scrollTo';
+  params: {
+    /**
+     * Offset relative to target node
+     */
+    offset?: number;
+
+    /**
+     * Enable scroll animation
+     */
+    smooth?: boolean;
+
+    /**
+     * Target item index
+     * @defaultValue 0
+     */
+    index?: number;
+  };
+}
+
+export type ScrollViewUIMethods = ScrollToMethod | AutoScrollMethod;

package/types/common/element/text.d.ts

@@ -0,0 +1,97 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { BaseEvent, TextLayoutEventDetail } from '../events';
+import { StandardProps } from '../props';
+
+/**
+ * Text Component
+ */
+export interface TextProps extends StandardProps {
+  /**
+   * Maximum number of lines for text display
+   * @defaultValue "-1"
+   * @since 1.0
+   */
+  'text-maxline'?: string;
+
+  /**
+   * Maximum number of characters for text display
+   * @defaultValue ""
+   * @since 1.0
+   * @deprecated Suggest preprocessing the text content length.
+   */
+  'text-maxlength'?: string;
+
+  /**
+   * Whether font-size is affected by system font scaling
+   * @defaultValue false
+   * @since 1.6
+   */
+  'enable-font-scaling'?: boolean;
+
+  /**
+   * Baseline adjustment strategy in vertical direction; note: setting this value does not guarantee text centering
+   * @defaultValue ""
+   * @since 1.4
+   * @deprecated Use the text-single-line-vertical-align attribute instead.
+   */
+  'text-vertical-align'?: 'bottom' | 'center' | 'top';
+
+  /**
+   * By default, if text truncation occurs, the color of the inserted ... will be specified by the style on the nearest inline-text. If this attribute is enabled, the color of ... will be specified by the style on the outermost text tag.
+   * @defaultValue false
+   * @since 2.0
+   */
+  'tail-color-convert'?: boolean;
+
+  /**
+   * Enable long press to select text
+   * @defaultValue false
+   * @since 2.5
+   */
+  'text-selection'?: boolean;
+
+  /**
+   * Set single-line plain text to be centered and aligned within the line. Inline text settings are not supported. Recommended only when the default font doesn't meet center alignment needs, as it increases text measurement time.
+   * @defaultValue normal
+   * @iOS
+   * @Android
+   * @since 2.12
+   */
+  'text-single-line-vertical-align'?: 'normal' | 'bottom' | 'center' | 'top';
+
+  /**
+   * Enable additional spacing above and below the text on Android; recommended only in high language scenarios to avoid text truncation.
+   * @defaultValue false
+   * @Android
+   * @since 1.0
+   */
+  'include-font-padding'?: boolean;
+
+  /**
+   * Enable support for Emoji2 adaptation; requires androidx.emoji2 dependency.
+   * @defaultValue false
+   * @Android
+   * @since 2.9
+   */
+  'android-emoji-compat'?: boolean;
+
+  /**
+   * Enables fake bold for fonts when the default bold is not found.
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @since 2.13
+   */
+  'text-fake-bold'?: boolean;
+
+  /**
+   * Text layout event
+   * @since 2.7
+   */
+  bindlayout?: (e: LayoutEvent) => void;
+}
+
+export type LayoutEvent = BaseEvent<'layout', TextLayoutEventDetail>;

package/types/common/element/view.d.ts

@@ -0,0 +1,7 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+import { StandardProps } from '../props';
+
+export interface ViewProps extends StandardProps {}