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 🙏

© 2022 – Pkg Stats / Ryan Hefner

@guardian/braze-components

v7.4.0

Published

React components to render messages from Braze

Downloads

5,865

Readme

Braze Components

A library of React components for displaying Braze messages on DCR and frontend.

Braze messages are exposed in two ways to address two separate use cases.

  1. One-shot messages
  2. Persistent notifications

One-shot messages use Braze's in-app messages to show a user a single message impression. This is analagous to an ad impression. As with ads, these messages are often competing with other systems for shared message slots on the page. These messages are exposed by the BrazeMessages class.

Persistent notifications are backed by Braze content cards. These notifications persist until they are dismissed (automatically or by the user), or they expire. Notifications from different sources can peacfully co-exist. These notifications are exposed by the BrazeCards class.

Development

Local Setup

$ bin/setup

Storybook

We use Storybook when building components. Run Storybook with:

$ yarn storybook

The Grid image picker integration in Storybook requires auth. If necessary you'll be redirected to the gutools login service. When developing, this means running the login service locally. Often when developing you won't need to use the image picker. In this case you can skip auth entirely by running Storybook like this:

$ STORYBOOK_DISABLE_AUTH=true yarn storybook

This means you won't need to run the login service locally.

Point a project to your local version of @guardian/braze-components

Use yarn link to develop against a locally checked out version of this library:

In your local checkout of @guardian/braze-components:

$ yarn link

And then in the project consuming the client (e.g. DCR/frontend):

$ yarn link "@guardian/braze-components"

To revert back to using the published version of the package:

$ yarn unlink "@guardian/braze-components"
$ yarn install --force

NOTE:

  • Ensure you build this library before adding it locally to your project, by running yarn build. You can also use yarn watch to build automatically when the source code is changed.

  • The external project (e.g. DCR/frontend) may not be set up to watch changes from linked modules. Removing: ignored: /node_modules/, from watchOptions in frontend will enable make watch (in frontend) to also track changes to braze-components.

Publishing to NPM

You'll need to be part of the @guardian NPM org. Ask someone to add you if you're not already.

$ yarn release

This will:

  • Build the package
  • Interactively ask for a new version number (and create a commit for the version change in package.json)
  • Publish the new release to NPM
  • Push new commits/tags to GitHub

CI/CD

Whenever you push to GitHub actions will be triggered to run Jest tests, the TypeScript compiler etc. A TeamCity build will also be triggered. On the main branch if the TeamCity build is successful Riff Raff will deploy Storybook to https://braze-components.gutools.co.uk.