FileElement API

API reference docs for the React FileElement component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import { FileElement } from '@stoked-ui/sui-file-explorer/FileElement';
// or
import { FileElement } from '@stoked-ui/sui-file-explorer';

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
ContentComponent	element type	FileElementContent	The component used to render the content of the item. This needs to be able to hold a ref.
ContentProps	object	-	Props applied to ContentComponent.
disabled	bool	false	If `true`, the item is disabled.
itemId	string	-	The id of the item.
label	node	-	The tree item label.
name	string	-	The tree item label.
onFocus	unsupportedProp	-	This prop isn't supported. Use the `onItemFocus` callback on the tree if you need to monitor a item's focus.
onKeyDown	func	-	Callback fired when a key of the keyboard is pressed on the item.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

You can use MuiFileElement to change the default props of this component with the theme.

Slot name	Class name	Default component	Description
collapseIcon			The icon used to collapse the item.
expandIcon			The icon used to expand the item.
endIcon			The icon displayed next to an end item.
icon			The icon to display next to the tree item's label.
groupTransition	.MuiFileElement-groupTransition	`FileElement2Group`	The component that animates the appearance / disappearance of the item's children.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		State class applied to the element when disabled.
.Mui-expanded		State class applied to the content element when expanded.
.Mui-focused		State class applied to the content element when focused.
.Mui-selected		State class applied to the content element when selected.
.MuiFileElement-checkbox	checkbox	Styles applied to the checkbox element.
.MuiFileElement-content	content	Styles applied to the content element.
.MuiFileElement-iconContainer	iconContainer	Styles applied to the tree item icon.
.MuiFileElement-label	label	Styles applied to the label element.
.MuiFileElement-root	root	Styles applied to the root element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.