Interchain UI

The Design System for the Interchain

Table of contents

• Interchain UI
  • Table of contents
  • 🎨 What is Interchain UI?
  • Usage
    • React
  • Developing
  • Overview and structure
  • Compiler
  • Icons
  • Customizing theme
  • Package dev scripts in root package.json
  • Convention
  • Related
  • Credits

🎨 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

# If you use react
yarn add @interchain-ui/react

# If you use vue
yarn add @interchain-ui/vue

React

To see how to use with react, see our react documentation

Using React

Developing

We are using Lerna + PNPM to bootstrap the monorepo. First make sure you install PNPM locally first, then run these commands:

• 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 pnpm run compile -p react vue
• pnpm run c:react or pnpm run c:vue to compile specifically to react or vue
• pnpm run clear to clean .node_modules or pnpm run clear:assets to clean build/compile output
• pnpm run clear:cache to clean cache folder used by bundlers

Overview and structure

We create components inside a single source of truth folder <root>/src with Lite JSX format (.lite.tsx), then through our compiler, it's going to compile our components and build it in sub packages' src and dist.

Compiler

To know more about the inner workings of our compiler, check Compiler to explore.

Icons

Check Icon guide to know how to add more icons

Customizing theme

Check Customizing guide to know how to customize the default theme.

Package dev scripts in root package.json

• t:<target> to compile target framework (t is short for transpile)
• b:<target> to bundle target framework
• c:<target> to compile and bundle target framework, it's equivalent to sequentially running pnpm run t:<target> && pnpm run b:<target>

Convention

• Component file names must end with *.lite.tsx

• Style sheets must be in *.css.ts files, this is because we use a styling solution called vanilla-extract to have a CSS-in-JS API across all frameworks.

• For a component, you must use default export, not named export. This is a limitation of Mitosis

• There are more rules and limitations, please read more about Mitosis here

• To quickly test to see the compilation result from one Mitosis to any framework source code, please use mitosis sandbox. It's similar to TS playground but for Mitosis testing purpose.

• [Vue specifics] Event handlers

  • Event handlers in <template> must be prefixed with on
  • Event handlers must be defined in useStore hook with a getter function get eventHandlers() with exact name. A template for this is as below:

  get eventHandlers() {
    const handlers: Record<string, (event: any) => void> = {};
    const eventProps = [
      "onClick",
      "onDoubleClick",
      // Add other event names here
    ]
    eventProps.forEach((eventName) => {
        if (props[eventName]) {
          handlers[eventName] = (event: any) => props[eventName](event);
        }
      });
  
    return handlers;
  }

  • You can then attach the event handlers to the JSX tag with spread attribute {...state.eventHandlers}, this will be transformed to be a v-on directive in Vue

Related

Checkout these related projects:

• @cosmology/telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
• @cosmwasm/ts-codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
• chain-registry Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
• cosmos-kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
• create-cosmos-app Set up a modern Cosmos app by running one command.
• interchain-ui The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
• starship Unified Testing and Development for the Interchain.

Credits

Checkout mitosis from BuilderIO to compile lite JSX.

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️