[LayerNext 1] Add shared hosting and typed layer authoring contracts

Đang mở
#374 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
react, typescript

Hướng nghiên cứu

Start by reading prerequisite #358 and coordinate the constructor typing and React inference work in #360 and #363; inspect the existing Layer, graph registration, useLayer/GraphLayer APIs, declaration checks, and v1-to-v2 migration guide. The issue leaves the public API design open, so first settle the authoring syntax and host/adapter boundaries with maintainers. Done means the acceptance criteria pass for mixed old and new layers, source and packed declarations, current consumers, and migration documentation.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Parent: #373. Status: deferred. Target branch: v2.

Prerequisite: #358. Coordinate constructor typing with #360 and React inference with #363; this task must not block the existing strict track.

Problem

Current layer props combine user data, graph/camera/root dependencies and resource configuration. Authoring a canvas layer requires repeating context types and validating fields that the base layer creates. canvas and graphCanvas can refer to different elements depending on the subclass.

Scope

  • Design and introduce LayerNext alongside the existing Layer, without subclassing the old public API.
  • Share an internal host/adapter mechanism for registration, scheduling and resources rather than copying the engine.
  • Separate user props from runtime dependencies and resource creation options; graph root ownership is internal.
  • Define typed canvas-only, HTML-only, combined and resource-free modes. Choose ergonomic syntax before implementation; the public surface should remain centered on Layer and LayerNext during transition.
  • Provide a guaranteed drawing context for canvas mode, checked when created. The new drawing hook should receive a prepared canvas without requiring manual resetTransform or super calls.
  • Give own-canvas access a consistent meaning. Use the graph API explicitly for the main graph canvas in the new model.
  • Make graph registration and React useLayer/GraphLayer accept both models while preserving exact props, instance and ref types. Omitted props are allowed only when no user prop is required.

Acceptance criteria

  • Old and new custom layers can coexist in one graph and continue rendering correctly.
  • Required/optional custom props, concrete methods/refs and generic custom classes are checked against source and packed declarations.
  • Canvas resources are required only in canvas-capable modes; missing resources and null 2D context have defined behavior.
  • Author code does not need a custom context assertion to access its declared resources.
  • No graph/camera/root injection details appear in user props; registration retains inference without blanket constructor casts.
  • Source/declaration checks and current consumers stay green; transition changes are documented in the v1-to-v2 migration guide.

The detailed API design is future work for this issue, not an already approved implementation spec. Lifecycle/disposal and reactive prop updates are tracked by the following child tasks.

Ngôn ngữ chính
TypeScript
Star
145
Fork
12
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
43

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của gravity-ui/graph

Tất cả issue của gravity-ui/graph

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.