BETA

Getting Started

Installation

npm install @squircle/core @squircle/paint-polyfill

Import

import { init } from '@squircle/core';

Initialize

init();

Initialize in React

squircle-provider.tsx
'use client';
 
import * as React from 'react';
import { init } from '@squircle/core';
 
export function SquircleProvider({ children }: { children: React.ReactNode }) {
  React.useEffect(() => void init(), []);
  return children;
}

Then use the SquircleProvider component to wrap your app.

<SquircleProvider>
  <App />
</SquircleProvider>

Usage

CSS

.squircle {
  background: paint(squircle);
  --squircle-background-color: red;
  --squircle-border-color: blue;
  --squircle-border-width: 10px;
  --squircle-border-radius: 30px;
}

Tailwind CSS

Only support Tailwind >= 4.0.

Install

npm install @squircle/tailwindcss

Import

globals.css
@import '@squircle/tailwindcss';

Usage

<div class="squircle squircle-2xl squircle-teal-400" />

By Skyleen. The source code is available on GitHub.

On this page