@blackpixel/framer-statusbarlayer
v2.1.0
Published
Instantly generate an accurate status bar for your iPhone and iPad app prototypes.
Downloads
7
Readme
StatusBarLayer Framer Module
The StatusBarLayer module allows you to instantly generate an accurate status bar for your iPhone and iPad app prototypes. Appearance and status items are customizable, and the module will mimic iOS orientation-switch behavior according to device type. Events that affect the status bar, such as calls, may also be simulated.
Installation
NPM Installation
$ cd /your/framer/project
$ npm i @blackpixel/framer-statusbarlayer
Manual installation
Copy or save the StatusBarLayer.coffee
file into your project's modules
folder.
Adding It to Your Project
In your Framer project, add the following:
StatusBarLayer = require "StatusBarLayer"
API
new StatusBarLayer
Instantiates a new instance of StatusBarLayer.
Available options
myStatusBar = new StatusBarLayer
# iOS version
version: <number> (10 || 11)
# Text
carrier: <string>
time: <string> # if not set, will use local time
percent: <number>
# Show or hide status items
signal: <boolean>
wifi: <boolean>
powered: <boolean>
showPercentage: <boolean>
ipod: <boolean> # also affects signal and carrier
# Colors
style: <string> ("light" || "dark")
foregroundColor: <string> (hex or rgba)
backgroundColor: <string> (hex or rgba)
vibrant: <boolean>
# Behavior
hide: <boolean> # initial visibility
autoHide: <boolean> # hide in landscape where device-appropriate
Simulate call
myStatusBar.startCall(message, color) # <string>, <string> (hex or rgba)
myStatusBar.endCall()
Show and hide
myStatusBar.show()
myStatusBar.hide()
Check visibility and call status
print myStatusBar.hidden
print myStatusBar.onCall
Website: blackpixel.com · GitHub: @bpxl-labs · Twitter: @blackpixel · Medium: @bpxl-craft