{"_id":"@blackpixel/framer-remotelayer","_rev":"2-bdca324263322d848e90ee8a2f5d149a","name":"@blackpixel/framer-remotelayer","description":"A Framer module for creating an interactive Apple TV remote for tvOS prototypes.","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@blackpixel/framer-remotelayer","version":"2.0.0","description":"A Framer module for creating an interactive Apple TV remote for tvOS prototypes.","homepage":"https://github.com/bpxl-labs/RemoteLayer","repository":{"type":"git","url":"git://github.com/bpxl-labs/RemoteLayer.git"},"bugs":{"url":"https://github.com/bpxl-labs/RemoteLayer/issues"},"main":"RemoteLayer.coffee","author":{"name":"Black Pixel"},"license":"MIT","keywords":["appletv","framerjs","framer","coffeescript","remote","control"],"publishConfig":{"access":"public"},"dependencies":{"coffeeify":"^2.1.0"},"browserify":{"transform":["coffeeify"]},"gitHead":"5b4decb6204453e6eeb71afce5cc4beeb8e0bee4","_id":"@blackpixel/framer-remotelayer@2.0.0","_npmVersion":"5.4.2","_nodeVersion":"8.5.0","_npmUser":{"name":"iconmaster","email":"john@blackpixel.com"},"dist":{"integrity":"sha512-JfutV6dqcGGiqQW/31+r4y7YaIcORHBV0NT1nWVmTFliROEaYONgo538geShNIrxPbqZeP8QHpi5AlBIV5uc4g==","shasum":"0105f25bb9140bf482fbd2eaec367c855531e7c3","tarball":"https://registry.npmjs.org/@blackpixel/framer-remotelayer/-/framer-remotelayer-2.0.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDH3+Ze2OJ5QcJyDt/+Al47fuZhKfYwUJV2XbxSftWZvgIhAOMUxEFLM0CVXzq9wpnG6TxI8cBobtRKpukAHzcE5jRQ"}]},"maintainers":[{"name":"iconmaster","email":"john@blackpixel.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/framer-remotelayer-2.0.0.tgz_1507925245865_0.14598440728150308"}}},"readme":"# RemoteLayer Framer Module\n\n[![license](https://img.shields.io/github/license/bpxl-labs/RemoteLayer.svg)](https://opensource.org/licenses/MIT)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](.github/CONTRIBUTING.md)\n[![Maintenance](https://img.shields.io/maintenance/yes/2017.svg)]()\n\nThe RemoteLayer module allows you to instantly generate an interactive Apple TV remote for your tvOS app prototypes. You can choose your preferred styling, alignment, animation and button highlight color. All buttons (and swipes on the touchpad) can be configured to perform your own supplied actions.\n\n<img src=\"https://cloud.githubusercontent.com/assets/935/16821270/e57262d6-491a-11e6-82ee-e1db13fe6522.png\" width=\"497\" style=\"display: block; margin: auto\" alt=\"RemoteLayer preview\" />\n\n### Installation\n\n#### NPM Installation\n\n```\n$ cd /your/framer/project\n$ npm i @blackpixel/framer-remotelayer\n```\n\n#### Manual Installation\n\nCopy / save the `RemoteLayer.coffee` file into your project's `modules` folder.\n\n### Adding It To Your Project\n\nIn your Framer project add the following:\n\n```javascript\n// If you manually installed\nRemoteLayer = require 'RemoteLayer'\n// Else\nRemoteLayer = require '@blackpixel/framer-remotelayer'\n\nmyRemote = new RemoteLayer\n```\n\n### Assigning Actions to Buttons\n\n```coffeescript\nmyRemote = new RemoteLayer\n\tmenuAction: -> <action>\n\thomeAction: -> <action>\n\tmicAction: -> <action>\n\tplayPauseAction: -> <action>\n\tvolumeUpAction: -> <action>\n\tvolumeDownAction: -> <action>\n\tclickAction: -> <action>\n\tswipeUpAction: -> <action>\n\tswipeDownAction: -> <action>\n\tswipeLeftAction: -> <action>\n\tswipeRightAction: -> <action>\n```\n\n### API\n\n#### `new RemoteLayer`\n\nInstantiates a new instance of RemoteLayer.\n\n**Available options**\n\n```coffeescript\nmyRemote = new RemoteLayer\n\talign: <string> (\"left\" || \"center\" || \"right\")\n\tmargin: <number>\n\tfromBottom: <number>\n\tgloss: <boolean>\n\ttransition: <string> (\"fade\" || \"pop\")\n\thide: <boolean>\n\tautoHide: <boolean>\n\thighlightColor: <string> (hex or rgba)\n```\n\n_Setting `autoHide` implicitly sets `hide` to true._\n\n**Returns**\n\n`Layer` _(Object)_: A newly instantiated Framer Layer.\n\n#### `myRemote.show()`\n\nShow the RemoteLayer instance.\n\n#### `myRemote.hide()`\n\nHide the RemoteLayer instance.\n\n#### `myRemote.align(align, margin, fromBottom)`\n\nUseful if you wish to change the remote location some time after initialization.\n\n**Arguments**\n\n1. `align` _(String)_: One of (\"left\" || \"center\" || \"right\")\n2. `margin` _(Number)_: Layer margin value\n3. `fromBottom` _(Number)_: Distance from bottom of screen\n\n#### `myRemote.hidden`\n\n> readonly\n\n**Returns**\n\n_(Boolean)_: Whether or not the RemoteLayer is currently hidden\n\n---\n\nWebsite: [blackpixel.com](https://blackpixel.com) &nbsp;&middot;&nbsp;\nGitHub: [@bpxl-labs](https://github.com/bpxl-labs/) &nbsp;&middot;&nbsp;\nTwitter: [@blackpixel](https://twitter.com/blackpixel) &nbsp;&middot;&nbsp;\nMedium: [@bpxl-craft](https://medium.com/bpxl-craft)\n","maintainers":[{"email":"john@blackpixel.com","name":"iconmaster"},{"email":"hello@jaden.io","name":"jadnco"},{"email":"hernancalabrese@gmail.com","name":"hernanc"},{"email":"brandonpierce91@gmail.com","name":"brandonjpierce"},{"email":"brad@blackpixel.com","name":"bpxl-labs"}],"time":{"modified":"2022-04-04T19:21:58.193Z","created":"2017-10-13T20:07:26.808Z","2.0.0":"2017-10-13T20:07:26.808Z"},"homepage":"https://github.com/bpxl-labs/RemoteLayer","keywords":["appletv","framerjs","framer","coffeescript","remote","control"],"repository":{"type":"git","url":"git://github.com/bpxl-labs/RemoteLayer.git"},"author":{"name":"Black Pixel"},"bugs":{"url":"https://github.com/bpxl-labs/RemoteLayer/issues"},"license":"MIT","readmeFilename":"README.md"}