Code Monkey home page Code Monkey logo

lit-element-click-outside's Introduction

lit-element-click-outside

What is it?

lit-element-click-outside is a @clickOutside decorator that allows you to call component method as the user clicks outside of the host component. Obviously it's very easy. Why then import it as external library? First, because it does not make sense write this boilerplate code in each project. Second, because decorator solution is elegant and convenient.

Installing

In your Lit Element project, add lit-element-click-outside to your package.json:

npm i lit-element-click-outside

How to use it?

It's very simple: you just need to anotate your method with @clickOutside and it will be called when user clicks outside of component area.

import { LitElement, html, property, customElement } from 'lit-element';
import { clickOutside } from 'lit-element-click-outside';

@customElement('simple-greeting')
export class SimpleGreeting extends LitElement {
  @property() name = 'World';

  @clickOutside()
  someMethod() {
    console.log(
      "someMethod was called because user just clicked outside of SimpleGreeting"
    );
  }

  render() {
    return html`<p>Hello, ${this.name}!</p>`;
  }
}

Options

You may pass some optional parameters to decorator (or util function):

@clickOutside({
    exclude: 'button .exclude-click-outside-class'
})
Property name Type Default Description
triggerEvents string 'click' A comma-separated list of events to cause the trigger
exclude string A comma-separated string of DOM element queries to exclude when clicking outside of the element. Example: [exclude]="'button .btn-primary'".

lit-element-click-outside's People

Contributors

jarrvis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.