Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ak-blanket

Package Overview
Dependencies
Maintainers
1
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ak-blanket

ak-blanket webcomponent

  • 3.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
14
increased by7.69%
Maintainers
1
Weekly downloads
 
Created
Source

Blanket

Setup and install

npm install ak-blanket

Using the component

HTML

The ak-blanket package exports the Blanket Skate component.

Import the component in your JS resource:

bundle.js
import 'ak-blanket';

Now we can use the defined tag in our HTML markup, e.g.:

index.html
<html>
<head>
  <script src="bundle.js"></script>
</head>
<body>
  <!-- ... -->
  <ak-blanket></ak-blanket>
</body>
with other components

The main purpose of the blanket component is to provide the overlay layer for components such as modal dialog or tooltip. It can be achieved like this:

define('modal-dialog-component', () => {
 attached(elem) {
   window.addEventListener('activate', doSomethingWhenBlanketClicked(elem));
 },
 detached(elem) {
   window.removeEventListener('activate', doSomethingWhenBlanketClicked(elem));
 },
 render(elem) {
   return (
     <div>
       <ak-blanket clickable tinted />
       <div>the rest of the awesome component here</div>
     </div>
   );
 })

It emits the 'activate' event when clicked/touched. Blanket component doesn't have the z-index style, so make sure you put it into an appropriate DOM position. For the purpose of simplicity blanket doesn't have any show/hide functionality. Since the main use of it suppose to be inside popup elements it would appear/disapper with the parent element.

React

import Blanket from 'ak-blanket';
import reactify from 'skatejs-react-integration';

const ReactComponent = reactify(Blanket, {});

ReactDOM.render(<ReactComponent />, container);

Blanket API

Constructor

Create instances of the component programmatically, or using markup.

JS Example

import Blanket from 'ak-blanket';
const component = new Blanket();

blanket.tinted : Boolean

Is blanket grey with opacity or transparent. By default it's transparent.

Kind: instance property of Blanket
Default: false
HTML Example

<ak-blanket tinted></ak-blanket>

JS Example

component.tinted = true

blanket.clickable : Boolean

If click on the blanket emits a 'blanket-click' event.

Kind: instance property of Blanket
Default: false
HTML Example

<ak-blanket clickable></ak-blanket>

JS Example

component.clickable = true

FAQs

Package last updated on 01 Sep 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc