@spectrum-web-components/banner - npm Package Compare versions

Comparing version 0.2.6 to 0.2.7-alpha.38

package.json

@@ -21,15 +21,24 @@ {
     ],
-    "version": "0.2.6",
+    "version": "0.2.7-alpha.38+3926abb2",
     "description": "",
-    "main": "lib/index.js",
-    "module": "lib/index.js",
+    "main": "src/index.js",
+    "module": "src/index.js",
     "type": "module",
+    "exports": {
+        "./src/": "./src/",
+        "./custom-elements.json": "./custom-elements.json",
+        "./package.json": "./package.json",
+        "./sp-banner": "./sp-banner.js",
+        "./sp-banner.js": "./sp-banner.js"
+    },
     "files": [
         "custom-elements.json",
-        "/lib/",
+        "*.d.ts",
+        "*.js",
+        "*.js.map",
         "/src/"
     ],
     "sideEffects": [
-        "./lib/index.js",
-        "./src/index.ts"
+        "./sp-banner.js",
+        "./sp-banner.ts"
     ],
@@ -41,6 +50,2 @@ "scripts": {
     "license": "Apache-2.0",
-    "peerDependencies": {
-        "lit-element": "^2.1.0",
-        "lit-html": "^1.0.0"
-    },
     "devDependencies": {
@@ -50,5 +55,7 @@ "@spectrum-css/banner": "^2.0.5"
     "dependencies": {
+        "lit-element": "^2.1.0",
+        "lit-html": "^1.0.0",
         "tslib": "^2.0.0"
     },
-    "gitHead": "16b57d15356859cee73278cdf796274e3245320b"
+    "gitHead": "3926abb2769a9bab28762bf3b3e1fab7c5f03589"
 }

README.md

 ## Description
 
-An **sp-banner** is an additional label an existing component may have. Banners cannot be interacted with. Banners in Spectrum have three variations for different uses as well as the ability to place it overlaid in the top-right corner of a container.
+An `<sp-banner>` is an additional label an existing component may have. Banners cannot be interacted with. Banners in Spectrum have three variations for different uses as well as the ability to place it overlaid in the top-right corner of a container.
 
-### Installation
+### Usge
 
@@ -11,9 +11,17 @@ [![See it on NPM!](https://img.shields.io/npm/v/@spectrum-web-components/banner?style=for-the-badge)](https://www.npmjs.com/package/@spectrum-web-components/banner)
 ```
-npm install @spectrum-web-components/banner
+yarn add @spectrum-web-components/banner
+```
 
-# or
+Import the side effectful registration of `<sp-banner>` via:
 
-yarn add @spectrum-web-components/banner
 ```
+import '@spectrum-web-components/banner/sp-banner.js';
+```
 
+When looking to leverage the `Banner` base class as a type and/or for extension purposes, do so via:
+
+```
+import { Banner } from '@spectrum-web-components/banner';
+```
+
 ## Example
@@ -41,13 +49,2 @@
 
-### Warning banners
-
-Banners intended to provided a warning with a brief description. Less severe than an error banner.
-
-```html
-<sp-banner type="warning">
-    <div slot="header">This is a warning banner</div>
-    <div slot="content">Be careful!</div>
-</sp-banner>
-```
-
 ### Error banners
@@ -72,3 +69,3 @@
 >
-    <sp-banner type="warning" corner>
+    <sp-banner corner>
         <div slot="header">This banner is in a corner</div>
@@ -75,0 +72,0 @@ <div slot="content">Neat!</div>

src/index.ts

@@ -12,15 +12,2 @@ /*
 */
-export * from './banner.js';
-
-import { Banner } from './banner.js';
-
-/* istanbul ignore else */
-if (!customElements.get('sp-banner')) {
-    customElements.define('sp-banner', Banner);
-}
-
-declare global {
-    interface HTMLElementTagNameMap {
-        'sp-banner': Banner;
-    }
-}
+export * from './Banner.js';

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 5 instances in 1 package

Fixed alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 4 instances in 1 package

Improved metrics

Number of package files

28

increased by3.7%

Worsened metrics

Total package byte prevSize

46477

decreased by-5.11%

Number of low license alerts

5

increased by25%

License quality

60

decreased by-25%

Lines of code

361

decreased by-10.64%

Number of lines in readme file

77

decreased by-3.75%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedlit-element@^2.1.0

• + Addedlit-html@^1.0.0