ngx-outside-click-handler
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    NGX Outside Click Handler

    Dependency Status npm

    NPM NPM

    Build Status Coverage Status npm bundle size (minified + gzip) npm

    ngx-outside-click-handler in action

    Angular module to detect page events outside your wrapped component. Flexible and easy, how it should be ⇢

    Why a module to handle click outside the element?

    The idea of this component is make the process flexible, transparent and easier. So the main point is integrate this component with other components, such as:

    • Slide menu;
    • Modals elements in the page;
    • Wizards;
    • Anything else. Use your imagination 😉

    It's totally transparent for you and you can integrate easier in your application, improving your user experience 🎉

    Demo

    Try out our demo on Stackblitz!

    Install

    You can get it on NPM installing ngx-outside-click-handler module as a project dependency.

    npm install ngx-outside-click-handler --save

    Setup

    You'll need to add NgxOutsideClickHandlerModule to your application module. So that, the <ngx-outside-click-handler> components will be accessible in your application.

    @NgModule({
      declarations: [
        YourAppComponent
      ],
      imports: [
        NgxOutsideClickHandlerModule,
        ...
      ],
      providers: [],
      bootstrap: [YourAppComponent]
    })
     
    export class YourAppComponent {}
     

    After that, you can use the component in your templates, passing the configuration data into the component itself.

    • ngx-outside-click-handler: Handle the user clicks when it clicks outside your wrapped component;
    <div class="item">
      <ngx-outside-click-handler
        [disabled]="disabled"
        [outsideClickHandler]="outsideClickHandler"
        [listenTo]="on"
      >
        <div><p>Content goes here</p></div>
      </ngx-outside-click-handler>
    </div>

    Development

    Run demo locally

    1. This project uses Angular CLI as base. That means you just need to run npm start and access the link http://localhost:4200 in your browser

    Run tests

    1. Run npm test for run tests. In case you want to test using watch, please use npm run tdd

    Publish

    this project is using np package to publish, which makes things straightforward. EX: np <patch|minor|major> --contents=dist/ngx-outside-click-handler

    For more details, please check np package on npmjs.com

    Contribute

    For any type of contribution, please follow the instructions in CONTRIBUTING.md and read CODE_OF_CONDUCT.md files.

    Author

    Wilson Mendes (willmendesneto)

    Install

    npm i ngx-outside-click-handler

    DownloadsWeekly Downloads

    2

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    79.3 kB

    Total Files

    26

    Last publish

    Collaborators

    • willmendesneto