Nitrogen Peroxide Monoxide

npm

Need private packages and team management tools?Check out npm Orgs. »

@manifoldco/ui

0.8.0 • Public • Published

Built With Stencil version (scoped) codecov

🍱 Manifold UI

Manifold’s Web Component UI library, powered by Stencil.

Installation

npm i @manifoldco/ui

Usage

Manifold UI can be used in any frameworkless project (“vanilla” JS), or any modern framework like React, Vue, or Angular.

Framework Supported?
Vanilla JS (no framework)
Angular
React
Vue
Ember

In any setup, you can use our CDN for UI:

<!-- latest (beware of breaking changes!) -->
<script src="https://js.cdn.manifold.co/@manifoldco/ui/dist/manifold.js"></script>
<!-- specific version -->
<script src="https://js.cdn.manifold.co/@manifoldco/ui@0.6.0/dist/manifold.js"></script>

HTML (ES Modules)

<head>
  <link
    rel="stylesheet"
    type="text/css"
    href="https://js.cdn.manifold.co/@manifoldco/ui/dist/manifold/manifold.css"
  />
</head>
<body>
  <manifold-marketplace></manifold-marketplace>
  <script type="module">
    import { defineCustomElements } from 'https://js.cdn.manifold.co/@manifoldco/ui/dist/esm/es2017/manifold.define.js';
    defineCustomElements(window);
  </script> 
</body>

HTML (No ESM Support)

<head>
  <link
    rel="stylesheet"
    type="text/css"
    href="https://js.cdn.manifold.co/@manifoldco/ui/dist/manifold/manifold.css"
  />
</head>
<body>
  <manifold-marketplace></manifold-marketplace>
  <script src="https://js.cdn.manifold.co/@manifoldco/ui/dist/manifold.js"></script> 
</body>

React

import React from 'react';
import ReactDOM from 'react-dom';
import '@manifoldco/ui/dist/manifold/manifold.css';
import(/* webpackChunkName: "manifold-ui" */ '@manifoldco/ui/dist/loader').then(
  ({ defineCustomElements }) => defineCustomElements(window)
);
 
const App = () => <manifold-marketplace />;
 
ReactDOM.render(<App />, document.getElementById('root'));

TypeScript + JSX setup

When using UI with TypeScript, you’ll likely see an error like this:

Property 'manifold-connection' does not exist on type 'JSX.IntrinsicElements'

To solve that, create a custom-elements.d.ts file somewhere inside your project (must be inside the include option in tsconfig.json):

import { Components, JSX as LocalJSX } from '@manifoldco/ui/dist/loader';
import { DetailedHTMLProps, HTMLAttributes } from 'react';
 
type StencilProps<T> = {
  [P in keyof T]?: Omit<T[P], 'ref'>;
};
 
type ReactProps<T> = {
  [P in keyof T]?: DetailedHTMLProps<HTMLAttributes<T[P]>, T[P]>;
};
 
type StencilToReact<T = LocalJSX.IntrinsicElements, U = HTMLElementTagNameMap> = StencilProps<T> &
  ReactProps<U>;
 
declare global {
  export namespace JSX {
    interface IntrinsicElements extends StencilToReact {}
  }
}

This will expose the types from Stencil to JSX, and you’ll be able to get typechecking as you write.

Note: Every element will have to be declared manually, at least until this PR is merged in TypeScript core.

Ember, Angular, Vue, and others

Initializing Manifold UI works the same as any other Stencil project. For more advanced instructions on integrating with your specific stack, please refer to Stencil’s docs on integration.

Keywords

none

install

npm i @manifoldco/ui

Downloadsweekly downloads

558

version

0.8.0

license

BSD-3-Clause

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability