README.md

@ssv/ngx.tilt

Angular Wrapper for Vanilla Tilt a smooth 3D tilt.

Quick links

Change logs | Project Repository

Installation

Get library via npm

npm install vanilla-tilt @types/vanilla-tilt @ssv/ngx.tilt

Usage

Register module

import { TiltModule } from "@ssv/ngx.tilt";

@NgModule({
  imports: [
    TiltModule
  ]
}
export class AppModule {
}

<!-- simple -->
<div ssvTilt>
  im tilt
</div>

const tiltOptions: TiltOptions = {
  glare: true,
  ["max-glare"]: 0.5
}

<!-- with options -->
<div ssvTilt [tiltOptions]="tiltOptions">
  show only when large
</div>

Cloning Repo

• Run git clone https://github.com/ssv/ngx.tilt

Project Setup

The following process need to be executed in order to get started.

npm install

Building the code

npm run build

Running the tests

npm test

Development utils

Watch

Builds on changes.

npm start

Running Continuous Tests

Spawns test runner and keep watching for changes.

npm run tdd

Preparation for Release

npm run prepare-release -- --bump major|minor|patch|prerelease (default: patch)

Check out the release workflow guide in order to guide you creating a release and publishing it.