Skip to content

@checkout-kit/react / CheckoutRootProps

Interface: CheckoutRootProps ​

Properties ​

PropertyTypeDescription
childrenReactNode-
className?string-
density?"comfortable" | "compact"compact tightens the layout - an embedded checkout, or one in a WebView.
platform?"auto" | PlatformPin it to override detection.
style?CSSPropertiesCustom properties, for a brand that lives in a token pipeline rather than a stylesheet. appearanceToStyle() in @checkout-kit/ui builds one; plain CSS on .ck-root still works and is the shorter path when the brand is already written down in CSS.
theme?"dark" | "light" | "auto"auto follows the system. Unset means dark.

Apache-2.0 · Headless engine, provider adapters and runnable examples.