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

@salesforce-ux/wes-badge

v0.1.4

Published

A badge is a read only element used to label content.

Downloads

13

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

salesforce-uxsalesforce-ux

Keywords

Readme

@salesforce-ux/wes-badge

npm (custom registry)

About

A badge is a read-only element used to label content. Use badges to help tag data or copy to show it belongs in a certain category or has a certain status.

Getting Started

Let's start by installing wes-badge as a dependency of your project with npm.

npm i @salesforce-ux/wes-badge

Distributable

After installation, all the distributables for the wes-badge are found under /node_modules/@salesforce-ux/wes-badge/dist/ folder.

|File Name |Description | |- |- | |badge.css |The CSS file specific to wes-badge only. It doesnot include the styles for it's parent sds-badge. wes-badge extends from sds-badge| |badge.compiled.css |The Compiled CSS file for wes-badge.This file includes styles for both wes-badge and its parent sds-badge. This file is useful for LWC applications.(see below →)| |badge.js |The bundled JS file for wes-badge component. This file is useful for Non LWC applications.(see below →)|

wes-badge Integration

For the sake of understanding, we have categorized the development environment into LWC and Non LWC application. If you are using the Salesforce Experience Cloud platform, WES is supported through an Unlocked Package, see the Confluence page for the WES Unlocked Package.

This Guide covers the integration approach for these two types of application.

For Lightning Web Component(LWC) Application

Dependency Inclusion

wes-styling-hooks is a styling dependency for wes-badge. Hence, this needs to be embedded into the root of the web app in order to make the wes-badge render properly.

<html>
  <head>
    <link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css">
    <!-- Your application's other stylesheets go below -->
    <link rel="stylesheet" href="...">
  </head>
  <body>
    <!-- Your application -->
  </body>
</html>

There are also other ways wes-styling-hooks can be embedded. Please checkout the wes-styling-hooks Integration Guide to learn more.

Component CSS Import

/* myComponent.css */
@import "@salesforce-ux/wes-badge/dist/badge.compiled.css";

HTML Decoration

After that,the HTML of your LWC component template needs to be decorated to have all the named part attributes as per the component's specification. Below is a reference to the component's structure.

<wes-badge>
  <span part="badge">
    <slot name="start"></slot>
    Label
    <slot name="end"></slot>
  </span>
</wes-badge>

For Non LWC Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import WESBadge from "@salesforce-ux/wes-badge/dist/badge";

Component Registration

/* myComponent.js */
customElements.define('wes-badge', WESBadge);

Example

Below is one approach to integrate your wes-badge component.

Script
/* myComponent.js */
import "@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css";
import WESBadge from "@salesforce-ux/wes-badge/dist/badge";
window.customElements.define('wes-badge', WESBadge);
HTML
<wes-badge> Badge </wes-badge>

Interactive Demo

To see more examples with interactive demo, please visit WES Subsytem's Storybook Environment