/react-wired-elements

Wired Elements as React components. TypeScript types included.

Primary LanguageTypeScriptMIT LicenseMIT

react-wired-elements

Wired Elements as React components.

  • Great for quick prototyping
  • TypeScript types included 👍

Storybook Demo

The Storybook Demo includes interactive examples as well as detailed documentation for each component's props and usage.

Wired Elements is a really cool library that provides web components with a wireframe look using SVGs. This library wraps each of the wired elements in a React component and exposes the available attributes, methods, and styling options as props (as best as possible).

Installation

Step 1. Install this library with using yarn or npm.

yarn add react-wired-elements

Step 2. Include the Material Icons CSS file in the head of your main HTML file.

<head>
  <link
    href="https://fonts.googleapis.com/css?family=Material+Icons&display=block"
    rel="stylesheet"
  />
</head>

Usage

import React from 'react';
import { WiredCard, WiredButton } from 'react-wired-elements';

const App = () => {
  return (
    <WiredCard fill="#F5F5F5" elevation={3}>
      <WiredButton onClick={handleSubmit}>Submit</WiredButton>
    </WiredCard>
  );
};

Checkout the Storybook Demo for interactive examples and detailed prop definitions and usage instructions.

Here is the full list of components. Click any component to be directed to it's Storybook example.

Differences and Known Issues

There are some naming and functionality differences between Wired Elements and this library. This is due, in part, to differences in how React and web components work as well as an effort to follow common naming conventions/patterns in React. Since these are web components, they dispatch native events as opposed to React synthetic events.

  • maxRows prop on WiredTextArea component not working
  • firstDate and lastDate not working on WiredCalendar