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-foundation

v0.1.1

Published

A set of foundations supporting the WES Design System at Salesforce.

Downloads

181

Vulnerabilities

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

Links

Maintainers

salesforce-uxsalesforce-ux

Keywords

Readme

@salesforce-ux/wes-foundation

npm (custom registry)

About

A set of foundations supporting the WES Subsystem at Salesforce. wes-foundation package contains the foundational styles which includes Typography, Font Face, Utilities

Getting Started

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

npm i @salesforce-ux/wes-foundation

Distributable

After installation, all the distributables for the WES Foundation are found under @salesforce-ux/wes-foundation/dist/ folder. |File Name |Description | |- |- | |index.css | The Compiled CSS file for wes-foundation package|

wes-foundation Integration

Dependency Inclusion

wes-styling-hooks is a styling dependency for wes-foundation. Hence, this needs to be embedded into your web app in order to make the wes-foundation work properly.

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

Add wes-foundation

There are different ways to include wes-foundation to a web application depending on the requirement. 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. It can be used in both light DOM and shadow DOM. Below are the styles to include the package -

Add WES Foundation in HTML

You can use the HTML <link> to link to WES Foundation as an external resource.

<html>
  <head>
    <!-- Dependencies go here -->
    <link rel="stylesheet" href="...">
    
    <link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-foundation/dist/index.css">
    <!-- Your application's stylesheets go below -->
    <link rel="stylesheet" href="...">
  </head>
  <body>
    <!-- Your application -->
  </body>
</html>

Add WES Foundation in CSS

You can use CSS @imports to pull in WES Foundation.

@import "@salesforce-ux/wes-foundation/dist/index.css";

Add WES Foundation in JS

You can use JS import to pull in WES Foundation directly in the JS file.

import "@salesforce-ux/wes-foundation/dist/index.css";

Example

Below are a few examples of Typography which is part of wes-foundation

HTML

<html>
  <head>
    <link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css">
    <link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-foundation/dist/index.css">
    <!-- Your application's stylesheets go below -->
    <link rel="stylesheet" href="...">
  </head>
  <body>
    <h1 type-style="display-1">Title display-1</h1>
    <div type-style="body-1"><p type-style="code">Text body-1 code</p></div>
  </body>
</html>

Interactive Demo

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