@markgrafhq/markgraf-react 0.0.41 → 0.0.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/markgraf-react.js +14029 -14164
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,7 +27,7 @@ when a main-thread SVG player is required.
|
|
|
27
27
|
|
|
28
28
|
## `<MarkgrafPlayer src=... />`
|
|
29
29
|
|
|
30
|
-
Headless component that draws the scene directly into the selected Canvas2D
|
|
30
|
+
Headless component that draws the scene directly into the selected Canvas2D or SVG surface. Bring your own controls.
|
|
31
31
|
|
|
32
32
|
```jsx
|
|
33
33
|
import { MarkgrafPlayer } from "@markgrafhq/markgraf-react";
|
|
@@ -43,7 +43,6 @@ scene v1 {
|
|
|
43
43
|
export default function App() {
|
|
44
44
|
return <MarkgrafPlayer src={src} />;
|
|
45
45
|
// Or: <MarkgrafPlayer src={src} renderer="svg" />
|
|
46
|
-
// Or: <MarkgrafPlayer src={src} renderer="sdf" />
|
|
47
46
|
}
|
|
48
47
|
```
|
|
49
48
|
|
|
@@ -182,9 +181,10 @@ All seek methods retain the existing playing/paused state; a seek is not a pause
|
|
|
182
181
|
|
|
183
182
|
### Renderer choice
|
|
184
183
|
|
|
185
|
-
- **`canvas`** (default) — Canvas2D with DPR-aware scaling and label springs.
|
|
184
|
+
- **`canvas`** (default) — Canvas2D with DPR-aware scaling and label springs.
|
|
186
185
|
- **`svg`** — Inline SVG. Easier to inspect/style, scales crisply at any zoom, no DPR concerns. No spring labels.
|
|
187
|
-
|
|
186
|
+
|
|
187
|
+
For readable diagrams, follow the [graph authoring guidance](https://github.com/i-am-the-slime/markgraf#writing-graphs-people-can-follow).
|
|
188
188
|
|
|
189
189
|
## License
|
|
190
190
|
|