elements
lifecycle
browser
- useAudio
- useBattery
- useBluetooth
- useBreakpoints
- useBroadcastChannel
- useBrowserLocation
- useClipboard
- useCopy
- useCssVar
- useDisplayMedia
- useDocumentEvent
- useDocumentTitle
- useDocumentVisibility
- useEventListener
- useEventSource
- useEyeDropper
- useFavicon
- useFileSystemAccess
- useFps
- useFullscreen
- useGamepad
- useGeolocation
- useMeasure
- useMediaControls
- useMediaQuery
- useMemory
- useNetwork
- useObjectUrl
- useOnline
- useOtpCredential
- usePermission
- usePictureInPicture
- usePointerLock
- usePostMessage
- useRaf
- useShare
- useSpeechRecognition
- useSpeechSynthesis
- useSticky
- useVibrate
- useVirtualKeyboard
- useWakeLock
- useWebSocket
utilities
state
- useBoolean
- useControllableState
- useCookie
- useCookies
- useCounter
- useDefault
- useDisclosure
- useField
- useHash
- useList
- useLocalStorage
- useMap
- useMask
- useMergedRef
- useObject
- useOffsetPagination
- useQueue
- useRafState
- useRefState
- useSessionStorage
- useSet
- useStateHistory
- useStep
- useStorage
- useToggle
- useUrlSearchParam
- useUrlSearchParams
- useWizard
user
sensors
- useDeviceMotion
- useDeviceOrientation
- useHotkeys
- useIdle
- useInfiniteScroll
- useIntersectionObserver
- useKeyboard
- useKeyPress
- useKeysPressed
- useMouse
- useMutationObserver
- useOrientation
- usePageLeave
- useParallax
- usePerformanceObserver
- useResizeObserver
- useScroll
- useScrollIntoView
- useScrollTo
- useSwipe
- useTextSelection
- useVisibility
- useWindowEvent
- useWindowFocus
- useWindowScroll
- useWindowSize
cn
Combines class names from strings, arrays and objects into a single string
helpershightest coverage
import type { ComponentProps } from 'react';
import { cn } from '@siberiacancode/reactuse';
import { Loader2Icon } from 'lucide-react';
type ButtonVariant = 'default' | 'outline' | 'secondary';
interface ButtonProps extends ComponentProps<'button'> {
loading?: boolean;
variant?: ButtonVariant;
}
const buttonVariants = {
variant: {
default: 'bg-primary! text-primary-foreground! hover:bg-primary/80!',
secondary: 'bg-secondary! text-secondary-foreground! hover:bg-secondary/80!',
outline:
'border border-border! bg-background! text-foreground! hover:bg-muted! hover:text-foreground!'
}
} as const;
const Button = ({
className,
disabled,
loading = false,
variant = 'default',
children,
...props
}: ButtonProps) => (
<button
className={cn(
'inline-flex h-10 shrink-0 items-center justify-center gap-2 rounded-lg border border-transparent px-4 py-2 text-sm font-medium whitespace-nowrap transition-all outline-none select-none',
'focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-3',
'disabled:pointer-events-none disabled:opacity-50',
buttonVariants.variant[variant],
className
)}
disabled={disabled || loading}
type='button'
{...props}
>
{loading ? <Loader2Icon className='size-4 animate-spin' /> : children}
</button>
);
const Demo = () => (
<div className='flex flex-col gap-3 p-4'>
<Button>Default</Button>
<Button variant='secondary'>Secondary</Button>
<Button variant='outline'>Outline</Button>
<Button loading>Continue</Button>
</div>
);
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
cn('btn', ['btn-primary', { 'btn-disabled': disabled }]);Type Declarations
export type ClassDictionary = Record<string, unknown>;
export type ClassArray = ClassValue[];
export type ClassValue =
| boolean
| number
| string
| ClassArray
| ClassDictionary
| null
| undefined;API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| values | ...ClassValue[] | - | Class values to normalize and join |
Returns
stringContributors
ddebabinttungulin
Last updated on