Skip to main content
userTourKit
@tour-kit/announcementsComponents

Variants

CVA variant exports for @tour-kit/announcements — bannerVariants, modalContentVariants, modalOverlayVariants, slideoutContentVariants, toastVariants, and the full styling surface

domidex01Published

Each styled component is built on a cva() call that exposes its slot/size/variant matrix. Import the variant function to extend or compose the classes; import the matching *Variants type to get prop-level autocomplete.

import { modalContentVariants } from '@tour-kit/announcements'

<div className={modalContentVariants({ size: 'lg' })}>
  {/* ... */}
</div>
import type { ModalContentVariants } from '@tour-kit/announcements'

type ModalSize = ModalContentVariants['size'] // 'sm' | 'md' | 'lg' | 'xl' | 'full'
Variant fnSlots
modalContentVariantssize: 'sm' | 'md' | 'lg' | 'xl' | 'full'
modalOverlayVariants(compound classes only)

Slideout

Variant fnSlots
slideoutContentVariantswidth / direction (see source)
slideoutOverlayVariants(compound classes only)
Variant fnSlots
bannerVariantsposition, tone (see source)

Toast

Variant fnSlots
toastVariantsvariant (default / success / warning / destructive)
toastContainerVariantsposition
toastProgressVariants(compound classes only)

Spotlight

Variant fnSlots
spotlightContentVariantsplacement (see source)
spotlightOverlayVariants(compound classes only)

Type aliases

Every variant function above has a matching VariantProps type alias (e.g. ModalContentVariants, BannerVariants, ...) — listed in Type Reference.

For overlay/blur slots, see AnnouncementOverlayProps — the overlayVariants slots cascade through that interface.

Free & open source

Ship onboarding, not config.

npm i @tour-kit/core is MIT and free. The Pro packages work unlicensed too — a one-time $99 license removes the production watermark when you ship.

MIT-licensed — no signup, no credit card. Pay once, only when you ship.