ng2-mmbreakpoints v1.0.0

ng2-mmbreakpoints

ng2-mmbreakpoints is a service using the window.matchMedia method to listen to breakpoints.

It's largely inspired by the angular-breakpoints package, but differs in that it uses the matchMedia method to track breakpoints.

The matchMedia listeners are then wrapped in an RxJS Observable for Angular2+ usage.

Installation

npm

npm install ng2-mmbreakpoints --save

How to use

First you need to import the provideMatchmediaService function and expose it in the providers array (or in bootstrap).

import { MatchmediaService, provideMatchmediaService } from 'ng2-mmbreakpoints';

@Component({
    // ...
    providers: [provideMatchmediaService()]  
    // ...
})
export class YourComponent {

    constructor (private matchmediaService: MatchmediaService) {
        this.matchmediaService.matchmediaChanges.subscribe((ev) => {
            console.log(ev);
        });
    }
}

The matchmediaChanges property is an instance of an RxJS Observable. It returns a collection of MediaQueryListEvents for every query that is defined in breakpoints object

Customize breakpoints

The defaults breakpoints are the Twitter Bootstrap breakpoints.

const defaultBreakpoints: BreakpointConfig = {
    xs: '(max-width: 767px)',
    sm: '(min-width: 768px) and (max-width: 991px)',
    md: '(min-width: 992px) and (max-width: 1199px)',
    lg: '(min-width: 1200px)'
};

You can customize the breakpoints by passing a object using the BreakpointConfig interface in the provideMatchmediaService. Breakpoints are strings defined by css media queries and are being passed to matchMedia and therefore follow the same rules it uses.

const breakpointConfig: BreakpointConfig = {
    xss: '(max-width: 399px)',
    xs: '(min-width: 400px) and (max-width: 767px)',
    sm: '(min-width: 768px) and (max-width: 991px)',
    md: '(min-width: 992px) and (max-width: 1199px)',
    lgs: '(min-width: 1200px) and (max-width: 1499px)',
    lg: '(min-width: 1500px)'
}

// ...

providers: [breakpointsProvider(breakpointConfig)]

// ...

Subscribe/Unsubscribe

The service creates listeners for every media query in the config and adds them to the matchmediaChanges Observable when it is created. If you want to temporarily unsubscribe, call the unsubscribe method. If you want to resubscribe, call the subscribe method.

The Observable will also add/remove listeners as needed.

Wrapper Project

This service was updated for compatiblity with v6 of the Angular CLI and as such the primary ng2-mmbreakpoints library repo within github now contains an "wrapper" project which the library is contained within. The wrapper is contained within the 'src/app' directory and the library is within the 'projects/ng2-mmbreakpoints' directory. A sample useage as well as a few basic e2e tests are available from the wrapper app.