Code Monkey home page Code Monkey logo

ui's Introduction

Interlay UI


Interlay IU is library of accessible, reusable, and composable React components built around a crypto business model

Table of contents

Features

  • Ease of Styling: style your component simply by passing props
  • Flexible & composable: Interlay UI components are built on top of a React UI Primitive for endless composability.
  • Accessible. Interlay UI components follow the WAI-ARIA guidelines specifications and have the right aria-* attributes by using react-aria as foundation.

Installation

To use Interlay UI components, all you need to do is install the @interlay/ui package and its peer dependencies:

# with Yarn
$ yarn add @interlay/ui styled-components

# with npm
$ npm i @interlay/ui styled-components

# with pnpm
$ pnpm add @interlay/ui styled-components

# with Bun
$ bun add @interlay/ui styled-components

Usage

To start using the components, please follow these steps:

  1. Wrap your application with the InterlayUIProvider provided by @interlay/ui.
import { InterlayUIProvider } from '@interlay/ui';

// Do this at the root of your application
function App({ children }) {
  return <InterlayUIProvider>{children}</InterlayUIProvider>;
}
  1. Now you can start using components like so!:
import { CTA } from '@interlay/ui';

function Example() {
  return <CTA>I am using Interlay UI</CTA>;
}

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

License

MIT

ui's People

Contributors

danielsimao avatar github-actions[bot] avatar tomjeatt avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.