@warp-ds/elements 2.2.0-next.21 → 2.2.0-next.22

package/README.md

@@ -14,7 +14,7 @@ start by reviewing the [contributing guidelines](CONTRIBUTING.md).
 
 ### Installation
 
-Warp custom elements are supplied by the Eik CDN. 
+Warp custom elements are supplied by the Eik CDN.
 In addition, you can install the `@warp-ds/elements` package to get intellisense
 in your editor.
 
@@ -138,34 +138,19 @@ Add `@warp-ds/elements` to tsconfig types in compilerOptions.
 
 #### Visual Studio Code
 
-This module includes [Custom HTML and CSS data for Visual Studio Code](https://code.visualstudio.com/blogs/2020/02/24/custom-data-format).
+Install the [Web Components Language Server](https://wc-toolkit.com/integrations/web-components-language-server/) extension. The extension automatically picks up the [Custom Element Manifest](https://wc-toolkit.com/getting-started/) that we ship with `@warp-ds/elements`.
 
 ##### Using Warp Elements in a plain HTML page
 
-When developing, install Warp Elements locally using npm
+Install Warp Elements locally using npm:
 
 ```
 npm install @warp-ds/elements
 ```
 
-Add the following snippet to settings.json in vscode to tell it about Warp components
+Install the [Web Components Language Server](https://wc-toolkit.com/integrations/web-components-language-server/) extension.
 
-.vscode/settings.json
-
-```json
-{
-  "html.customData": [
-    "./node_modules/@warp-ds/elements/dist/vscode.html-custom-data.json"
-  ],
-  "css.customData": [
-    "./node_modules/@warp-ds/elements/dist/vscode.css-custom-data.json"
-  ]
-}
-```
-
-restart vscode
-
-Now, inside any .html files, you will get intellisense when using Warp Elements
+Now, inside any `.html` files, you will get IntelliSense when using Warp Elements:
 
 ```html
 <w-button variant=""><w-button>
@@ -177,28 +162,15 @@ IntelliSense in JavaScript strings is not supported without additional plugins a
 
 ##### Using Warp Elements in Lit html tagged template literals
 
-When developing, install Warp Elements locally using npm
+Install Warp Elements locally using npm:
 
 ```
 npm install @warp-ds/elements
 ```
 
-Add the following snippet to settings.json in vscode to tell it about Warp components
+Install the [Web Components Language Server](https://wc-toolkit.com/integrations/web-components-language-server/) extension.
 
-.vscode/settings.json
-
-```json
-{
-  "html.customData": [
-    "./node_modules/@warp-ds/elements/dist/vscode.html-custom-data.json"
-  ],
-  "css.customData": [
-    "./node_modules/@warp-ds/elements/dist/vscode.css-custom-data.json"
-  ]
-}
-```
-
-Install the lit-plugin vscode extension and restart vscode
+Install the [lit-plugin](https://marketplace.visualstudio.com/items?itemName=runem.lit-plugin) extension.
 
 Now, inside any html`` tagged template literals, you will get intellisense when using Warp Elements.
 
@@ -222,7 +194,7 @@ Now, inside your react components, you will get intellisense when using Warp Ele
 
 React 18 and earlier do not support custom elements.
 
-If you are on React 18 or early, we strongly urge you to please consider upgrading to React v19. 
+If you are on React 18 or early, we strongly urge you to please consider upgrading to React v19.
 
 If you cannot upgrade right away, Warp supplies custom element wrappers to add backwards compatibility. Use them like so:
 
@@ -244,6 +216,23 @@ and use the component
 
 you should get intellisense when using Warp Elements.
 
+#### CustomData fallback
+
+`@warp-ds/elements` also includes [Custom HTML and CSS data for Visual Studio Code](https://code.visualstudio.com/blogs/2020/02/24/custom-data-format).
+
+If you can't get the Web Components Language Server to work, add the following snippet to `.vscode/settings.json`, then restart VS Code.
+
+```json
+{
+  "html.customData": [
+    "./node_modules/@warp-ds/elements/dist/vscode.html-custom-data.json"
+  ],
+  "css.customData": [
+    "./node_modules/@warp-ds/elements/dist/vscode.css-custom-data.json"
+  ]
+}
+```
+
 #### JetBrains products
 
 We ship `web-types.json` which should get picked up automatically by JetBrains IDEA and similar products.

package/dist/custom-elements.json

@@ -2,107 +2,6 @@
   "schemaVersion": "1.0.0",
   "readme": "",
   "modules": [
-    {
-      "kind": "javascript-module",
-      "path": "packages/alert/index.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "Alert is an inline component used for displaying different types of messages.\n\nFor accessibility reasons, alert should appear close to the element that triggered it.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)",
-          "name": "WarpAlert",
-          "members": [
-            {
-              "kind": "field",
-              "name": "variant",
-              "type": {
-                "text": "AlertVariants"
-              },
-              "default": "'info'",
-              "attribute": "variant",
-              "reflects": true,
-              "parsedType": {
-                "text": "'negative' | 'positive' | 'warning' | 'info'"
-              }
-            },
-            {
-              "kind": "field",
-              "name": "show",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "attribute": "show",
-              "reflects": true
-            },
-            {
-              "kind": "field",
-              "name": "role",
-              "type": {
-                "text": "string"
-              },
-              "default": "'alert'",
-              "attribute": "role",
-              "reflects": true
-            }
-          ],
-          "attributes": [
-            {
-              "name": "variant",
-              "type": {
-                "text": "AlertVariants"
-              },
-              "default": "'info'",
-              "fieldName": "variant",
-              "parsedType": {
-                "text": "'negative' | 'positive' | 'warning' | 'info'"
-              }
-            },
-            {
-              "name": "show",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "fieldName": "show"
-            },
-            {
-              "name": "role",
-              "type": {
-                "text": "string"
-              },
-              "default": "'alert'",
-              "fieldName": "role"
-            }
-          ],
-          "superclass": {
-            "name": "LitElement",
-            "package": "lit"
-          },
-          "tagName": "w-alert",
-          "customElement": true,
-          "modulePath": "packages/alert/index.ts",
-          "definitionPath": "packages/alert/index.ts"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "custom-element-definition",
-          "name": "w-alert",
-          "declaration": {
-            "name": "WarpAlert",
-            "module": "packages/alert/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "WarpAlert",
-          "declaration": {
-            "name": "WarpAlert",
-            "module": "packages/alert/index.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "packages/affix/index.ts",
@@ -244,6 +143,107 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "packages/alert/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Alert is an inline component used for displaying different types of messages.\n\nFor accessibility reasons, alert should appear close to the element that triggered it.\n\n[See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)",
+          "name": "WarpAlert",
+          "members": [
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "AlertVariants"
+              },
+              "default": "'info'",
+              "attribute": "variant",
+              "reflects": true,
+              "parsedType": {
+                "text": "'negative' | 'positive' | 'warning' | 'info'"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "show",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "attribute": "show",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "role",
+              "type": {
+                "text": "string"
+              },
+              "default": "'alert'",
+              "attribute": "role",
+              "reflects": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "variant",
+              "type": {
+                "text": "AlertVariants"
+              },
+              "default": "'info'",
+              "fieldName": "variant",
+              "parsedType": {
+                "text": "'negative' | 'positive' | 'warning' | 'info'"
+              }
+            },
+            {
+              "name": "show",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "show"
+            },
+            {
+              "name": "role",
+              "type": {
+                "text": "string"
+              },
+              "default": "'alert'",
+              "fieldName": "role"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "w-alert",
+          "customElement": true,
+          "modulePath": "packages/alert/index.ts",
+          "definitionPath": "packages/alert/index.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "w-alert",
+          "declaration": {
+            "name": "WarpAlert",
+            "module": "packages/alert/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "WarpAlert",
+          "declaration": {
+            "name": "WarpAlert",
+            "module": "packages/alert/index.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "packages/utils/index.js",

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 
-import type { WarpAlert } from "./packages/alert/index.ts";
 import type { ccSuffix, ccPrefix, WarpAffix } from "./packages/affix/index.ts";
+import type { WarpAlert } from "./packages/alert/index.ts";
 import type { WarpLink } from "./packages/link/index.ts";
 import type { ccButton, WarpButton } from "./packages/button/index.ts";
 import type { ccAttention, WarpAttention } from "./packages/attention/index.ts";
@@ -111,18 +111,6 @@ type BaseEvents = {
 
 
 
-export type WarpAlertProps = {
-  /**  */
-  "variant"?: WarpAlert['variant'];
-  /**  */
-  "show"?: WarpAlert['show'];
-  /**  */
-  "role"?: WarpAlert['role'];
-
-
-}
-
-
 export type WarpAffixProps = {
   /**  */
   "aria-label"?: WarpAffix['ariaLabel'];
@@ -143,6 +131,18 @@ Set an `aria-label` that explains the action when using this. */
 }
 
 
+export type WarpAlertProps = {
+  /**  */
+  "variant"?: WarpAlert['variant'];
+  /**  */
+  "show"?: WarpAlert['show'];
+  /**  */
+  "role"?: WarpAlert['role'];
+
+
+}
+
+
 export type WarpLinkProps = {
   /**  */
   "autofocus"?: WarpLink['autofocus'];
@@ -921,24 +921,6 @@ export type WarpToastContainerProps = {
   export type CustomElements = {
 
 
-  /**
-     * Alert is an inline component used for displaying different types of messages.
- * 
- * For accessibility reasons, alert should appear close to the element that triggered it.
- * 
- * [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)
- * 
- * ## Attributes & Properties
- * 
- * Component attributes and properties that can be applied to the element or by using JavaScript.
- * 
- * - `variant`: undefined 
- * - `show`: undefined 
- * - `role`: undefined 
-  */
-    "w-alert": Partial<WarpAlertProps & BaseProps<WarpAlert> & BaseEvents>;
-
-
   /**
      * This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.
  * 
@@ -960,6 +942,24 @@ export type WarpToastContainerProps = {
     "w-affix": Partial<WarpAffixProps & BaseProps<WarpAffix> & BaseEvents>;
 
 
+  /**
+     * Alert is an inline component used for displaying different types of messages.
+ * 
+ * For accessibility reasons, alert should appear close to the element that triggered it.
+ * 
+ * [See Storybook for usage examples](https://warp-ds.github.io/elements/?path=/docs/feedback-alert--docs)
+ * 
+ * ## Attributes & Properties
+ * 
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ * 
+ * - `variant`: undefined 
+ * - `show`: undefined 
+ * - `role`: undefined 
+  */
+    "w-alert": Partial<WarpAlertProps & BaseProps<WarpAlert> & BaseEvents>;
+
+
   /**
      * Buttons are used to perform actions, with different visuals for different needs.
  *