Evaluate an embeddable player as a web component

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

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
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
frontend

Hướng nghiên cứu

Start with docs/architecture.md section 9, docs/adr/0009-vanilla-typescript-ui.md, apps/web/src/screens/game.ts, and SECURITY.md. Compare a web component prototype with the hosted-player iframe, recording bundle size and examining styling, storage isolation, pack safety, distribution, attribution, and cross-origin behavior. Done means a prototype demo page on a branch, a written recommendation with size numbers, and, if recommended, follow-up issues plus an ADR draft.

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

Mô tả

area: web priority: low type: research

Context

Authors want to embed their adventure in their own website. The architecture allows other front ends, and ADR 0009 notes that the shadow DOM complicates book typography and themes.

Scope

  • Prototype <lexvm-player src="pack.lexpack.json">, built from the existing game screen without library or service worker, with theme and UI language attributes and saves namespaced per page.
  • Questions: shadow DOM or light DOM styling; bundle size; storage partitioning when embedded; safety for the embedding site (packs are data, text only); distribution (npm package or a release file); showing author and license for CC BY attribution.
  • Alternative: an iframe embed of the hosted player with a pack parameter, and its cross-origin implications.

Acceptance criteria

  • A written evaluation with a recommendation (web component, iframe, or neither) and size numbers.
  • A prototype demo page on a branch.
  • If recommended: follow-up issues and an ADR draft.

References

  • docs/architecture.md (section 9)
  • docs/adr/0009-vanilla-typescript-ui.md
  • apps/web/src/screens/game.ts
  • SECURITY.md
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 24 phút
Pull request đã merge (30 ngày)
5

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 nullthrone/lexvm

Tất cả issue của nullthrone/lexvm

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.