Releases · asciinema/asciinema-player

10 Feb 14:57

ku1ik

v3.1.0

99f7423

3.1.0

added support for faint graphic rendition
added Nord color theme
implemented ansi.sys variant of DECSC/DECRC control sequences: CSI s and CSI u
fixed charset switching (shift out/in control sequence behaviour)
fixed upper line clearing when scrolling down within scroll region
improved soft reset (DECSTR control sequence) - charset states (G0, G1, GL) are now reset as well

Assets 2

12 Jun 20:00

ku1ik

v3.0.1

54ffa18

3.0.1

v3.0.1

Bump version

Assets 4

01 May 20:29

ku1ik

v3.0.0

6bed338

3.0.0

Brand new player rewritten from scratch. Smaller, faster, better.

Upgrading from v2 to v3

v2.x used, now deprecated, document.registerElement(...) API for registering
<asciinema-player> custom HTML element. This way of initializing the player
has been removed in v3.x, replaced with standard JavaScript API.

Instead of this v2 code:

<!DOCTYPE html>
<html>
<head>
  ...
  <link rel="stylesheet" type="text/css" href="/asciinema-player.css" />
  ...
</head>
<body>
  ...
  <asciinema-player src="/demo.cast" speed="2" loop></asciinema-player>
  ...
  <script src="/asciinema-player.js"></script>
</body>
</html>

Use this v3 code:

<!DOCTYPE html>
<html>
<head>
  ...
  <link rel="stylesheet" type="text/css" href="/asciinema-player.css" />
  ...
</head>
<body>
  ...
  <div id="demo"></div>
  ...
  <script src="/asciinema-player.min.js"></script>
  <script>
    AsciinemaPlayer.create('/demo.cast', document.getElementById('demo'), {
      speed: 2,
      loop: true
    });
  </script>
</body>
</html>

There's also asciinema-player npm package, which can be
used instead of the standalone bundle. Check the quick start guide for details.

src attribute becomes the first argument to AsciinemaPlayer.create(). The
second argument specifies the container element to mount the player under. All
other option attributes are now passed in options objects as the third argument.

The following table shows how 2.x attributes map to new 3.x options:

2.x attribute	3.x option	example	notes
`cols`	`cols`	`{ cols: 80 }`
`rows`	`rows`	`{ rows: 24 }`
`autoplay`	`autoPlay`	`{ autoPlay: true }`
`preload`	`preload`	`{ preload: true }`
`loop`	`loop`	`{ loop: true }` or `{ loop: 3 }`
`start-at`	`startAt`	`{ startAt: 33 }`
`speed`	`speed`	`{ speed: 2 }`
`idle-time-limit`	`idleTimeLimit`	`{ idleTimeLimit: 2 }`
`poster`	`poster`	`{ poster: "npt:2:34" }`
`font-size`	`terminalFontSize`	`{ terminalFontSize: "20px", fit: false }`	requires `fit: false`
`theme`	`theme`	`{ theme: "dracula" }`
`title`	-	-	removed
`author`	-	-	removed
`author-url`	-	-	removed
`author-img-url`	-	-	removed