Skip to content

Commit

Permalink
v1.2.2: fix types for PixiJS v8 (#10)
Browse files Browse the repository at this point in the history
* fixes for PixiJS v8 types

* test matrix
  • Loading branch information
reececomo authored Apr 27, 2024
1 parent 9b9c496 commit 8d51869
Show file tree
Hide file tree
Showing 14 changed files with 629 additions and 555 deletions.
10 changes: 2 additions & 8 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,10 @@ on:
jobs:
lint:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x]

steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
node-version: 20.x
- run: npm install
- run: npm run lint
36 changes: 31 additions & 5 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,42 @@ on:
jobs:
test:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [20.x]
include:
# https://pixijs.com/versions

- label: v6.3
pixi-version: '6.3.2'
typescript-version: '4.9.5'

- label: v6.x
pixi-version: '6.x.x'
typescript-version: '4.9.5'

- label: v7.0
pixi-version: '7.0.0'
typescript-version: '4.9.5'

- label: v7.x
pixi-version: '7.x.x'
typescript-version: '5.4.5'

- label: v8.0
pixi-version: '8.0.0'
typescript-version: '5.4.5'

- label: v8.x
pixi-version: '8.x.x'
typescript-version: '5.4.5'

name: pixi.js ${{ matrix.label }} (@v${{ matrix.pixi-version }})
steps:
- uses: actions/checkout@v3
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
node-version: 20.x
- run: npm install
- name: Install PixiJS v${{ matrix.pixi-version }}
run: npm install pixi.js@v${{ matrix.pixi-version }} typescript@v${{ matrix.typescript-version }}
- run: npm run test
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🎬 pixijs-actions  [![NPM version](https://img.shields.io/npm/v/pixijs-actions.svg?style=flat-square)](https://www.npmjs.com/package/pixijs-actions) [![test ci/cd status badge](https://github.com/reececomo/pixijs-actions/actions/workflows/test.yml/badge.svg)](https://github.com/reececomo/pixijs-actions/actions/workflows/test.yml) [![lint ci/cd status badge](https://github.com/reececomo/pixijs-actions/actions/workflows/lint.yml/badge.svg)](https://github.com/reececomo/pixijs-actions/actions/workflows/lint.yml)

PixiJS Actions allow developers to easily configure complex, high-performance animations in [PixiJS](https://pixijs.com/).
PixiJS Actions allows developers to easily configure complex, high-performance animations in [PixiJS](https://pixijs.com/).

- 🚀 35+ [built-in actions](#action-initializers), 30+ [smoothing options](#timing-modes)
- 🔀 Reuseable, chainable & reversible actions
Expand Down Expand Up @@ -63,10 +63,10 @@ yarn add pixijs-actions --dev

```ts
import * as PIXI from 'pixi.js';
import { Action, registerDisplayObjectMixin } from 'pixijs-actions';
import { Action, registerPixiJSActionsMixin } from 'pixijs-actions';

// Register mixin for container.
registerDisplayObjectMixin(PIXI.Container);
// Register mixin for containers.
registerPixiJSActionsMixin(PIXI.Container);

// Register `Action.tick(...)` with shared ticker
Ticker.shared.add(ticker => Action.tick(ticker.elapsedMS));
Expand Down Expand Up @@ -105,7 +105,7 @@ Most actions implement specific predefined animations that are ready to use. If
| `Action.moveBy(dx, dy, duration)` | Move a node by relative values. | Yes |
| `Action.moveByX(dx, duration)` | Move a node horizontally by a relative value. | Yes |
| `Action.moveByY(dy, duration)` | Move a node vertically by a relative value. | Yes |
| `Action.moveTo(position, duration)` | Move a node to a specified position `{ x, y }` (e.g. `PIXI.Point`, `PIXI.DisplayObject`). | _*No_ |
| `Action.moveTo(position, duration)` | Move a node to a specified position `{ x, y }` (e.g. `PIXI.Point`, `PIXI.Container`). | _*No_ |
| `Action.moveTo(x, y, duration)` | Move a node to a specified position. | _*No_ |
| `Action.moveToX(x, duration)` | Move a node to a specified horizontal position. | _*No_ |
| `Action.moveToY(y, duration)` | Move a node to a specified vertical position. | _*No_ |
Expand All @@ -123,7 +123,7 @@ Most actions implement specific predefined animations that are ready to use. If
| `Action.scaleBy(dx, dy, duration)` | Scale a node in each axis by relative values. | Yes |
| `Action.scaleByX(dx, duration)` | Scale a node horizontally by a relative value. | Yes |
| `Action.scaleByY(dy, duration)` | Scale a node vertically by a relative value. | Yes |
| `Action.scaleTo(size, duration)` | Scale a node to achieve a specified size `{ width, height }` (e.g. `PIXI.ISize`, `PIXI.DisplayObject`). | _*No_ |
| `Action.scaleTo(size, duration)` | Scale a node to achieve a specified size `{ width, height }` (e.g. `PIXI.ISize`, `PIXI.Container`). | _*No_ |
| `Action.scaleTo(scale, duration)` | Scale a node to a specified value. | _*No_ |
| `Action.scaleTo(x, y, duration)` | Scale a node in each axis to specified values. | _*No_ |
| `Action.scaleToX(x, duration)` | Scale a node horizontally to a specified value. | _*No_ |
Expand All @@ -139,7 +139,7 @@ Most actions implement specific predefined animations that are ready to use. If
|***Removing a Node from the Canvas***|||
| `Action.removeFromParent()` | Remove a node from its parent. | _†Identical_ |
|***Running Actions on Children***|||
| `Action.runOnChildWithName(action, childName)` | Run an action on a named child node. | Yes |
| `Action.runOnChild(nameOrLabel, action)` | Add an action to a child node. | Yes |
|***Delaying Actions***|||
| `Action.waitForDuration(duration)` | Idle for a specified period of time. | _†Identical_ |
| `Action.waitForDurationWithRange(duration, range)` | Idle for a randomized period of time. | _†Identical_ |
Expand Down
Loading

0 comments on commit 8d51869

Please sign in to comment.