This repository has been archived by the owner on Apr 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,3 @@ | ||
| <div align="center"> | ||
| <h1>🛠 RDK</h1> | ||
| Component ToolKit for React | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/reaviz/rdk/workflows/build/"> | ||
| <img src="https://github.com/reaviz/rdk/workflows/build/badge.svg?branch=master" /> | ||
| </a> | ||
| <a href="https://npm.im/rdk"> | ||
| <img src="https://img.shields.io/npm/v/rdk.svg" /> | ||
| </a> | ||
| <a href="https://npm.im/rdk"> | ||
| <img src="https://badgen.net/npm/dw/rdk" /> | ||
| </a> | ||
| <a href="https://github.com/reaviz/rdk/blob/master/LICENSE"> | ||
| <img src="https://badgen.now.sh/badge/license/apache2" /> | ||
| </a> | ||
| <a href="https://bundlephobia.com/result?p=rdk"> | ||
| <img src="https://badgen.net/bundlephobia/minzip/rdk"> | ||
| </a> | ||
| <a href="https://discord.gg/tt8wGExq35"> | ||
| <img src="https://img.shields.io/discord/773948315037073409?label=discord"> | ||
| </a> | ||
| <a href="https://opencollective.com/reaviz"> | ||
| <img alt="Open Collective backers and sponsors" src="https://img.shields.io/opencollective/all/reaviz?label=backers"> | ||
| </a> | ||
| </div> | ||
| # RDK | ||
|
|
||
| --- | ||
|
|
||
| RDK is a set of low-level tools that implement common interactions found in | ||
| component libraries. The tooling abstracts the visual | ||
| presentation so the tools can be used with any visual presentation. | ||
|
|
||
| ## 🚀 Quick Links | ||
| - Checkout the [demos and docs](https://reaviz.github.io/rdk/) | ||
| - Explore the library on [Chroma](https://www.chromatic.com/library?appId=5eb06076aebb8f00227a5659) | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - Overlay - Provides a way to open floating panels on the screen | ||
| - Exit Listener - Provides a easy way to listen for exit events such as clicks and escape keypress. | ||
| - Portal - Provides a flexible system for rendering dynamic content into an application | ||
| - Position - Provides a flexible system for placing panels related to other elements | ||
| - Backdrop - Blocker element overlay | ||
| - Id - A unique ID hook | ||
| - User Select - A user select hook | ||
| - Cursor - A cursor hook | ||
|
|
||
| ## 📦 Install | ||
|
|
||
| To use RDK in your project, install it via npm/yarn: | ||
|
|
||
| ``` | ||
| yarn add rdk | ||
| ``` | ||
|
|
||
| Visit the [demos page](https://reaviz.github.io/rdk/) to learn more! | ||
|
|
||
| ## 🔭 Development | ||
|
|
||
| If you want to run RDK locally, its super easy! | ||
|
|
||
| - Clone the repo | ||
| - `yarn install` | ||
| - `yarn start` | ||
| - Browser opens to Storybook page | ||
|
|
||
| ## ❤️ Contributors | ||
|
|
||
| Thanks to all our contributors! | ||
|
|
||
| <a href="https://github.com/reaviz/rdk/graphs/contributors"><img src="https://opencollective.com/reaviz/contributors.svg?width=890" /></a> | ||
| This package is deprecated and part of [https://reablocks.dev](https://reablocks.dev) now. |