Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 0 additions & 9 deletions .editorconfig

This file was deleted.

10 changes: 0 additions & 10 deletions .travis.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["Vue.volar"]
}
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

89 changes: 4 additions & 85 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,7 @@
# Vue 3 + Vite

# Textra [![Build Status](https://travis-ci.org/hosein2398/Textra.svg?branch=master)](https://travis-ci.org/hosein2398/Textra)
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

> A Vue.js add-on to slide your text. [demo](https://hosein2398.github.io/textra/)
## Recommended IDE Setup

## Installing
```
npm i -D vue-textra
```
Then inside your project, start using it:
```js
import Vue from 'vue'
import App from './App.vue'
import Textra from 'vue-textra'

Vue.use(Textra);
new Vue({
el: '#app',
render: h => h(App)
})
```
To use inside browser:
```html
<script src='https://cdn.jsdelivr.net/npm/vue-textra@latest/dist/textra.min.js'></script>
```
Then:
```js
Vue.use(Textra);
```
## Usage
Inside any of your components:
```html
<textra :data='words' :timer="4" filter="flash" />
```
And in your instance data:
```js
//...
data () {
return {
words: ["My text to show", "Great news here!", "Vue is great", "Sample Text"]
}
}
//...
```

Another example :
```html
<textra :data='words' :timer="3.1" :infinite='true' filter="left-right" />
```
This one will loop around for ever.
## Props
#### `data`
Type : Array
Description : Should be array of things you want to slide.

---

#### `timer`
Type : Number
Description : Defines gap between each slide as second.
Default : `2`

---

#### `filter`
Type : String
Description : Defines type of filter you want to use when sliding.
Default : `simple`

---

#### `infinite`
Type : Boolean
Description : Defines whether your slider should keep looping or not.
Default : `false`


## Filters
There are 9 types of filters available for now:
+ `simple`
+ `bottom-top`
+ `top-bottom`
+ `right-left`
+ `left-right`
+ `press`
+ `scale`
+ `flash`
+ `flip`
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
148 changes: 0 additions & 148 deletions dist/main.esm.js

This file was deleted.

Loading