npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@grapes-agency/app-frame-messages

v1.6.2

Published

Utility library to simplify communication between apps and iframes.

Downloads

2

Readme

app-frame-messages

Utility library to simplify communication between apps and iframes.

Install

$ npm install --save @grapes-agency/app-frame-messages

Getting Started

import { startListening } from '@grapes-agency/app-frame-messages';

startListening({
  onSession: session => {
    console.log('Session received', session);
  }
});

or

<script src="https://unpkg.com/@grapes-agency/app-frame-messages"></script>

Handlers

We support the following handlers:

onSession: contains the user session

{
    profile: {
      name: 'Jon' // Profile name
    },
    lang: 'enUS', // Language
    searchValue: '' // Search value
    ...
}

Set handlers

If you don't want to set handlers on startListening, simply use setHandlers:

import { setHandlers } from '@grapes-agency/app-frame-messages';

setHandlers({
  onSession: session => {
    console.log('Session received', session);
  }
});

Unset handlers

You can unset handlers with unsetHandlers. It expect an array of the handler names.

import { unsetHandlers } from '@grapes-agency/app-frame-messages';

unsetHandlers(['onSession']);

Stop listening

If you want to unsubscribe, use stopListening.

import { stopListening } from '@grapes-agency/app-frame-messages';

stopListening();

Change parent source

Use openDetails to tell the parent to change the view. A common use case is, when this window displays an preview in a small window and requests a detail view a bigger window. The parent can change the size of the window and change the source.

import { openDetails } from '@grapes-agency/app-frame-messages';

openDetails('https://example.com/details');

Set breadcrumbs

Use setBreadcrumbs to tell the parent to change the breadcrumbs (for example when you go deeper in you pages). The methode expects and array of breadcrumb-elements. Every element in array can have maximum 1 children array which will be opened in a popup when you click on the specific element.

import { setBreadcrumbs } from '@grapes-agency/app-frame-messages';

const breadcrumbs = [
  {
    label: 'Home',
    url: '#'
  },
  {
    label: 'Level 2',
    url: '#',
    children: [
      {
        label: 'Children 2-1',
        url: '#'
      },
      {
        label: 'Children 2-2',
        url: '#'
      }
    ]
  },
  {
    label: 'Level 3',
    url: '#'
  }
];

setBreadcrumbs(breadcrumbs);

Check if the application is inside an iframe

You can call inIframe to find out if the application is within an iframe or not. This is useful, if you want to have different behaivours.

import { inIframe } from '@grapes-agency/app-frame-messages';

const isInIframe = inIframe();

Issues

parent/window is not defined

This module needs access to window and parent.window which is not available on server side. To prevent access issues, call startListening only on client side.

React example:

import React from 'react';
import { startListening } from '@grapes-agency/app-frame-messages';

class SomeComponent extends React.Component {
  state = {
    session: null
  };

  componentDidMount() {
    // componentDidMount is not called on server side
    startListening({
      onSession: this.handleSessionChange
    });
  }

  handleSessionChange = session => {
    this.setState({
      session
    });
  };

  render() {
    return <div>{JSON.stringify(this.state.session)}</div>;
  }
}