cn

PreviousNext

\@udecode/cn 的 API 参考文档。

@udecode/cn 包含用于 React 和 Tailwind 的工具函数。

cn

条件性地添加 Tailwind CSS 类而不产生冲突。

Parameters

  • ...inputs CxOptions

    使用 clsx 和 tailwind-merge 设置的类值。

Returnsstring

    合并后的 className。

withCn

为组件设置默认的 className。

Parameters

Collapse all

  • Component React.ComponentType

    需要添加属性的组件。

  • ...inputs CxOptions

    使用 cn 设置的默认 className。

ReturnsReact.ComponentType

    包含默认 className 的新组件。

withProps

为组件设置默认属性。

Parameters

Collapse all

  • Component React.ComponentType | ElementType

    需要添加属性的组件。

  • props Partial<T>

    要添加到组件的属性。

ReturnsReact.ComponentType

    包含默认属性的新组件。

withVariants

使用 class-variance-authority 的变体为组件设置默认 className。

Parameters

Collapse all

  • Component React.ComponentType | ElementType

    需要添加属性的组件。

  • variants V extends ReturnType<typeof cva>

    作为默认 className 的变体。

  • onlyVariantsProps (keyof VariantProps<V>)[]

    要从 Component 中排除的属性。设置仅用于变体的属性。

ReturnsReact.ComponentType

    包含默认 className 的新组件。

Text Aligncn