Skip to content

florianhidayat/material-showcase-ios

 
 

Repository files navigation

Material Showcase for iOS

Download License

An elegant and beautiful tap showcase view for iOS apps based on Material Design Guidelines.

Screenshots Screenshots Screenshots Screenshots

Requirement

  • iOS 8.0+
  • Swift 3.0+

Installation

You can install it by using CocoaPods. Please add the following line to your Podfile.

pod 'MaterialShowcase'

Usage

Basic

  let showcase = MaterialShowcase()
  showcase.setTargetView(view: button) // always required to set targetView
  showcase.primaryText = "Action 1"
  showcase.secondaryText = "Click here to go into details"
  showcase.show(completion: {
    _ in
    // You can save showcase state here
    // Later you can check and do not show it again
  })

Supported Target Views

There are several target view supported.

  // Any UIView
  showcase.setTargetView(view: view)
  // UIBarButtonItem
  showcase.setTargetView(barButtonItem: barItem)
  // UITabBar item
  showcase.setTargetView(tabBar: tabBar, itemIndex: 0)
  // UItableViewCell
  showcase.setTargetView(tableView: tableView, section: 0, row: 0)

Customize UI properties

You can define your own styles based on your app.

  // Background
  showcase.backgroundPromptColor = UIColor.blue
  showcase.backgroundPromptColorAlpha = 0.96
  // Target
  showcase.targetTintColor = UIColor.blue
  showcase.targetHolderRadius = 44
  showcase.targetHolderColor = UIColor.white
  // Text
  showcase.primaryTextColor = UIColor.white
  showcase.secondaryTextColor = UIColor.white
  showcase.primaryTextSize = 20
  showcase.secondaryTextSize = 15
  // Animation
  showcase.aniComeInDuration = 0.5 // unit: second
  showcase.aniGoOutDuration = 0.5 // unit: second
  showcase.aniRippleScale = 1.5 
  showcase.aniRippleColor = UIColor.white
  showcase.aniRippleAlpha = 0.2

If you have any issues or feedback, please visit issue section.
It is just the starting point, please feel free to create a pull request.

License

Material Showcase is available under the Apache license. See the LICENSE file for more info.

About

An elegant and beautiful showcase for iOS apps.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 92.6%
  • Ruby 4.2%
  • Objective-C 3.2%