html-squircle/dist/umd/react/useSquircle.d.ts

Utilities for generating superellipse squircles in the form of SVG strings, to be used in clip-path and background inline styles.

import type { RefObject } from "react";
import type { SquircleOptionsBackgroundReact, SquircleOptionsClipReact } from "../types.js";
/**
 * Pass a ref for the observed element and options for the squircle computation
 * function. The returned type will depend on the options used.
 *
 * Note this will NOT work properly if you apply the style to an element your
 * component manages which may leave the DOM without your component unmounting.
 * Apply it only to elements which will be rendered unconditionally with your
 * component.
 */
export declare function useSquircle(ref: RefObject<Element | null>, options?: SquircleOptionsClipReact): {
    clipPath: `path('${string}')`;
};
/**
 * Pass a ref for the observed element and options for the squircle computation
 * function. The returned type will depend on the options used.
 *
 * Note this will NOT work properly if you apply the style to an element your
 * component manages which may leave the DOM without your component unmounting.
 * Apply it only to elements which will be rendered unconditionally with your
 * component.
 */
export declare function useSquircle(ref: RefObject<Element | null>, options?: SquircleOptionsBackgroundReact): {
    background: `url("data:image/svg+xml,${string}") left top no-repeat`;
};
//# sourceMappingURL=useSquircle.d.ts.map