@warp-ds/elements-core

@warp-ds/elements-core

Introduction

The @warp-ds/elements-core package focuses on delivering a WarpElement component built with Lit, for use as a base class for custom elements in @warp-ds/elements package.

Installation

To install the elements-core package, you can use npm:

npm install @warp-ds/elements-core

or pnpm:

pnpm add @warp-ds/elements-core

Usage

In order to make Warp styles available in your Web Component, you must extend your component with WarpElement and reference its styles property in the following manner:

import WarpElement from '@warp-ds/elements-core';

class MyComponent extends WarpElement {
  static styles = [WarpElement.styles];
  ...
}

use with Vite

Additional (non-obvious) configuration is needed to use this module with Vite. Even if you have Vite's build.target set to esnext.

export default defineConfig({
  optimizeDeps: {
    esbuildOptions: { target: 'esnext' }
  },
  //...
})

Releases

This project is continuously published to NPM and Eik.

Contributing

We welcome contributions to the @warp-ds/elements-core package! If you would like to contribute, start by reviewing the contributing guidelines.

License

@warp-ds/elements-core is available under the Apache-2.0 software license.