RadioAPI

React Radio 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。

範例

有關此 React 元件用法的範例和詳細資訊，請造訪元件示範頁面

Radio

Import

import Radio from '@mui/joy/Radio';
// or
import { Radio } from '@mui/joy';

透過閱讀這篇關於最小化 bundle size 的指南，瞭解它們之間的差異。

Props

名稱	類型	預設值	描述
checked	bool	-	若為 `true`，元件會被勾選。
checkedIcon	node	-	元件被勾選時要顯示的圖示。
className	string	-	套用至根元素的類別名稱。
color	'danger' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	元件的顏色。它支援適用於此元件的主題顏色。若要瞭解如何新增自己的顏色，請查看主題元件—擴充顏色。
component	elementType	-	用於根節點的元件。可以是使用 HTML 元素的字串或元件。
defaultChecked	bool	-	預設的勾選狀態。當元件不受控制時使用。
disabled	bool	-	若為 `true`，元件會停用。
disableIcon	bool	false	若為 `true`，則會移除勾選的圖示，並改為在 `action` 元素上套用選取的 variant。
label	node	-	radio 結尾的 label 元素。
name	string	-	input 的 `name` 屬性。
onChange	func	-	狀態變更時觸發的回呼函數。簽名：`function(event: React.ChangeEvent) => void` `event` 回呼的事件來源。您可以透過存取 `event.target.value` (字串) 來取出新值。您可以透過存取 `event.target.checked` (布林值) 來取出新的勾選狀態。
overlay	bool	false	若為 `true`，根元素的位置會設定為 initial，讓 action 區域填滿最近的已定位父元素。此 prop 適用於將 Radio 與 ListItem 元件組合。
readOnly	bool	-	若為 `true`，元件為唯讀。
required	bool	-	若為 `true`，則 `input` 元素為必填。
size	'sm' \| 'md' \| 'lg' \| string	'md'	元件的尺寸。若要瞭解如何將自訂尺寸新增至元件，請查看主題元件—擴充尺寸。
slotProps	{ action?: func \| object, icon?: func \| object, input?: func \| object, label?: func \| object, radio?: func \| object, root?: func \| object }	{}	用於每個內部 slot 的 props。
slots	{ action?: elementType, icon?: elementType, input?: elementType, label?: elementType, radio?: elementType, root?: elementType }	{}	用於每個內部 slot 的元件。請參閱下方Slots API 以瞭解更多詳細資訊。
sx	Array<func \| object \| bool> \| func \| object	-	系統 prop，允許定義系統覆寫以及額外的 CSS 樣式。請參閱 `sx` 頁面以瞭解更多詳細資訊。
uncheckedIcon	node	-	元件未勾選時要顯示的圖示。
value	any	-	元件的值。DOM API 會將此值轉換為字串。
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'outlined'	要使用的全域 variant。若要瞭解如何新增自己的 variants，請查看主題元件—擴充 variants。

ref 會轉發到根元素。

主題預設 props

您可以使用 JoyRadio 來變更此元件的預設 props 透過主題。

Slots

若要瞭解如何自訂 slot，請查看覆寫元件結構指南。

Slot 名稱	類別名稱	預設元件	描述
root	.MuiRadio-root	`'span'`	呈現根元件的元件。
radio	.MuiRadio-radio	`'span'`	呈現 radio 的元件。
icon	.MuiRadio-icon	`'span'`	呈現圖示的元件。
action	.MuiRadio-action	`'span'`	呈現 action 的元件。
input	.MuiRadio-input	`'input'`	呈現 input 的元件。
label	.MuiRadio-label	`'label'`	呈現 label 的元件。

CSS 類別

這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時，它們會套用至元件的 slots。

類別名稱	規則名稱	描述
.Mui-checked		若 `checked`，則套用至 root、action slots 的狀態類別。
.Mui-disabled		若 `disabled`，則套用至 root、action slots 的狀態類別。
.Mui-focusVisible		若 switch 具有可見焦點，則套用至根元素的類別名稱
.MuiRadio-colorContext	colorContext	當觸發色彩反轉時，套用至根元素的類別名稱。
.MuiRadio-colorDanger	colorDanger	若 `color="danger"`，則套用至根元素的類別名稱。
.MuiRadio-colorNeutral	colorNeutral	若 `color="neutral"`，則套用至根元素的類別名稱。
.MuiRadio-colorPrimary	colorPrimary	若 `color="primary"`，則套用至根元素的類別名稱。
.MuiRadio-colorSuccess	colorSuccess	若 `color="success"`，則套用至根元素的類別名稱。
.MuiRadio-colorWarning	colorWarning	若 `color="warning"`，則套用至根元素的類別名稱。
.MuiRadio-sizeLg	sizeLg	若 `size="lg"`，則套用至根元素的類別名稱。
.MuiRadio-sizeMd	sizeMd	若 `size="md"`，則套用至根元素的類別名稱。
.MuiRadio-sizeSm	sizeSm	若 `size="sm"`，則套用至根元素的類別名稱。
.MuiRadio-variantOutlined	variantOutlined	若 `variant="outlined"`，則套用至根元素的類別名稱。
.MuiRadio-variantSoft	variantSoft	若 `variant="soft"`，則套用至根元素的類別名稱。
.MuiRadio-variantSolid	variantSolid	若 `variant="solid"`，則套用至根元素的類別名稱。

您可以使用以下其中一種自訂選項來覆寫元件的樣式

使用全域類別名稱。
在自訂主題中使用規則名稱作為元件 styleOverrides 屬性的一部分。

原始碼

如果您在此頁面中找不到資訊，請考慮查看元件的實作以取得更多詳細資訊。