HeroUI Provider

API 参考,用于 HeroUIProvider


导入

用法

属性

navigate

  • 描述:为所有嵌套组件(如 Link、Menu、Tabs、Table 等)提供客户端路由。
  • 类型((path: Href, routerOptions?: RouterOptions) => void) | undefined

参见路由指南

useHref

  • 描述:将提供给链接组件的 href 转换为原生 href。例如,路由器可能接受相对于基本路径的 href,或提供指定链接目标的其他自定义方式。链接上指定的原始 href 将传递给 RouterProvider 的 navigate 函数,useHref 用于生成要放在实际 DOM 元素上的完整原生 href。
  • 类型((href: Href) => string) | undefined

参见路由指南

locale

  • 描述:应用于子组件的区域设置。
  • 类型string | undefined
  • 默认值en-US

以下是支持的区域设置。默认情况下,它是 en-US

这是一个设置西班牙语区域设置的例子。

defaultDates

  • 描述:日历中可以选择的默认日期范围。
  • 类型{ minDate?: CalendarDate | undefined; maxDate?: CalendarDate | undefined; }
  • 默认值{ minDate: new CalendarDate(1900, 1, 1), maxDate: new CalendarDate(2099, 12, 31) }

createCalendar

  • 描述:此函数通过提供自定义日历系统来帮助减小捆绑包大小。

    默认情况下,这包括 @internationalized/date 支持的所有日历系统。但是,如果您的应用程序支持的区域集更有限,或者您知道您只会选择特定日历系统中的日期,则可以通过提供您自己的 createCalendar 实现(包括这些 Calendar 实现的子集)来减小捆绑包大小。

    例如,如果您的应用程序仅支持公历日期,您可以实现一个像这样的 createCalendar 函数

    这样,只会导入 GregorianCalendar,并且可以 tree-shake 其他日历实现。

  • 类型((calendar: SupportedCalendars) => Calendar | null) | undefined

disableAnimation

  • 描述:全局禁用动画。这也将避免在捆绑包中加载 framer-motion 功能,这可能会减小捆绑包大小。
  • 类型boolean
  • 默认值false

disableRipple

  • 描述:全局禁用涟漪效果。
  • 类型boolean
  • 默认值false

skipFramerMotionAnimations

  • 描述:控制是否在应用程序中跳过 framer-motion 动画。当 disableAnimation 属性设置为 true 时,此属性会自动启用 (true),从而有效地跳过所有 framer-motion 动画。要在使用 disableAnimation 属性用于其他目的时保留 framer-motion 动画,请将其设置为 false。但是,请注意,如果 disableAnimation 属性为 true,则 HeroUI 组件中的动画仍会被省略。
  • 类型boolean
  • 默认值:与 disableAnimation 相同

validationBehavior

  • 描述:当值缺失或无效时,是使用原生 HTML 表单验证来阻止表单提交,还是通过 ARIA 将字段标记为必填或无效。
  • 类型native | aria
  • 默认值aria

reducedMotion

  • 描述:控制整个应用程序的动态效果偏好设置,允许开发人员尊重用户对减少动态效果的设置。可用选项包括
    • "user":适应用户设备上减少动态效果的设置。
    • "always":禁用所有动画。
    • "never":保持所有动画处于活动状态。
  • 类型"user" | "always" | "never"
  • 默认值"never"

类型

CalendarDate

  • 描述CalendarDate 表示 @internationalized/date 中特定日历系统中不带任何时间组件的日期。
  • 类型import {CalendarDate} from '@internationalized/date';

SupportedCalendars

支持的 react-aria i18n 日历。