Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
node_modules/
dist/
coverage/
*.tsbuildinfo
.vite/
.DS_Store
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,14 @@ That's it. The spotlight finds elements even inside shadow roots.
// Full library (service + overlay + types + deepQuery)
import { createTourService, TorchlitOverlay, deepQuery } from 'torchlit';

// Headless service only — zero Lit dependency
// Headless service only — no DOM access and no Lit types in its declarations
import { createTourService } from 'torchlit/service';

// Overlay component only
import { TorchlitOverlay } from 'torchlit/overlay';
```

The `torchlit/service` entry point has **zero dependencies** and can be used with any rendering layer.
The `torchlit/service` entry point is **DOM-free** and can be used with any rendering layer.

## Features

Expand All @@ -139,15 +139,26 @@ The `torchlit/service` entry point has **zero dependencies** and can be used wit
torchlit/
src/
index.ts # Public API barrel export
types.ts # All TypeScript interfaces
tour-service.ts # Framework-agnostic state engine
tour-overlay.ts # Lit web component (rendering)
utils/
types.ts # Overlay-facing TypeScript interfaces
tour-service.ts # Stable headless service entrypoint
tour-overlay.ts # Lit overlay composition layer
core/
tour-service.ts # Pure state engine
types.ts # Service-facing core types
dom/
deep-query.ts # Shadow DOM traversal utility
positioning.ts # Placement, tooltip, clamp, arrow helpers
scroll-manager.ts # Scroll-into-view and restore helpers
target-resolver.ts # Target lookup and lazy target waiting
overlay/
focus-manager.ts # Focus trap and restore helpers
step-runner.ts # Step preparation orchestration
test/
tour-service.test.ts # Service unit tests (Vitest)
tour-overlay.test.ts # Overlay positioning & feature tests
tour-service.test.ts # Pure service unit tests (node env)
tour-overlay.test.ts # Overlay integration regressions
deep-query.test.ts # Deep query unit tests
positioning.test.ts # Positioning unit tests
step-runner.test.ts # Step orchestration unit tests
site/
index.html # Docs site source (builds to docs/)
examples/
Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| Version | Supported |
| ------- | ------------------ |
| 0.2.x | :white_check_mark: |
| < 0.2 | :x: |
| 0.3.x | :white_check_mark: |
| < 0.3 | :x: |

## Reporting a Vulnerability

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "torchlit",
"version": "0.2.3",
"version": "0.3.0",
"description": "Lightweight guided-tour & onboarding library built on Lit web components. Shadow DOM aware, framework-agnostic, tiny footprint.",
"type": "module",
"main": "dist/index.js",
Expand Down Expand Up @@ -70,10 +70,11 @@
"node": ">=18"
},
"devDependencies": {
"@vitest/coverage-v8": "^3.2.4",
"jsdom": "^28.0.0",
"lit": "^3.2.1",
"typescript": "^5.7.0",
"vite": "^6.1.0",
"vitest": "^3.0.0"
"vitest": "^3.2.4"
}
}
Loading