SimpleTreeViewAPI

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

示範

如需此 React 元件的使用範例和詳細資訊，請造訪元件示範頁面

匯入

import { SimpleTreeView } from '@mui/x-tree-view/SimpleTreeView';
// or
import { SimpleTreeView } from '@mui/x-tree-view';
// or
import { SimpleTreeView } from '@mui/x-tree-view-pro';

若要瞭解差異，請閱讀此關於最小化套件大小的指南。

Props

原生元件的 Props 也可用。

名稱	類型	預設值	描述
apiRef	{ current?: { focusItem: func, getItem: func, getItemDOMElement: func, getItemOrderedChildrenIds: func, getItemTree: func, selectItem: func, setItemExpansion: func } }	-	允許樹狀檢視操作的 ref 物件。可以使用 `useTreeViewApiRef()` 進行實例化。
checkboxSelection	bool	false	如果為 `true`，樹狀檢視會在標籤左側呈現核取方塊，以允許選取。
children	node	-	元件的內容。
classes	object	-	覆寫或擴充套用至元件的樣式。請參閱下方CSS 類別 API 以取得更多詳細資訊。
defaultExpandedItems	Array<string>	[]	展開的項目 ID。當項目的展開未受控制時使用。
defaultSelectedItems	any	[]	選取的項目 ID。（非受控）當 `multiSelect` 為 true 時，這會採用字串陣列；當為 false（預設值）時，則為字串。
disabledItemsFocusable	bool	false	如果為 `true`，將允許焦點放在停用的項目上。
disableSelection	bool	false	如果為 `true`，則停用選取。
expandedItems	Array<string>	-	展開的項目 ID。當項目的展開受控制時使用。
expansionTrigger	'content' \| 'iconContainer'	'content'	點擊時觸發項目展開的 slot。
experimentalFeatures	{ indentationAtItemLevel?: bool }	-	不穩定的功能，可能會引入重大變更。對於每個功能，如果未明確將旗標設定為 `true`，則該功能將完全停用，且任何屬性/方法呼叫將不會產生任何效果。
id	string	-	此 prop 用於協助實作無障礙功能邏輯。如果您未提供此 prop。它會回復為隨機產生的 ID。
itemChildrenIndentation	number \| string	12px	項目及其子項目之間的水平縮排。範例：24、"24px"、"2rem"、"2em"。
multiSelect	bool	false	如果為 `true`，`ctrl` 和 `shift` 將觸發多重選取。
onExpandedItemsChange	func	-	當樹狀項目展開/摺疊時觸發的回呼。簽名：`function(event: React.SyntheticEvent, itemIds: array) => void` `event` 觸發變更的 DOM 事件。 `itemIds` 展開項目的 ID。
onItemClick	func	-	當點擊給定樹狀項目的 `content` slot 時觸發的回呼。簽名：`function(event: React.MouseEvent, itemId: string) => void` `event` 觸發變更的 DOM 事件。 `itemId` 焦點項目的 ID。
onItemExpansionToggle	func	-	當樹狀項目展開或摺疊時觸發的回呼。簽名：`function(event: React.SyntheticEvent, itemId: array, isExpanded: array) => void` `event` 觸發變更的 DOM 事件。 `itemId` 修改項目的 itemId。 `isExpanded` 如果項目剛展開則為 `true`，如果剛摺疊則為 `false`。
onItemFocus	func	-	當給定樹狀項目取得焦點時觸發的回呼。簽名：`function(event: React.SyntheticEvent \| null, itemId: string) => void` `event` 觸發變更的 DOM 事件。警告：這是一般事件，而非焦點事件。 `itemId` 焦點項目的 ID。
onItemSelectionToggle	func	-	當樹狀項目被選取或取消選取時觸發的回呼。簽名：`function(event: React.SyntheticEvent, itemId: array, isSelected: array) => void` `event` 觸發變更的 DOM 事件。 `itemId` 修改項目的 itemId。 `isSelected` 如果項目剛被選取則為 `true`，如果剛被取消選取則為 `false`。
onSelectedItemsChange	func	-	當樹狀項目被選取/取消選取時觸發的回呼。簽名：`function(event: React.SyntheticEvent, itemIds: Array \| string) => void` `event` 觸發變更的 DOM 事件。 `itemIds` 選取項目的 ID。當 `multiSelect` 為 `true` 時，這是字串陣列；當為 false（預設值）時，則為字串。
selectedItems	any	-	選取的項目 ID。（受控）當 `multiSelect` 為 true 時，這會採用字串陣列；當為 false（預設值）時，則為字串。
slotProps	object	-	用於每個元件 slot 的 props。
slots	object	-	可覆寫的元件 slot。請參閱下方Slots API 以取得更多詳細資訊。
sx	Array<func \| object \| bool> \| func \| object	-	允許定義系統覆寫以及其他 CSS 樣式的系統 prop。請參閱 `sx` 頁面以取得更多詳細資訊。

ref 會轉發到根元素。

主題預設 props

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

Slots

Slot 名稱	類別名稱	預設元件	描述
root	.MuiSimpleTreeView-root	`SimpleTreeViewRoot`	在根目錄呈現的元素。
collapseIcon			用於摺疊項目的預設圖示。
expandIcon			用於展開項目的預設圖示。
endIcon			顯示在結束項目旁邊的預設圖示。這會套用至所有樹狀項目，並且可以由 TreeItem `icon` slot prop 覆寫。

原始碼

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