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

@nectary/components

v4.3.0

Published

Design System's framework-agnostic Component Library implementation.

Downloads

10,924

Readme

🐝 Nectary

Design System's framework-agnostic Component Library implementation.

Nectaries are specialized nectar-producing structures of the flower.

Bumblebees eat nectar and pollen made by flowers. The sugary nectar provides the bees with energy while the pollen provides them with protein.

Install

Add the component library dependency to package.json:

npm install @nectary/components
# or
yarn add @nectary/components

Usage

Registry

Nectary needs a custom elements registry to work with, even if it's a global default one:

import { setNectaryRegistry } from '@nectary/components/utils'

setNectaryRegistry(window.customElements)

// App

Or a custom one for the Shell/MFE use case, see mfe-helper-react as an example for more details:

import { setNectaryRegistry } from '@nectary/components/utils'

const customRegistry = new CustomElementRegistry();

setNectaryRegistry(customRegistry)

// ShadowRoot wrapper

Theme

import '@nectary/theme-base'

Use color palette or custom font face:

span {
  color: var(--sinch-color-honey-700);
}

h2 {
  font: var(--sinch-font-title-l);
}

Components

Import component:

import '@nectary/components/button'

Use it in React/Vue/Angular/etc, for example:

<sinch-button value="Click me" onClick={() => console.log('click')}></sinch-button>

⚠️ Note that it's not allowed to self-close custom element tags.

Testing

If you are testing your application using Nectary components with Jest, you might run into some problems, as it does not work out of the box. Here are the common pitfalls and their solutions.

Example configuration

jest.config.js

/** @type {import("ts-jest/dist/types").InitialOptionsTsJest} */
module.exports = {
    preset: "ts-jest",
    testEnvironment: "jsdom",
    moduleNameMapper: {
        "\\.(css)$": "identity-obj-proxy"
    },
    transform: {
        "^.+\\.(ts|tsx)?$": "ts-jest",
        "^.+\\.(js|jsx)$": "babel-jest"
    },
    transformIgnorePatterns: [
        "node_modules/(?!@nectary)"
    ]
}

babel.config.js

module.exports = {presets: ['@babel/preset-env']}

CSS

If you already have a babel loader for CSS, you might not need this part. If you do not, you can use identity-obj-proxy to mock your CSS imports:

npm install identity-obj-proxy
# or
yarn add identity-obj-proxy

Then add this part to your jest.config.js file:

    moduleNameMapper: {
        "\\.(css)$": "identity-obj-proxy"
    },

It lets Jest know how to mock the css imports in your codebase, like for example when you import the theme:

import '@nectary/theme-base'

This import should not throw an error now.

JS and TS

You are going to need to install babel-jest if it is not already done:

npm install babel-jest
# or
yarn add babel-jest

Then add this lines to your jest.config.js file:

    transform: {
        "^.+\\.(ts|tsx)?$": "ts-jest", // if you are using Typescript and ts-jest
        "^.+\\.(js|jsx)$": "babel-jest"
    },
    transformIgnorePatterns: [
        "node_modules/(?!@nectary)"
    ]

It is necessary to export the env preset in the babel.js.config file:

module.exports = {presets: ['@babel/preset-env']}

If you import any component:

import '@nectary/components/input'

It should not throw the error:

Jest encountered an unexpected token