Skip to content

asciinema: add poster parameter #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MykolaGolubyev merged 1 commit into from
Apr 23, 2025
Merged

asciinema: add poster parameter #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions znai-docs/znai/visuals/asciinema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To embedd [Acsiinema Player](https://docs.asciinema.org/manual/player/quick-start/) use:

```markdown
:include-asciinema: intro.cast {startAt: 10}
:include-asciinema: asciinema/intro.cast {startAt: "0:5", poster:"npt:0:5"}
```

:include-asciinema: asciinema/intro.cast {startAt: 10}
:include-asciinema: asciinema/intro.cast {startAt: "0:5", poster:"npt:0:5"}
4 changes: 2 additions & 2 deletions znai-reactjs/src/doc-elements/asciinema/Asciinema.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ import * as AsciinemaPlayer from 'asciinema-player';
import "asciinema-player/dist/bundle/asciinema-player.css";
import "./Asciinema.css"

export function Asciinema({src, startAt = 0}) {
export function Asciinema({src, startAt = 0, poster = undefined}) {
const containerRef = useRef(null);
const playerRef = useRef(null);

useEffect(() => {
if (containerRef.current) {
playerRef.current = AsciinemaPlayer.create(src, containerRef.current, {preload: true, fit: false, startAt});
playerRef.current = AsciinemaPlayer.create(src, containerRef.current, {preload: true, fit: false, startAt, poster});
}

return () => {
Expand Down
1 change: 1 addition & 0 deletions .../main/java/org/testingisdocumenting/znai/extensions/asciinema/AsciinemaIncludePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ public String id() {
public PluginParamsDefinition parameters() {
PluginParamsDefinition params = new PluginParamsDefinition();
params.add("startAt", PluginParamType.NUMBER_OR_STRING, "start the playback at a given time", "10 (seconds) or \"2:03\" (\"mm:ss\")");
params.add("poster", PluginParamType.STRING, "preview frame to display", "npt:0:32 (0 minutes 32 seconds)");

return params;
}
Expand Down