@virtuslab/tetrisly-react

Tetrisly React

🧩 Tetrisly offers user-friendly components designed for effortless integration. Plus, it's fully compatible with fully compatible with Tetrisly for Figma with a seamless design and development experience in mind.

If you want to know more about Tetrisly, check out our website: tetrisly.com

Tech Stack

• React 18
• xstyled

We've desided to use xstyled for styling our components. If you are interested in our reasoning, check out our article on this topic: Style Wars: Tailwind vs. CSS-in-JS in Design Systems Implementation

Installation

Install tetrisly-react with npm (you can do the same with yarn, pnpm or any other package manager)

  npm install @virtuslab/tetrisly-react

Setup

After installing the package, you need to wrap your application in the TetrislyProvider component. This will provide the theme and other context to your application.

import { TetrislyProvider } from '@virtuslab/tetrisly-react';

function App() {
  return (
    <TetrislyProvider>
      <YourApp />
    </TetrislyProvider>
  )
}

TetrislyProvider accepts optional prop theme which can be used to override default theme.

You can check out how this object looks like here: Tetrisly Theme

import { TetrislyProvider } from '@virtuslab/tetrisly-react';

function App() {
  return (
    <TetrislyProvider theme={{ colors: { primary: 'red' } }}>
      <YourApp />
    </TetrislyProvider>
  )
}

Usage/Examples

import { Button } from '@virtuslab/tetrisly-react';

function App() {
  return <Button label="Hello Tetrisly" />
}

Run Locally

Clone the project

  git clone https://github.com/VirtusLab/tetrisly-react

Go to the project directory

  cd tetrisly-react

Install dependencies

  yarn install

Start the storybook server

  yarn storybook

Running Tests

To run tests, run the following command

  yarn test

Documentation

If you want to dive deeper into the components Tetrisly offers, check out our official documentation: Tetrisly Docs

You can also check out our Storybook, which is our Documentation for React components (now in progress): Tetrisly Storybook

Getting Help

If at any point you need help, feel lost, or have some feedback for us, you can create issues on our GitHub repository, or reach out to us on out Discord Server: Tetrisly Discord

Testimonials

If you want to share with us your thoughts on Tetrisly, or showcase what you have built with it (it could be any aspect of our product, not only the React library), you can do it here: Tetrisly Testimonials Form

License

We are using the Apache License 2.0 for our library of components

Changelog

1.1.0 (2023-10-13)

Features

• changelog and reame pages in storybook NO-JIRA (#85) (5bd9825)

Bug Fixes

• images paths in readme NO-JIRA (#86) (6557317)