mui/material_5
API
Generated with
mui/material_5/io.github.nafg.scalajs.facades.mui/Popover/Props

Props

io.github.nafg.scalajs.facades.mui.Popover.Props
class Props extends WithChildren[VdomNode]

Attributes

Graph
Supertypes
trait WithChildren[VdomNode]
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object anchorReference extends Prop[String]

This determines which anchor prop to refer to when setting the position of the popover.

This determines which anchor prop to refer to when setting the position of the popover.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
object transitionDuration extends Prop[String | Double | Object]

Set to 'auto' to automatically calculate transition time based on height.

Set to 'auto' to automatically calculate transition time based on height.

Attributes

Supertypes
class Prop[String | Double | Object]
class Object
trait Matchable
class Any
Self type

Inherited classlikes

object dyn extends Dynamic

Attributes

Inherited from:
PropTypes
Supertypes
trait Dynamic
class Object
trait Matchable
class Any

Value members

Concrete methods

def PaperProps: Prop[Object]

Props applied to the Paper element.

Props applied to the Paper element.

This prop is an alias for slotProps.paper and will be overriden by it if both are used.

Attributes

def TransitionComponent: Prop[ElementType]

The component used for the transition. Follow this guide to learn more about the requirements for this component.

The component used for the transition. Follow this guide to learn more about the requirements for this component.

Attributes

def TransitionProps: Prop[Object]

Props applied to the transition element. By default, the element is based on this Transition component.

Props applied to the transition element. By default, the element is based on this Transition component.

Attributes

def action: Prop[Any]

A ref for imperative actions. It currently only supports updatePosition() action.

A ref for imperative actions. It currently only supports updatePosition() action.

Attributes

def anchorEl: Prop[Any]

An HTML element, PopoverVirtualElement, or a function that returns either. It's used to set the position of the popover.

An HTML element, PopoverVirtualElement, or a function that returns either. It's used to set the position of the popover.

Attributes

def anchorOrigin: Prop[Object]

This is the point on the anchor where the popover's anchorEl will attach to. This is not used when the anchorReference is 'anchorPosition'.

This is the point on the anchor where the popover's anchorEl will attach to. This is not used when the anchorReference is 'anchorPosition'.

Options: vertical: [top, center, bottom]; horizontal: [left, center, right].

Attributes

def anchorPosition: Prop[Object]

This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.

This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.

Attributes

def children: Prop[VdomNode]

The content of the component.

The content of the component.

Attributes

def classes: Prop[Object]

Override or extend the styles applied to the component.

Override or extend the styles applied to the component.

Attributes

def container: Prop[Any | Any => Any]

An HTML element, component instance, or function that returns either. The container will passed to the Modal component.

An HTML element, component instance, or function that returns either. The container will passed to the Modal component.

By default, it uses the body of the anchorEl's top-level document object, so it's simply document.body most of the time.

Attributes

def disableScrollLock: Prop[Boolean]

Disable the scroll lock behavior.

Disable the scroll lock behavior.

Attributes

def elevation: Prop[Any]

The elevation of the popover.

The elevation of the popover.

Attributes

def marginThreshold: Prop[Double]

Specifies how close to the edge of the window the popover can appear. If null, the popover will not be constrained by the window.

Specifies how close to the edge of the window the popover can appear. If null, the popover will not be constrained by the window.

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def onClose: Prop[Any => Any]

Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

Attributes

def open: Prop[Boolean]

If true, the component is shown.

If true, the component is shown.

Attributes

def slotProps: Prop[Object]

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

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

Attributes

def slots: Prop[Object]

The components used for each slot inside.

The components used for each slot inside.

Attributes

def style: Prop[Object]
def sx: Prop[Seq[Any => Any | Object | Boolean] | Any => Any | Object]

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

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

Attributes

def transformOrigin: Prop[Object]

This is the point on the popover which will attach to the anchor's origin.

This is the point on the popover which will attach to the anchor's origin.

Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)].

Attributes

Inherited methods

def of[A : Writer](implicit evidence$1: Writer[A], name: Name): Prop[A]

Attributes

Inherited from:
PropTypes

Inherited fields

val key: Prop[Key]

Attributes

Inherited from:
PropTypes
Generated with