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

@yext/custom-field-debugger

v2.1.6

Published

Custom Field Debugger works on Yext pages to markup and highlight HTML elements which use data from Yext Knowledge Graph

Downloads

3,484

Readme

Custom Field Debugger

Custom Field Debugger works on Yext pages to markup and highlight HTML elements which use data from Yext Knowledge Graph

Usage

On a Yext pages site, install the NPM package:

npm install @yext/custom-field-debugger@latest

Then, use the React component, for example:

// src/layouts/main.tsx

import { CustomFieldDebuggerReactProvider } from '@yext/custom-field-debugger';

...

const Main = (props) => {
  return (
    <CustomFieldDebuggerReactProvider pageProps={props} component={MainInternal}>
      <MainInternal />
    </CustomFieldDebuggerReactProvider>
  )
}

const MainInternal = (props) => {
  return (
    // Template to render page here
  )
}

On the page rendered with this template, you can add the URL parameter yextCFDebug=true to enable the Custom Field Debugger.

Development

  1. Make some changes to the repo.
  2. Add "@yext/custom-field-debugger": "file:../custom-field-debugger", to package.json to load your changes locally into a repo for testing.
  3. npm run release in this repo to build the TS files, and generate the TS types
  4. npm install in the testing repo to fetch the newly built files

Deployment

  1. Make & commit changes - don't forget to increment the version number
  2. npm run relase to compile TS to JS, and generate TS types
  3. npm publish to update the package on npmjs

Common issues (?)

  • The version of react and react-dom in this repo must match that of the pages repo this package is used in