NVActivityIndicatorView

https://nvactivityindicatorview.vinhis.me/
Admin
NVActivityIndicatorView is a Swift library providing a collection of awesome loading animations with...
Tokens:1,821
Snippets:29
Trust Score:6.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install NVActivityIndicatorView with Carthage

Source: https://nvactivityindicatorview.vinhis.me/index.html

Add NVActivityIndicatorView to your Cartfile to integrate it into your Cocoa application using Carthage.

```bash
github "ninjaprox/NVActivityIndicatorView"

```

--------------------------------

### Start NVActivityIndicatorView Animation

Source: https://nvactivityindicatorview.vinhis.me/index.html

Call this method to begin the loading animation on an NVActivityIndicatorView instance.

```swift
activityIndicatorView.startAnimating()

```

--------------------------------

### Install NVActivityIndicatorView with Swift Package Manager

Source: https://nvactivityindicatorview.vinhis.me/index.html

Add NVActivityIndicatorView to the dependencies in your Package.swift file to use it with Swift Package Manager.

```swift
dependencies: [
    .package(url: "https://github.com/ninjaprox/NVActivityIndicatorView.git")
]

```

--------------------------------

### Install NVActivityIndicatorView with CocoaPods

Source: https://nvactivityindicatorview.vinhis.me/index.html

Add NVActivityIndicatorView to your Podfile to manage it as a dependency for Swift and Objective-C Cocoa projects.

```ruby
pod 'NVActivityIndicatorView'

```

--------------------------------

### Initialize NVActivityIndicatorView by Code

Source: https://nvactivityindicatorview.vinhis.me/index.html

Create an NVActivityIndicatorView instance programmatically. Parameters like type, color, and padding are optional and use default values if not provided.

```swift
NVActivityIndicatorView(frame: frame, type: type, color: color, padding: padding)

```

--------------------------------

### Import NVActivityIndicatorView

Source: https://nvactivityindicatorview.vinhis.me/index.html

Import the NVActivityIndicatorView library to use its functionalities in your Swift code.

```swift
import NVActivityIndicatorView

```

--------------------------------

### NVActivityIndicatorView Initialization

Source: https://nvactivityindicatorview.vinhis.me/Classes/NVActivityIndicatorView.html

Initializes an NVActivityIndicatorView with specified frame, animation type, color, and padding. Default values are used for any omitted parameters.

```APIDOC
## init(frame:type:color:padding:)

### Description
Creates an activity indicator view with customizable animation type, color, and padding. Uses default values for any parameters that are not provided.

### Parameters
- **frame** (CGRect) - The frame for the activity indicator view.
- **type** (NVActivityIndicatorType) - The type of animation to display. Defaults to .BallSpinFadeLoader.
- **color** (UIColor) - The color of the activity indicator. Defaults to UIColor.white.
- **padding** (CGFloat) - The padding around the activity indicator. Defaults to 0.
```

--------------------------------

### NVActivityIndicatorView Properties

Source: https://nvactivityindicatorview.vinhis.me/Classes/NVActivityIndicatorView.html

Configurable properties for NVActivityIndicatorView.

```APIDOC
## Properties

- **type** (NVActivityIndicatorType): The type of animation to display. Defaults to .BallSpinFadeLoader.
- **color** (UIColor): The color of the activity indicator. Defaults to UIColor.white.
- **padding** (CGFloat): The padding around the activity indicator. Defaults to 0.
- **isAnimating** (Bool): Current status of the animation (read-only).
```

--------------------------------

### NVActivityIndicatorView Default Configuration

Source: https://nvactivityindicatorview.vinhis.me/Classes/NVActivityIndicatorView.html

Default values for various NVActivityIndicatorView properties and blocker settings.

```APIDOC
## Default Values

- **DEFAULT_TYPE**: Default animation type. Defaults to .BallSpinFadeLoader.
- **DEFAULT_COLOR**: Default color of the activity indicator. Defaults to UIColor.white.
- **DEFAULT_TEXT_COLOR**: Default color of the text. Defaults to UIColor.white.
- **DEFAULT_PADDING**: Default padding. Defaults to 0.
- **DEFAULT_BLOCKER_SIZE**: Default size of the activity indicator view in a UI blocker. Defaults to 60x60.
- **DEFAULT_BLOCKER_DISPLAY_TIME_THRESHOLD**: Default display time threshold to actually display the UI blocker. Defaults to 0 ms.
- **DEFAULT_BLOCKER_MINIMUM_DISPLAY_TIME**: Default minimum display time of the UI blocker. Defaults to 0 ms.
- **DEFAULT_BLOCKER_MESSAGE**: Default message displayed in the UI blocker. Defaults to nil.
- **DEFAULT_BLOCKER_MESSAGE_SPACING**: Default message spacing to the activity indicator view in the UI blocker. Defaults to 8.
- **DEFAULT_BLOCKER_MESSAGE_FONT**: Default font of the message displayed in the UI blocker. Defaults to bold system font, size 20.
- **DEFAULT_BLOCKER_BACKGROUND_COLOR**: Default background color of the UI blocker. Defaults to UIColor(red: 0, green: 0, blue: 0, alpha: 0.5).
- **DEFAULT_FADE_IN_ANIMATION**: Default fade in animation.
- **DEFAULT_FADE_OUT_ANIMATION**: Default fade out animation.
```

--------------------------------

### NVActivityIndicatorView Animation Control

Source: https://nvactivityindicatorview.vinhis.me/Classes/NVActivityIndicatorView.html

Methods to control the animation state of the NVActivityIndicatorView.

```APIDOC
## startAnimating()

### Description
Starts the activity indicator animation.

### Method
`startAnimating()`
```

```APIDOC
## stopAnimating()

### Description
Stops the activity indicator animation.

### Method
`stopAnimating()`
```

--------------------------------

### Stop NVActivityIndicatorView Animation

Source: https://nvactivityindicatorview.vinhis.me/index.html

Call this method to halt the loading animation on an NVActivityIndicatorView instance.

```swift
activityIndicatorView.stopAnimating()

```

--------------------------------

### Check if NVActivityIndicatorView is Animating

Source: https://nvactivityindicatorview.vinhis.me/index.html

Determine whether the NVActivityIndicatorView is currently running its animation. Returns a boolean value.

```swift
animating = activityIndicatorView.isAnimating

```
Tokens:
Raw