PolymerLabs/pwa-helpers

Name: pwa-helpers

Owner: polymer

Owner: PolymerLabs

Description: Small helper methods or mixins to help build a PWA

Created: 2018-01-16 23:23:50.0

Updated: 2018-03-27 20:01:55.0

Pushed: 2018-03-27 19:28:11.0

Homepage:

Size: 41

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

pwa-helpers

Small helper methods or mixins to help build a PWA, and reduce the boilerplate you might have to write. There are many different ways in which you could write these helpers; use these if you want a simple starting point.

Basic helpers

These are vanilla JavaScript methods that can be used regardless of which frameworks or libraries your application is written in.

router.js

This is a basic router that calls a callback whenever the location is updated.

Example (in your top level element or document):

rt { installRouter } from '../node_modules/pwa-helpers/router.js';

allRouter((location) => console.log(location));

network.js

This is a utility method that calls a callback whenever the network connectivity of the app changes.

Example (in your top level element or document):

rt { installOfflineWatcher } from '../node_modules/pwa-helpers/network.js';

allOfflineWatcher((offline) => {
nsole.log(offline ? ' offline' : 'online');

metadata.js

This is a utility method that updates the page's open graph and Twitter card metadata.

Example (in your top level element or document, or in the router callback):

rt { updateMetadata } from '../node_modules/pwa-helpers/metadata.js';

teMetadata({
title: 'My App - view 1',
description: 'This is my sample app',
url: document.location.href,
image: '/assets/view1-hero.png'

media-query.js

Utility method that calls a callback whenever a media-query matches in response to the viewport size changing.

Example:

rt { installMediaQueryWatcher } from '../node_modules/pwa-helpers/media-query.js';

allMediaQueryWatcher(`(min-width: 600px)`, (matches) => {
nsole.log(matches ? 'wide screen' : 'narrow sreen');

Test helpers

Utility methods to be used inside of testing frameworks, to reduce some testing boilerplate.

axe-report.js

This is an axe-core reporter that returns an Error containing every a11y violation for an element. Use this if you want to include axe-core in automated Mocha tests, etc.

Example (in a Mocha test):

rt '../node_modules/axe-core/axe.min.js';
rt { axeReport } from '../node_modules/pwa-helpers/axe-report.js';

ribe('button', function() {
('is accessible', function() {
const button = document.createElement('button');
button.textContent = 'click this';  // Test should fail without this line.
return axeReport(button);
;

Redux helpers

These utility methods are useful if your application is using Redux for state management.

connect-mixin.js

This is a JavaScript mixin that you can add to a Custom Element base class to automatically connect to a Redux store. It requires you to implement a _stateChanged method, which is called every time the store state is updated.

Example (in an element):

rt { connect } from '../node_modules/pwa-helpers/connect-mixin.js';

s MyElement extends connect(store)(HTMLElement) {
 ...

tateChanged(state) {
this.count = state.data.count;

lazy-reducer-enhancer.js

A Redux store enhancer that lets you lazy-install reducers after the store has booted up. Use this if your application lazy-loads routes that are connected to a Redux store.

Example (in your store code):

rt lazyReducerEnhancer from '../node_modules/pwa-helpers/lazy-reducer-enhancer.js';
rt someReducer from './reducers/someReducer.js';

rt const store = createStore(
tate, action) => state,
mpose(lazyReducerEnhancer(combineReducers), applyMiddleware(thunk))

n initial, lazy-loaded reducer. Use this for any other lazy reducers in elements as well.
e.addReducers({
meReducer