@barmark/render 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -6,6 +6,17 @@ package uses [semantic versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-11-02
+
+The spoken name of a chord, for other tools. barmark.dev's /try page
+uses it.
+
+### Added
+
+- **`speakChord(record, key?)`**: the spoken name the chart gives a chord
+  ("C minor seven flat five"; with a key, its degree too), for screen
+  readers and other tools.
+
 ## [0.4.0] - 2026-11-01
 
 Chords as Nashville numbers or Roman numerals, and a little air between
@@ -158,7 +169,8 @@ that needs no script or as the `<barmark-chart>` web component. Requires
   zoom without sideways scrolling, the element renders and re-renders, and
   a screen reader hears "bar 9: D". Run them with `bun run test:browser`.
 
-[Unreleased]: https://github.com/kevinpeckham/barmark/compare/render-v0.4.0...HEAD
+[Unreleased]: https://github.com/kevinpeckham/barmark/compare/render-v0.5.0...HEAD
+[0.5.0]: https://github.com/kevinpeckham/barmark/compare/render-v0.4.0...render-v0.5.0
 [0.4.0]: https://github.com/kevinpeckham/barmark/compare/render-v0.3.0...render-v0.4.0
 [0.3.0]: https://github.com/kevinpeckham/barmark/compare/render-v0.2.1...render-v0.3.0
 [0.2.1]: https://github.com/kevinpeckham/barmark/compare/render-v0.2.0...render-v0.2.1

package/README.md

@@ -92,6 +92,21 @@ no key, note sets, N.C., `?` and `--` look as they always do, and a
 screen reader hears both: "bar 5: five, A seven". Numbered chords carry
 `data-numeral`. It's a view: the music and bar numbers don't change.
 
+### Spoken names
+
+`speakChord(record, key?)` gives a chord the name a screen reader hears
+in the chart, for other tools that want to say a chord aloud:
+
+```ts
+import { parseChord } from "barmark";
+import { speakChord } from "@barmark/render";
+
+const r = parseChord("Cø");
+if (r.ok) speakChord(r.value); // "C minor seven flat five"
+```
+
+With a key, it speaks the degree too, as the numerals view does.
+
 ## Styling on purpose
 
 Set these custom properties on the element or anything above it:

package/dist/index.d.ts

@@ -2,5 +2,6 @@ export type { Numerals } from "./chord.js";
 export { FONT_FAMILY, fontFaceCss } from "./font.js";
 export { type RenderOptions, renderChart, renderChartUnwrapped } from "./html.js";
 export { layoutChart } from "./model.js";
+export { speakChord } from "./speech.js";
 export { stylesheet } from "./styles.js";
 export type * from "./types.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 export { FONT_FAMILY, fontFaceCss } from "./font.js";
 export { renderChart, renderChartUnwrapped } from "./html.js";
 export { layoutChart } from "./model.js";
+export { speakChord } from "./speech.js";
 export { stylesheet } from "./styles.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@barmark/render",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Render barmark chord charts as a clean, accessible bar grid: HTML with Declarative Shadow DOM, or the <barmark-chart> web component.",
 	"type": "module",
 	"exports": {