cute-kitty-ui-registry
v3.0.3
Published
[](https://www.npmjs.com/package/cute-kitty-ui-registry) [](https://opensource.org/licenses/MIT)
Readme
Cute-Kitty-UI Registry
Source of truth for Cute-Kitty-UI components
Overview
The Cute-Kitty-UI Registry package contains the source code for all cat components. It serves as the central repository from which the CLI fetches components to install in user projects.
Components
Basic Poses
SittingCat- Classic sitting pose, perfect for cards and buttonsLyingCat- Horizontal pose, great for banners and footersStandingCat- On all fours, ideal for action scenesSleepingCat- Curled up, perfect for loading states or cornersPlayingCat- Dynamic pouncing pose for interactive elements
Compositions
HoldingSignCat- Cat holding a customizable sign or messagePeekingCat- Cat peeking from edges of containersFaceOnlyCat- Just the cat's face, for minimal space usage
Component Structure
Each component follows a consistent structure:
interface KittyBaseProps {
// Appearance
primaryColor?: string
secondaryColor?: string
size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | number
// Emotion System
emotion?: 'happy' | 'sad' | 'excited' | 'sleepy' | 'curious' | 'angry'
// Positioning System
position?: 'relative' | 'absolute' | 'fixed'
anchor?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center'
offset?: { x: number; y: number }
zIndex?: number
// Animation
animated?: boolean
animationSpeed?: 'slow' | 'normal' | 'fast'
hover?: boolean
// Accessories
accessories?: ('bow' | 'hat' | 'glasses' | 'collar')[]
// Utility
className?: string
style?: React.CSSProperties
onClick?: () => void
}Usage
This package is not meant to be used directly. Instead, use the Cute-Kitty-UI CLI to add components to your project:
npx cute-kitty-ui@latest add sitting-catDocumentation
For full documentation, visit cute-kitty-ui
Contributing
We welcome contributions! Please see our Contributing Guide for more details.
License
MIT © Cute-Kitty-UI
