solely 0.0.22 → 0.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,14 +1,56 @@
1
1
  import { Manifest } from './decorators';
2
- declare interface BaseElement {
2
+ /**
3
+ * 泛型接口
4
+ * 外部组件可定义 $data 的结构类型(带智能提示)
5
+ * 例如:class MyEl extends BaseElement<{ count: number; name: string }> {}
6
+ */
7
+ declare interface BaseElement<TData = any> {
3
8
  _manifest: Manifest;
4
9
  }
5
- declare class BaseElement extends HTMLElement {
10
+ /**
11
+ * BaseElement<TData>
12
+ * -------------------------------------------------------
13
+ * 核心功能:
14
+ * ✅ 响应式数据系统(observe + Proxy)
15
+ * ✅ 虚拟 DOM 渲染(patch)
16
+ * ✅ 延迟样式注入(connectedCallback 阶段)
17
+ * ✅ 生命周期钩子(created, mounted, updated, unmounted)
18
+ * ✅ 属性同步 ($data <-> attribute)
19
+ */
20
+ declare class BaseElement<TData extends object> extends HTMLElement {
6
21
  #private;
7
- constructor();
8
- get $data(): any;
9
- set $data(value: any);
22
+ /** Web Components 标准方法:声明哪些属性变化会触发 attributeChangedCallback */
23
+ static get observedAttributes(): any;
24
+ /**
25
+ * 构造函数
26
+ * -------------------------------------------------------
27
+ * 初始化模板、响应式数据和渲染根节点。
28
+ * 样式注入延迟到 connectedCallback 阶段。
29
+ */
30
+ constructor(initialData?: TData);
31
+ /** 获取当前组件数据 */
32
+ get $data(): TData;
33
+ /** 更新组件数据 */
34
+ set $data(value: TData);
35
+ /**
36
+ * 手动刷新组件
37
+ * 外部可调用,用于数据未触发 observe 或强制刷新
38
+ */
39
+ refresh(): void;
10
40
  connectedCallback(): void;
11
- onInit(): Promise<void> | void;
12
41
  disconnectedCallback(): void;
42
+ attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
43
+ /** 兼容旧组件的初始化钩子(首次 mounted 后调用) */
44
+ onInit(): void | Promise<void>;
45
+ /** 组件创建完成(构造函数结束时调用) */
46
+ created(): void;
47
+ /** 组件首次挂载到 DOM 后调用 */
48
+ mounted(): void;
49
+ /** 每次更新前调用 */
50
+ beforeUpdate(): void;
51
+ /** 每次更新完成后调用 */
52
+ updated(): void;
53
+ /** 组件从 DOM 中卸载时调用 */
54
+ unmounted(): void;
13
55
  }
14
56
  export default BaseElement;
@@ -1,10 +1,22 @@
1
+ /** Prop 配置,支持类型声明 */
2
+ export interface PropOption {
3
+ name: string;
4
+ type?: 'string' | 'number' | 'boolean' | 'object';
5
+ }
6
+ /**
7
+ * Manifest:组件声明配置
8
+ * -------------------------------------------------------
9
+ * 用于描述组件模板、样式、属性监听和 Shadow DOM 行为。
10
+ */
1
11
  export interface Manifest {
2
- tagName: string;
3
12
  template?: string;
4
- className?: string;
13
+ styles?: string;
14
+ props?: Array<string | PropOption>;
5
15
  shadowDOM?: {
6
16
  use: boolean;
7
- mode?: 'open' | 'closed';
17
+ mode?: "open" | "closed";
8
18
  };
19
+ className?: string;
20
+ tagName: string;
9
21
  }
10
22
  export declare const CustomElement: (manifest: Manifest) => ClassDecorator;
@@ -13,8 +13,31 @@ export declare class RouterViewElement extends HTMLElement {
13
13
  set $pipe(v: Record<string, any>);
14
14
  connectedCallback(): void;
15
15
  disconnectedCallback(): void;
16
+ /**
17
+ * Hash 变化时的核心处理函数
18
+ */
16
19
  private onHashChange;
20
+ /**
21
+ * 准备传递给子组件的 props 和事件监听
22
+ * @param params 从路由中解析出的参数
23
+ * @returns 包含 props 和 on 的对象
24
+ */
25
+ private prepareComponentData;
26
+ /**
27
+ * 在路由表中查找与当前路径匹配的路由
28
+ * @param routes 路由配置数组
29
+ * @param pathSegments URL 路径分段数组
30
+ * @returns 匹配结果
31
+ */
17
32
  private matchRoute;
18
- private propagateRoutes;
19
- private findAncestorWithRouterView;
33
+ /**
34
+ * 递归通知所有子节点中的 router-view 进行更新
35
+ * @param node 当前遍历的起始节点
36
+ */
37
+ private propagateToChildRouterViews;
38
+ /**
39
+ * 沿 DOM 树向上查找最近的父 router-view 实例
40
+ * @returns 父 RouterViewElement 实例或 null
41
+ */
42
+ private findAncestorRouterView;
20
43
  }