https://github.com/interlay/ui
https://github.com/interlay/ui
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/interlay/ui
- Owner: interlay
- Created: 2023-09-07T16:31:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T10:14:21.000Z (almost 2 years ago)
- Last Synced: 2025-03-27T10:04:53.986Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://ui-interlay.vercel.app
- Size: 2.05 MB
- Stars: 1
- Watchers: 2
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
Awesome Lists containing this project
README
Interlay UI
Interlay IU is library of accessible, reusable, and composable React components built
around a crypto business model
## Table of contents
- 🚀 [Features](#features)
- 📦 [Installation](#installation)
- 💻 [Usage](#usage)
- 📝 [Contributing](#contributing)
- ⚖️ [License](#license)
## 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:
```sh
# 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**.
```jsx
import { InterlayUIProvider } from '@interlay/ui';
// Do this at the root of your application
function App({ children }) {
return {children};
}
```
2. Now you can start using components like so!:
```jsx
import { Button } from '@interlay/ui';
function Example() {
return I am using Interlay UI;
}
```
## Contributing
Contributions are always welcome!
See [CONTRIBUTING.md](https://github.com/interlay/ui/blob/main/CONTRIBUTING.MD) for ways to get started.
## License
[MIT](https://choosealicense.com/licenses/mit/)