kotlin-mui-material/mui.material/BadgeOwnProps

BadgeOwnProps

external interface BadgeOwnProps : PropsWithChildren, PropsWithClassName, PropsWithSx(source)

Inheritors

Types

Link copied to clipboard
interface Components
Link copied to clipboard
interface SlotProps
Link copied to clipboard
interface Slots

Properties

Link copied to clipboard
abstract var anchorOrigin: BadgeOrigin?

The anchor of the badge.

Link copied to clipboard
abstract var badgeContent: ReactNode?

The content rendered within the badge.

Link copied to clipboard
abstract override var children: ReactNode?

The badge will be added relative to this node.

Link copied to clipboard
abstract var classes: BadgeClasses?

Override or extend the styles applied to the component.

Link copied to clipboard
abstract override var className: ClassName?
Link copied to clipboard
abstract var color: BadgeColor?

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Link copied to clipboard
abstract var components: BadgeOwnProps.Components?

The components used for each slot inside.

Link copied to clipboard
abstract var componentsProps: BadgeOwnProps.SlotProps?

The extra props for the slot components. You can override the existing props or add new ones.

Link copied to clipboard
abstract var invisible: Boolean?

If true, the badge is invisible.

Link copied to clipboard
abstract var key: Key?
Link copied to clipboard
abstract var max: Number?

Max count to show.

Link copied to clipboard
abstract var overlap: BadgeOverlap?

Wrapped shape the badge should overlap.

Link copied to clipboard
abstract var showZero: Boolean?

Controls whether the badge is hidden when badgeContent is zero.

Link copied to clipboard
abstract var slotProps: BadgeOwnProps.SlotProps?

The props used for each slot inside the Badge.

Link copied to clipboard
abstract var slots: BadgeOwnProps.Slots?

The components used for each slot inside the Badge. Either a string to use a HTML element or a component.

Link copied to clipboard
abstract override var sx: SxProps<Theme>?

The system prop that allows defining system overrides as well as additional CSS styles.

Link copied to clipboard
abstract var variant: BadgeVariant?

The variant to use.

Functions

Link copied to clipboard
open inline fun <P : Props> child(type: ElementType<P>, props: P)
Link copied to clipboard
open inline operator fun <P : Props> ElementType<P>.invoke()
open inline operator fun <T> ContextType<T>.invoke(noinline block: ProviderProps<T>.() -> Unit)
open inline operator fun <P : Props> ElementType<P>.invoke(noinline block: P.() -> Unit)
open inline operator fun <T> ContextType<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)
open inline operator fun <T> Provider<T>.invoke(value: T, noinline block: ChildrenBuilder.() -> Unit)
Link copied to clipboard
open inline operator fun Char.unaryPlus()
open inline operator fun String?.unaryPlus()
open inline operator fun ReactNode?.unaryPlus()
open inline operator fun Props?.unaryPlus()