https://github.com/mint-ui/mint-indicator

A mobile indicator plugin for vue.js
https://github.com/mint-ui/mint-indicator

Last synced: 13 days ago
JSON representation

A mobile indicator plugin for vue.js

• Host: GitHub
• URL: https://github.com/mint-ui/mint-indicator
• Owner: mint-ui
• Created: 2016-05-05T09:34:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-22T11:49:15.000Z (almost 7 years ago)
• Last Synced: 2024-10-15T18:02:09.079Z (24 days ago)
• Language: Vue
• Size: 15.6 KB
• Stars: 68
• Watchers: 5
• Forks: 38
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-vue-cn - vue-indicator
• awesome-vue - mint-indicator - ui/mint-indicator?style=social) - VueJS移动加载指示器插件 (UI组件)
• awesome-github-vue - mint-indicator - VueJS移动加载指示器插件 (UI组件)
• awesome-github-vue - mint-indicator - VueJS移动加载指示器插件 (UI组件)
• awesome - mint-indicator - VueJS移动加载指示器插件 (UI组件)

README

        
# Overview

vue-indicator is a mobile loading indicator plugin for vue.js.

# Installation

First, install `vue-indicator` from npm:

```bash

$ npm install vue-indicator

```

Then use it:

```Javascript

// ES6 mudule

import Indicator from 'vue-indicator';

// CommonJS

const Indicator = require('vue-indicator').default;

```

# Usage

Open an indicator:

```Javascript

Indicator.open();

```

Open an indicator with a string:

```Javascript

Indicator.open('Loading...');

```

Open an indicator with an object:

```Javascript

Indicator.open({ text:'Loading...', spinnerType: 'fading-circle' });

```

Then close it:

```Javascript

Indicator.close();

```

# API

| Option      | Description    | Value                                                       | Default |

|-------------|----------------|-------------------------------------------------------------|---------|

| text        | indicator text | String                                                      |         |

| spinnerType | spinner type   | 'snake', 'fading-circle', 'double-bounce', 'triple-bounce'  | 'snake' |

# License

MIT