NextUI Provider
針對 NextUIProvider 的 API 參考。
匯入
使用方式
屬性
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實作（包含這些日曆實作的子集）來縮減套件大小。例如，如果您的應用程式僅支援格里曆日期，您可以實作如下的
createCalendar函式這樣一來，只會匯入 GregorianCalendar，而其他日曆實作可以進行搖樹最佳化。
-
類型：
((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，則 NextUI 元件中的動畫仍會被省略。 - 類型：
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';
支援的曆法
支援 react-aria i18n 曆法。
