@beeq/react

React Wrapper for BEEQ

A lightweight utility that wraps BEEQ custom elements ("web components") so they can be used like native React components.

Package installation

• install the package

npm install @beeq/react

• update the package

npm install @beeq/react@latest

if @beeq/core package is installed you should update both

npm install @beeq/{core,react}

Add BEEQ styles and assets

Make sure that BEEQ main style is imported into your application's main style file:

@import "@beeq/core/dist/beeq/beeq";

❗️The icons SVG are shipped in a separate folder. Depending on your React stack, your project will need to include node_modules/@beeq/core/dist/beeq/svg in the build in such a way that it respond to: http://<domain>/svg

Usage

import React from 'react';
import { BqButton } from '@beeq/react';

function App() {
  const handleButtonClick = (ev: CustomEvent) => {
    console.log(ev.detail);
  };

  return (
    <BqButton appearance="primary" onBqClick={handleButtonClick}>
      Click Me
    </BqButton>
  );
}

export default App;

Why is this necessary?

React and custom elements don't play nicely together. The problem is best described by Custom Elements Everywhere:

Handling data

React passes all data to Custom Elements in the form of HTML attributes. For primitive data this is fine, but the system breaks down when passing rich data, like objects or arrays. In these instances you end up with stringified values like some-attr="[object Object]" which can't actually be used.

Handling events

Because React implements its own synthetic event system, it cannot listen for DOM events coming from Custom Elements without the use of a workaround. Developers will need to reference their Custom Elements using a ref and manually attach event listeners with addEventListener. This makes working with Custom Elements cumbersome.

This utility solves these problems by exposing a native React component that maps properties and events to the underlying custom element. ✨