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

@wedgekit/info-button

v2.0.3

Published

## Purpose

Downloads

35

Readme

InfoButton

Purpose

The InfoButton component provides context to other components displayed on the page. Users can pass in descriptive paragraphs and even link to external documentation for further clarity.

When using an InfoButton in a form the user may wish to make the InfoButton function similar to a disabled component. It is recommended you pass in a tabIndex of -1 and style accordingly using the color prop.

Example

import InfoButon from '@wedgekit/info-button';

const App = () => {
  const info = {
    title: 'Branch ID',
    content:
      'Please enter your Branch ID here. If you do not know your Branch ID, please contact DMSi support',
    link: {
      label: 'Contact DMSi',
      url: 'https://www.dmsi.com/contact-us/',
    },
  };

  return <InfoButton info={info} />;
};

render(<App />);

Props

info

Required: ✅

Type: InfoObject

type InfoObject = {
  title: string;
  content?: string;
  icon?: IconTag;
  iconColor?: ColorTag;
  background?: ColorTag;
  link?: {
    url: string; // The href for the `<a>` element
    label: string; // The display text for the `<a>` element
  };
};

title

Required: ✅

Type: string

Descriptive text to give the user context, appears in the 'header' of the info dialog. For styling purposes, title is a styled <h3> tag.

content

Required: ❌

Type: string

Further descriptive text, appears in the 'body' of the info dialog. If no info.content is provided, the info dialog will not have a 'body'. For styling purposes, content is a styled <p> tag.

link

Required: ❌

type: { url: string, label: string }

The url and display text for an <a> element to link to more documentation. Appears in the footer of the info dialog. If no info.link is provided, the info dialog will not have a 'footer'.

icon

Type: IconTag

Required: ❌

Default: 'info'

Used to select a @wedgekit/icon.

iconColor

type: ColorTag

Required: ❌

Default: 'N600'

Color for the 'fill' of the Icon svg

background

type: ColorTag

Required: ❌

Default: 'N050'

Color for the background of the IconButton div

popoverClassName

Type: string

Required: ❌

Opens the consumed popover for styling purposes

tabIndex

Type: number

Required: ❌

Property used to really font keyboard users

onClick

type: (e) => void

Required: ❌

Optional callback that fires when the Info IconButton is clicked.

onExit

type: (e) => void

Required: ❌

Optional callback that fires when exiting the Info dialog