Custom elements for Warp
npm install @warp-ds/elementsWelcome to @warp-ds/elements,
a collection of Web Components built with Lit to be used to build interfaces based on the Warp Design System.
This repository is maintained by the Warp Core Team
and is home to the @warp-ds/elements library.
If you'd like to contribute to @warp-ds/elements,
start by reviewing the contributing guidelines.
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.
#### Step 1.
Add the following script and style to the very top of your document head to ensure performant loading
``html`
#### Step 2.
Be sure to preload whichever brand fonts you need for a page and load the correct font file:
`html`
`html`
`html`
`html`
#### Step 3.
You'll also want to load Warp tokens and resets CSS files to ensure consistent and correct styling for the brand.
`html`
`html`
`html`
`html`
#### Step 4.
Next, to add intellisense to your editor install @warp-ds/elements by using npm/pnpm. See the Editor integration below.
##### Install using npm
`sh`
npm install @warp-ds/elements
##### Install using pnpm
`sh`
pnpm add @warp-ds/elements
And then head on down to the editor configuration section below to complete setup.
If you are using Borealis modules from the Web Platform Team (and you should be) and keeping your app dependencies up to date (and you should be), then steps 2 and 3 are already taken care of for you, you just need to do steps 1 and 4.
For information on the components available in the package and how to use them,
see the Warp Design System documentation.
#### Typescript
Install the @warp-ds/elements package
`
npm install @warp-ds/elements
Add @warp-ds/elements to tsconfig types in compilerOptions.
`json`
{
"compilerOptions": {
"types": ["react", "react-dom", "@warp-ds/elements"]
}
}
#### Visual Studio Code
Install the Web Components Language Server extension. The extension automatically picks up the Custom Element Manifest that we ship with @warp-ds/elements.
##### Using Warp Elements in a plain HTML page
Install Warp Elements locally using npm:
`
npm install @warp-ds/elements
Install the Web Components Language Server extension.
Now, inside any .html files, you will get IntelliSense when using Warp Elements:
`html`
##### Using Warp Elements in JavaScript template literals
IntelliSense in JavaScript strings is not supported without additional plugins and syntax, such as comment hints (/ html /) or a tagged template literal similar to Lit.
##### Using Warp Elements in Lit html tagged template literals
Install Warp Elements locally using npm:
`
npm install @warp-ds/elements
Install the Web Components Language Server extension.
Install the lit-plugin extension.
Now, inside any html tagged template literals, you will get intellisense when using Warp Elements.
`html`
##### Using Warp Elements in a React app, v19 or later
`
npm install @warp-ds/elements
Now, inside your react components, you will get intellisense when using Warp Elements.
`html`
##### Using Warp Elements in a React app, v18 or earlier
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 cannot upgrade right away, Warp supplies custom element wrappers to add backwards compatibility. Use them like so:
`
npm install @warp-ds/elements
Wherever you need to use a component in your app, import the appropriate element from the React namespace
`js`
import { Button } from "@warp-ds/elements/react/button";
and use the component
`js`
you should get intellisense when using Warp Elements.
#### JetBrains products
We ship web-types.json which should get picked up automatically by JetBrains IDEA and similar products.
You should see code completions and inline docs for Warp elements when writing HTML.
To avoid issues like CLS (cumulative layout shift) and FOUCE (flash of unstyled custom elements), its important that Warp Elements is loaded before the page is rendered. For this reason, elements should not be bundled into the rest of your client side application and code and should be loaded in the document head, as early as possible (see installation above). When this is done correctly, elements will be loaded and ready about the same time as the rest of the page styles and wont cause delays in page load times. However, due to the way browsers work, a page render will occur without the components and an immediate re-render will occur with the components. This causes things to jump around on the page which in turn impacts lighthouse and other performance scores. Warp elements ships with a tool to prevent the initial render without components and only do the second, with components, render. This tool is called Warp Cloak and its usage is described below.
#### The Warp cloaking device
To use the Warp cloaking device to avoid CLS and FOUCE, simply add the warp-cloak class to your pages body, html or a wrapper div that contains all the pages visible elements (including the header and footer)
`html`
That's it, your components should render just 1x, fully ready with no CLS and FOUCE.
This project is continuously published to NPM and Eik using a next tag (e.g. 2.2.0-next.13).next` version while waiting for the stable release.
Anyone needing to use the latest changes of this package can point to the
Detailed changes for each release can be found in the CHANGELOG file.
@warp-ds/elements is available under the Apache-2.0 software license.