@braccato/core 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,63 @@
+# @braccato/core
+
+`<braccato-lyrics>` web component for synchronized lyrics rendering with word-by-word animations. Built with Lit, extracted from the [Better Lyrics](https://better-lyrics.boidu.dev) rendering engine.
+
+## Install
+
+```bash
+npm i @braccato/core
+```
+
+## Usage
+
+```html
+<audio id="player" src="song.mp3" controls></audio>
+<braccato-lyrics source="#player" src="lyrics.ttml"></braccato-lyrics>
+
+<script type="module">
+  import "@braccato/core";
+</script>
+```
+
+The `source` attribute accepts a CSS selector for any `<audio>` or `<video>` element. The `src` attribute fetches and parses a lyrics file (TTML, LRC, SRT, QRC, or plain text are auto-detected).
+
+For manual control, set `lyrics`, `currentTime`, and `playing` directly instead.
+
+## Properties
+
+| Property | Attribute | Type | Default | Description |
+|----------|-----------|------|---------|-------------|
+| `source` | `source` | `string \| null` | `null` | CSS selector for the media element to sync with |
+| `src` | `src` | `string \| null` | `null` | URL to a lyrics file (auto-detected format) |
+| `lyrics` | | `Lyric[]` | `[]` | Parsed lyric data (set directly for manual control) |
+| `currentTime` | `current-time` | `number` | `0` | Playback position in ms (ignored when `source` is set) |
+| `playing` | `playing` | `boolean` | `false` | Whether playback is active (ignored when `source` is set) |
+| `scrollMode` | `scroll-mode` | `'internal' \| 'external'` | `'internal'` | Scroll container ownership |
+| `dir` | `dir` | `'auto' \| 'ltr' \| 'rtl'` | `'auto'` | Text direction |
+
+## Events
+
+| Event | Detail | Description |
+|-------|--------|-------------|
+| `braccato:line-click` | `{ time, lineIndex }` | User clicked a lyric line |
+| `braccato:word-click` | `{ time, lineIndex, wordIndex }` | Alt+click on a word (rich sync) |
+| `braccato:lyrics-loaded` | `{ syncType, lineCount }` | Lyrics injected into the DOM |
+| `braccato:scroll-state` | `{ userScrolling }` | Scroll state changed |
+| `braccato:error` | `{ error }` | Fetch or parse error (when using `src`) |
+
+## CSS Custom Properties
+
+```css
+braccato-lyrics {
+  --braccato-font-family: system-ui, sans-serif;
+  --braccato-font-size: 3rem;
+  --braccato-font-weight: 600;
+  --braccato-active-color: white;
+  --braccato-inactive-opacity: 0.3;
+  --braccato-glow-color: rgba(255, 255, 255, 0.5);
+  --braccato-timing-offset: 0.115s;
+  --braccato-richsync-timing-offset: 0.150s;
+}
+```
+
+See the [full documentation](https://github.com/better-lyrics/braccato) for all properties and framework examples.

package/package.json

@@ -1,51 +1,41 @@
 {
-  "name": "@braccato/core",
-  "version": "0.1.0",
-  "description": "Synchronized lyrics web component with word-by-word animations",
-  "type": "module",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/better-lyrics/braccato",
-    "directory": "packages/core"
-  },
-  "homepage": "https://github.com/better-lyrics/braccato",
-  "keywords": [
-    "lyrics",
-    "sync",
-    "web-component",
-    "lit",
-    "music",
-    "karaoke",
-    "ttml"
-  ],
-  "sideEffects": true,
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "lit": "^3.2.1",
-    "@braccato/parsers": "^0.1.0"
-  },
-  "devDependencies": {
-    "typescript": "^5.7.3",
-    "vite": "^6.0.7",
-    "vite-plugin-dts": "^4.3.0"
-  },
-  "scripts": {
-    "build": "vite build",
-    "dev": "vite build --watch",
-    "typecheck": "tsc --noEmit"
-  }
-}
+	"name": "@braccato/core",
+	"version": "0.1.1",
+	"description": "Synchronized lyrics web component with word-by-word animations",
+	"type": "module",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/better-lyrics/braccato",
+		"directory": "packages/core"
+	},
+	"homepage": "https://github.com/better-lyrics/braccato",
+	"keywords": ["lyrics", "sync", "web-component", "lit", "music", "karaoke", "ttml"],
+	"sideEffects": true,
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		}
+	},
+	"files": ["dist"],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "vite build",
+		"dev": "vite build --watch",
+		"typecheck": "tsc --noEmit"
+	},
+	"dependencies": {
+		"@braccato/parsers": "workspace:^",
+		"lit": "^3.2.1"
+	},
+	"devDependencies": {
+		"typescript": "^5.7.3",
+		"vite": "^6.0.7",
+		"vite-plugin-dts": "^4.3.0"
+	}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Better Lyrics
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.