JSPM

  • Created
  • Published
  • Downloads 2523
  • Score
    100M100P100Q114333F
  • License SEE LICENSE IN LICENSE

UI building blocks for Interchain builders

Package Exports

  • @interchain-ui/react
  • @interchain-ui/react/globalStyles
  • @interchain-ui/react/package.json
  • @interchain-ui/react/styles
  • @interchain-ui/react/walletConnector

Readme

Interchain UI Kit

Interchain UI for React

🎨 What is Interchain UI?

Interchain UI is a foundation library for UI elements used in cosmos-kit and other packages. It provides developers with pre-built components and a foundation for creating user interfaces across different frameworks, such as VueJS, React, Angular, Svelte, SolidJS, and Web Components, enabling developers to customize UI elements and themes. This gives us the ability to code a component once, and it will compile to all framework targets.

Usage

First install using your favorite package manager

npm i @interchain-ui/react

yarn add @interchain-ui/react

pnpm add @interchain-ui/react

Then in your root route/layout, import ThemeProvider and CSS

// layout.tsx
import { ThemeProvider, OverlaysManager } from '@interchain-ui/react';
import '@interchain-ui/react/styles';

export function RootLayout(props: LayoutProps) {
  return (
    <ThemeProvider>
      {props.children}
      <OverlaysManager />
    </ThemeProvider>
  )
}

After these steps are done, you can import and use @interchain-ui/react components.

Setup and scripts for development

  • pnpm install to bootstrap the repo
  • pnpm run dev to watch the repo for changes and then recompile
  • pnpm run compile to compile from mitosis components to other packages, you can give it a flag -p or --platforms .ie yarn compile -p react vue
  • pnpm run c:react or pnpm run c:vue to compile specifically to react or vue
  • pnpm run clean to clean .node_modules or pnpm run clean:assets to clean build/compile output

Icon

Check Icon guide to know how to add more icons

Our Website

βš›οΈ https://cosmology.zone/products/interchain-ui

Interchain JavaScript Stack βš›οΈ

A unified toolkit for building applications and smart contracts in the Interchain ecosystem

Category Tools Description
Chain Information Chain Registry, Utils, Client Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet Connectors Interchain Kitbeta, Cosmos Kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing Clients InterchainJSbeta, CosmJS A single, universal signing interface for any network
SDK Clients Telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter Kits Create Interchain Appbeta, Create Cosmos App Set up a modern Interchain app by running one command.
UI Kits Interchain UI The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing Frameworks Starship Unified Testing and Development for the Interchain.
TypeScript Smart Contracts Create Hyperweb App Build and deploy full-stack blockchain applications with TypeScript
CosmWasm Contracts CosmWasm TS Codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.

Credits

πŸ›  Built by Hyperweb (formerly Cosmology) β€”Β if you like our tools, please checkout and contribute to our github βš›οΈ

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED β€œAS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.