kotlin-mui-material/mui.material/BadgeProps

BadgeProps

external interface BadgeProps : BadgeOwnProps, HTMLAttributes<HTMLSpanElement> , PropsWithComponent(source)

Properties

about

abstract var about: String?

accessKey

abstract var accessKey: String?

anchorOrigin

abstract var anchorOrigin: BadgeOrigin?

The anchor of the badge.

autoCapitalize

abstract var autoCapitalize: String?

autoCorrect

abstract var autoCorrect: String?

autoFocus

abstract var autoFocus: Boolean?

autoSave

abstract var autoSave: String?

badgeContent

abstract var badgeContent: ReactNode?

The content rendered within the badge.

children

abstract override var children: ReactNode?

The badge will be added relative to this node.

classes

abstract var classes: BadgeClasses?

Override or extend the styles applied to the component.

className

abstract override var className: ClassName?

color

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.

component

abstract var component: ElementType<*>?

components

abstract var components: BadgeOwnProps.Components?

The components used for each slot inside.

componentsProps

abstract var componentsProps: BadgeOwnProps.SlotProps?

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

content

abstract var content: String?

contentEditable

abstract var contentEditable: Any?

contextMenu

abstract var contextMenu: String?

dangerouslySetInnerHTML

abstract var dangerouslySetInnerHTML: DangerouslySetInnerHTML?

datatype

abstract var datatype: String?

defaultChecked

abstract var defaultChecked: Boolean?

defaultValue

abstract var defaultValue: Any?

dir

abstract var dir: String?

draggable

abstract var draggable: Boolean?

enterKeyHint

abstract var enterKeyHint: EnterKeyHint?

hidden

abstract var hidden: Boolean?

abstract var id: String?

inlist

abstract var inlist: Any?

inputMode

abstract var inputMode: InputMode?

invisible

abstract var invisible: Boolean?

If true, the badge is invisible.

abstract var is: String?

itemID

abstract var itemID: String?

itemProp

abstract var itemProp: String?

itemRef

abstract var itemRef: String?

itemScope

abstract var itemScope: Boolean?

itemType

abstract var itemType: String?

key

abstract var key: Key?

lang

abstract var lang: String?

max

abstract var max: Number?

Max count to show.

nonce

abstract var nonce: String?

onAbort

abstract var onAbort: ReactEventHandler<HTMLSpanElement>?

onAbortCapture

abstract var onAbortCapture: ReactEventHandler<HTMLSpanElement>?

onAnimationEnd

abstract var onAnimationEnd: AnimationEventHandler<HTMLSpanElement>?

onAnimationEndCapture

abstract var onAnimationEndCapture: AnimationEventHandler<HTMLSpanElement>?

onAnimationIteration

abstract var onAnimationIteration: AnimationEventHandler<HTMLSpanElement>?

onAnimationIterationCapture

abstract var onAnimationIterationCapture: AnimationEventHandler<HTMLSpanElement>?

onAnimationStart

abstract var onAnimationStart: AnimationEventHandler<HTMLSpanElement>?

onAnimationStartCapture

abstract var onAnimationStartCapture: AnimationEventHandler<HTMLSpanElement>?

onAuxClick

abstract var onAuxClick: MouseEventHandler<HTMLSpanElement>?

onAuxClickCapture

abstract var onAuxClickCapture: MouseEventHandler<HTMLSpanElement>?

onBeforeInput

abstract var onBeforeInput: FormEventHandler<HTMLSpanElement>?

onBeforeInputCapture

abstract var onBeforeInputCapture: FormEventHandler<HTMLSpanElement>?

onBlur

abstract var onBlur: FocusEventHandler<HTMLSpanElement>?

onBlurCapture

abstract var onBlurCapture: FocusEventHandler<HTMLSpanElement>?

onCanPlay

abstract var onCanPlay: ReactEventHandler<HTMLSpanElement>?

onCanPlayCapture

abstract var onCanPlayCapture: ReactEventHandler<HTMLSpanElement>?

onCanPlayThrough

abstract var onCanPlayThrough: ReactEventHandler<HTMLSpanElement>?

onCanPlayThroughCapture

abstract var onCanPlayThroughCapture: ReactEventHandler<HTMLSpanElement>?

onChangeCapture

abstract var onChangeCapture: FormEventHandler<HTMLSpanElement>?

onClick

abstract var onClick: MouseEventHandler<HTMLSpanElement>?

onClickCapture

abstract var onClickCapture: MouseEventHandler<HTMLSpanElement>?

onCompositionEnd

abstract var onCompositionEnd: CompositionEventHandler<HTMLSpanElement>?

onCompositionEndCapture

abstract var onCompositionEndCapture: CompositionEventHandler<HTMLSpanElement>?

onCompositionStart

abstract var onCompositionStart: CompositionEventHandler<HTMLSpanElement>?

onCompositionStartCapture

abstract var onCompositionStartCapture: CompositionEventHandler<HTMLSpanElement>?

onCompositionUpdate

abstract var onCompositionUpdate: CompositionEventHandler<HTMLSpanElement>?

onCompositionUpdateCapture

abstract var onCompositionUpdateCapture: CompositionEventHandler<HTMLSpanElement>?

onContextMenu

abstract var onContextMenu: MouseEventHandler<HTMLSpanElement>?

onContextMenuCapture

abstract var onContextMenuCapture: MouseEventHandler<HTMLSpanElement>?

onCopy

abstract var onCopy: ClipboardEventHandler<HTMLSpanElement>?

onCopyCapture

abstract var onCopyCapture: ClipboardEventHandler<HTMLSpanElement>?

onCut

abstract var onCut: ClipboardEventHandler<HTMLSpanElement>?

onCutCapture

abstract var onCutCapture: ClipboardEventHandler<HTMLSpanElement>?

onDoubleClick

abstract var onDoubleClick: MouseEventHandler<HTMLSpanElement>?

onDoubleClickCapture

abstract var onDoubleClickCapture: MouseEventHandler<HTMLSpanElement>?

onDrag

abstract var onDrag: DragEventHandler<HTMLSpanElement>?

onDragCapture

abstract var onDragCapture: DragEventHandler<HTMLSpanElement>?

onDragEnd

abstract var onDragEnd: DragEventHandler<HTMLSpanElement>?

onDragEndCapture

abstract var onDragEndCapture: DragEventHandler<HTMLSpanElement>?

onDragEnter

abstract var onDragEnter: DragEventHandler<HTMLSpanElement>?

onDragEnterCapture

abstract var onDragEnterCapture: DragEventHandler<HTMLSpanElement>?

onDragExit

abstract var onDragExit: DragEventHandler<HTMLSpanElement>?

onDragExitCapture

abstract var onDragExitCapture: DragEventHandler<HTMLSpanElement>?

onDragLeave

abstract var onDragLeave: DragEventHandler<HTMLSpanElement>?

onDragLeaveCapture

abstract var onDragLeaveCapture: DragEventHandler<HTMLSpanElement>?

onDragOver

abstract var onDragOver: DragEventHandler<HTMLSpanElement>?

onDragOverCapture

abstract var onDragOverCapture: DragEventHandler<HTMLSpanElement>?

onDragStart

abstract var onDragStart: DragEventHandler<HTMLSpanElement>?

onDragStartCapture

abstract var onDragStartCapture: DragEventHandler<HTMLSpanElement>?

onDrop

abstract var onDrop: DragEventHandler<HTMLSpanElement>?

onDropCapture

abstract var onDropCapture: DragEventHandler<HTMLSpanElement>?

onDurationChange

abstract var onDurationChange: ReactEventHandler<HTMLSpanElement>?

onDurationChangeCapture

abstract var onDurationChangeCapture: ReactEventHandler<HTMLSpanElement>?

onEmptied

abstract var onEmptied: ReactEventHandler<HTMLSpanElement>?

onEmptiedCapture

abstract var onEmptiedCapture: ReactEventHandler<HTMLSpanElement>?

onEncrypted

abstract var onEncrypted: ReactEventHandler<HTMLSpanElement>?

onEncryptedCapture

abstract var onEncryptedCapture: ReactEventHandler<HTMLSpanElement>?

onEnded

abstract var onEnded: ReactEventHandler<HTMLSpanElement>?

onEndedCapture

abstract var onEndedCapture: ReactEventHandler<HTMLSpanElement>?

onError

abstract var onError: ReactEventHandler<HTMLSpanElement>?

onErrorCapture

abstract var onErrorCapture: ReactEventHandler<HTMLSpanElement>?

onFocus

abstract var onFocus: FocusEventHandler<HTMLSpanElement>?

onFocusCapture

abstract var onFocusCapture: FocusEventHandler<HTMLSpanElement>?

onGotPointerCapture

abstract var onGotPointerCapture: PointerEventHandler<HTMLSpanElement>?

onGotPointerCaptureCapture

abstract var onGotPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>?

onInput

abstract var onInput: FormEventHandler<HTMLSpanElement>?

onInputCapture

abstract var onInputCapture: FormEventHandler<HTMLSpanElement>?

onInvalid

abstract var onInvalid: FormEventHandler<HTMLSpanElement>?

onInvalidCapture

abstract var onInvalidCapture: FormEventHandler<HTMLSpanElement>?

onKeyDown

abstract var onKeyDown: KeyboardEventHandler<HTMLSpanElement>?

onKeyDownCapture

abstract var onKeyDownCapture: KeyboardEventHandler<HTMLSpanElement>?

onKeyUp

abstract var onKeyUp: KeyboardEventHandler<HTMLSpanElement>?

onKeyUpCapture

abstract var onKeyUpCapture: KeyboardEventHandler<HTMLSpanElement>?

onLoad

abstract var onLoad: ReactEventHandler<HTMLSpanElement>?

onLoadCapture

abstract var onLoadCapture: ReactEventHandler<HTMLSpanElement>?

onLoadedData

abstract var onLoadedData: ReactEventHandler<HTMLSpanElement>?

onLoadedDataCapture

abstract var onLoadedDataCapture: ReactEventHandler<HTMLSpanElement>?

onLoadedMetadata

abstract var onLoadedMetadata: ReactEventHandler<HTMLSpanElement>?

onLoadedMetadataCapture

abstract var onLoadedMetadataCapture: ReactEventHandler<HTMLSpanElement>?

onLoadStart

abstract var onLoadStart: ReactEventHandler<HTMLSpanElement>?

onLoadStartCapture

abstract var onLoadStartCapture: ReactEventHandler<HTMLSpanElement>?

onLostPointerCapture

abstract var onLostPointerCapture: PointerEventHandler<HTMLSpanElement>?

onLostPointerCaptureCapture

abstract var onLostPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>?

onMouseDown

abstract var onMouseDown: MouseEventHandler<HTMLSpanElement>?

onMouseDownCapture

abstract var onMouseDownCapture: MouseEventHandler<HTMLSpanElement>?

onMouseEnter

abstract var onMouseEnter: MouseEventHandler<HTMLSpanElement>?

onMouseLeave

abstract var onMouseLeave: MouseEventHandler<HTMLSpanElement>?

onMouseMove

abstract var onMouseMove: MouseEventHandler<HTMLSpanElement>?

onMouseMoveCapture

abstract var onMouseMoveCapture: MouseEventHandler<HTMLSpanElement>?

onMouseOut

abstract var onMouseOut: MouseEventHandler<HTMLSpanElement>?

onMouseOutCapture

abstract var onMouseOutCapture: MouseEventHandler<HTMLSpanElement>?

onMouseOver

abstract var onMouseOver: MouseEventHandler<HTMLSpanElement>?

onMouseOverCapture

abstract var onMouseOverCapture: MouseEventHandler<HTMLSpanElement>?

onMouseUp

abstract var onMouseUp: MouseEventHandler<HTMLSpanElement>?

onMouseUpCapture

abstract var onMouseUpCapture: MouseEventHandler<HTMLSpanElement>?

onPaste

abstract var onPaste: ClipboardEventHandler<HTMLSpanElement>?

onPasteCapture

abstract var onPasteCapture: ClipboardEventHandler<HTMLSpanElement>?

onPause

abstract var onPause: ReactEventHandler<HTMLSpanElement>?

onPauseCapture

abstract var onPauseCapture: ReactEventHandler<HTMLSpanElement>?

onPlay

abstract var onPlay: ReactEventHandler<HTMLSpanElement>?

onPlayCapture

abstract var onPlayCapture: ReactEventHandler<HTMLSpanElement>?

onPlaying

abstract var onPlaying: ReactEventHandler<HTMLSpanElement>?

onPlayingCapture

abstract var onPlayingCapture: ReactEventHandler<HTMLSpanElement>?

onPointerCancel

abstract var onPointerCancel: PointerEventHandler<HTMLSpanElement>?

onPointerCancelCapture

abstract var onPointerCancelCapture: PointerEventHandler<HTMLSpanElement>?

onPointerDown

abstract var onPointerDown: PointerEventHandler<HTMLSpanElement>?

onPointerDownCapture

abstract var onPointerDownCapture: PointerEventHandler<HTMLSpanElement>?

onPointerEnter

abstract var onPointerEnter: PointerEventHandler<HTMLSpanElement>?

onPointerLeave

abstract var onPointerLeave: PointerEventHandler<HTMLSpanElement>?

onPointerMove

abstract var onPointerMove: PointerEventHandler<HTMLSpanElement>?

onPointerMoveCapture

abstract var onPointerMoveCapture: PointerEventHandler<HTMLSpanElement>?

onPointerOut

abstract var onPointerOut: PointerEventHandler<HTMLSpanElement>?

onPointerOutCapture

abstract var onPointerOutCapture: PointerEventHandler<HTMLSpanElement>?

onPointerOver

abstract var onPointerOver: PointerEventHandler<HTMLSpanElement>?

onPointerOverCapture

abstract var onPointerOverCapture: PointerEventHandler<HTMLSpanElement>?

onPointerUp

abstract var onPointerUp: PointerEventHandler<HTMLSpanElement>?

onPointerUpCapture

abstract var onPointerUpCapture: PointerEventHandler<HTMLSpanElement>?

onProgress

abstract var onProgress: ReactEventHandler<HTMLSpanElement>?

onProgressCapture

abstract var onProgressCapture: ReactEventHandler<HTMLSpanElement>?

onRateChange

abstract var onRateChange: ReactEventHandler<HTMLSpanElement>?

onRateChangeCapture

abstract var onRateChangeCapture: ReactEventHandler<HTMLSpanElement>?

onReset

abstract var onReset: FormEventHandler<HTMLSpanElement>?

onResetCapture

abstract var onResetCapture: FormEventHandler<HTMLSpanElement>?

onResize

abstract var onResize: ReactEventHandler<HTMLSpanElement>?

onResizeCapture

abstract var onResizeCapture: ReactEventHandler<HTMLSpanElement>?

onScroll

abstract var onScroll: UIEventHandler<HTMLSpanElement>?

onScrollCapture

abstract var onScrollCapture: UIEventHandler<HTMLSpanElement>?

onSeeked

abstract var onSeeked: ReactEventHandler<HTMLSpanElement>?

onSeekedCapture

abstract var onSeekedCapture: ReactEventHandler<HTMLSpanElement>?

onSeeking

abstract var onSeeking: ReactEventHandler<HTMLSpanElement>?

onSeekingCapture

abstract var onSeekingCapture: ReactEventHandler<HTMLSpanElement>?

onSelect

abstract var onSelect: ReactEventHandler<HTMLSpanElement>?

onSelectCapture

abstract var onSelectCapture: ReactEventHandler<HTMLSpanElement>?

onStalled

abstract var onStalled: ReactEventHandler<HTMLSpanElement>?

onStalledCapture

abstract var onStalledCapture: ReactEventHandler<HTMLSpanElement>?

onSubmit

abstract var onSubmit: FormEventHandler<HTMLSpanElement>?

onSubmitCapture

abstract var onSubmitCapture: FormEventHandler<HTMLSpanElement>?

onSuspend

abstract var onSuspend: ReactEventHandler<HTMLSpanElement>?

onSuspendCapture

abstract var onSuspendCapture: ReactEventHandler<HTMLSpanElement>?

onTimeUpdate

abstract var onTimeUpdate: ReactEventHandler<HTMLSpanElement>?

onTimeUpdateCapture

abstract var onTimeUpdateCapture: ReactEventHandler<HTMLSpanElement>?

onTouchCancel

abstract var onTouchCancel: TouchEventHandler<HTMLSpanElement>?

onTouchCancelCapture

abstract var onTouchCancelCapture: TouchEventHandler<HTMLSpanElement>?

onTouchEnd

abstract var onTouchEnd: TouchEventHandler<HTMLSpanElement>?

onTouchEndCapture

abstract var onTouchEndCapture: TouchEventHandler<HTMLSpanElement>?

onTouchMove

abstract var onTouchMove: TouchEventHandler<HTMLSpanElement>?

onTouchMoveCapture

abstract var onTouchMoveCapture: TouchEventHandler<HTMLSpanElement>?

onTouchStart

abstract var onTouchStart: TouchEventHandler<HTMLSpanElement>?

onTouchStartCapture

abstract var onTouchStartCapture: TouchEventHandler<HTMLSpanElement>?

onTransitionEnd

abstract var onTransitionEnd: TransitionEventHandler<HTMLSpanElement>?

onTransitionEndCapture

abstract var onTransitionEndCapture: TransitionEventHandler<HTMLSpanElement>?

onVolumeChange

abstract var onVolumeChange: ReactEventHandler<HTMLSpanElement>?

onVolumeChangeCapture

abstract var onVolumeChangeCapture: ReactEventHandler<HTMLSpanElement>?

onWaiting

abstract var onWaiting: ReactEventHandler<HTMLSpanElement>?

onWaitingCapture

abstract var onWaitingCapture: ReactEventHandler<HTMLSpanElement>?

onWheel

abstract var onWheel: WheelEventHandler<HTMLSpanElement>?

onWheelCapture

abstract var onWheelCapture: WheelEventHandler<HTMLSpanElement>?

overlap

abstract var overlap: BadgeOverlap?

Wrapped shape the badge should overlap.

prefix

abstract var prefix: String?

property

abstract var property: String?

radioGroup

abstract var radioGroup: String?

ref

abstract var ref: Ref<HTMLSpanElement>?

rel

abstract var rel: String?

resource

abstract var resource: String?

results

abstract var results: String?

rev

abstract var rev: String?

role

abstract var role: AriaRole?

security

abstract var security: String?

showZero

abstract var showZero: Boolean?

Controls whether the badge is hidden when badgeContent is zero.

slot

abstract var slot: String?

slotProps

abstract var slotProps: BadgeOwnProps.SlotProps?

The props used for each slot inside the Badge.

slots

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.

spellCheck

abstract var spellCheck: Boolean?

style

abstract override var style: CSSProperties?

suppressContentEditableWarning

abstract var suppressContentEditableWarning: Boolean?

suppressHydrationWarning

abstract var suppressHydrationWarning: Boolean?

abstract override var sx: SxProps<Theme>?

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

tabIndex

abstract var tabIndex: Int?

title

abstract var title: String?

translate

abstract var translate: Translate?

typeof

abstract var typeof: String?

unselectable

abstract var unselectable: Unselectable?

variant

abstract var variant: BadgeVariant?

The variant to use.

vocab

abstract var vocab: String?

Functions

child

open inline fun child(type: ElementType, props: P)

invoke

open inline operator fun ElementType.invoke()

open inline operator fun <T> ContextType<T>.invoke(noinline block: ProviderProps<T>.() -> Unit)

open inline operator fun ElementType.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)

unaryPlus

open inline operator fun Char.unaryPlus()

open inline operator fun String?.unaryPlus()

open inline operator fun ReactNode?.unaryPlus()

open inline operator fun Props?.unaryPlus()