forked from ctrl-freaks/freezeframe.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs, bump vue-freezeframe version
- Loading branch information
1 parent
27c426a
commit 73a5709
Showing
3 changed files
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,14 +12,23 @@ http://ctrl-freaks.github.io/freezeframe.js/ | |
|
||
## 5.x TypeScript beta | ||
|
||
Freezeframe core is now built in TypeScript! The library will still support usage in JavaScript, but if your project uses TypeScript, you'll have access to Freezeframe's type definitions, improved input validation, and depending on your IDE/text editor, autocompletion/intellisense. | ||
Freezeframe is now built in TypeScript! The library will still support usage in JavaScript, but if your project uses TypeScript, you'll have access to Freezeframe's type definitions, improved input validation, and depending on your IDE/text editor, autocompletion/intellisense. | ||
|
||
To get started using the TypeScript beta: | ||
|
||
```sh | ||
npm install [email protected] | ||
``` | ||
|
||
```sh | ||
npm install [email protected] | ||
``` | ||
|
||
```sh | ||
# react typescript re-write coming soon | ||
# npm install [email protected] | ||
``` | ||
|
||
## 4.x | ||
|
||
Version 4+ is built with modern javascript in mind. It's transpiled with webpack/babel, so it should | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,18 @@ Codesandbox: | |
|
||
https://codesandbox.io/s/vue-freezeframe-demo-jibmp | ||
|
||
## TypeScript | ||
|
||
`vue-freezeframe` is now written in TypeScript! The library will still support usage in JavaScript, but if your project uses TypeScript, you'll have access to Freezeframe's type definitions, improved input validation, and depending on your IDE/text editor, autocompletion/intellisense. | ||
|
||
For advanced use cases, take a look at the [demo source](./src/App.vue), or take a look at the [types exported from Freezeframe](../freezeframe/types). | ||
|
||
To get started using the TypeScript beta: | ||
|
||
```sh | ||
npm install [email protected] | ||
``` | ||
|
||
## Project setup | ||
|
||
```bash | ||
|
@@ -40,8 +52,6 @@ Vue.use(VueFreezeframe); | |
|
||
## Local-only usage | ||
|
||
`vue-freezeframe` is now written in TypeScript. For more advanced use cases, take a look at the [demo](./src/App.vue), or take a look at the [types exported from Freezeframe](../freezeframe/types). | ||
|
||
```html | ||
<template> | ||
<vue-freezeframe src="./something.gif" /> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters