goobs-frontend
Version:
A comprehensive React-based libary for building modern web applications
45 lines • 2.1 kB
TypeScript
import { default as React, ReactElement, ReactNode } from 'react';
export interface SacredGlyphFrameProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
/**
* Render the animated gold-glow border (`sacredGlowPulse`). Default `true`.
* Honours `prefers-reduced-motion` (freezes to a static glow via CSS).
*/
glow?: boolean;
/**
* Render the top-centred row of floating decorative glyphs (`sacredFloat`).
* Default `true`. Each glyph drifts on a slightly staggered cadence.
*/
glyphs?: boolean;
/**
* Override the decorative glyph sequence. Defaults to the Egyptian glyph row
* the ThothOS estimate/invoice decorations used. Decorative only — the row
* is `aria-hidden`.
*/
glyphSequence?: readonly string[];
/**
* Optional decorative corner ornaments. When supplied, rendered in all four
* corners behind the content. `aria-hidden`. Accepts a single node (mirrored
* into every corner) — pass a glyph / SVG / emoji.
*/
corners?: ReactNode;
/** Framed content (typically a sacred-themed `<Card>`). */
children: ReactNode;
}
interface SacredGlyphFrameComponent {
(props: SacredGlyphFrameProps & React.RefAttributes<HTMLDivElement>): ReactElement | null;
displayName?: string;
}
/**
* Animated gold-glow + decorative-glyph wrapper for sacred surfaces —
* designed to wrap a sacred-themed `<Card>` (though it is standalone and
* imports no other goobs component). The `sacredGlowPulse` / `sacredFloat`
* keyframes are injected exactly once at module load via `commonKeyframes`,
* never per-instance, and the CSS module references the resulting animation
* names; the glow honours `prefers-reduced-motion` by freezing to a static
* glow. All decoration (the floating glyph row and any `corners` ornaments)
* is `aria-hidden`, so only `children` carry content. Sacred-only by design —
* there is no light/dark theme variant.
*/
declare const SacredGlyphFrame: SacredGlyphFrameComponent;
export default SacredGlyphFrame;
//# sourceMappingURL=index.d.ts.map