FloatingActionButtonProps
Represents the props of the KendoReact FloatingActionButton component.
Definition
Package:@progress/kendo-react-buttons
Properties
accessKey?
string
Sets the accessKey of the main button.
Specifies the alignment of the FloatingActionButton within its container. see example.
Centering the FloatingActionButton in both horizontal and vertical dimension is not a typical use case. Still, it is possible to achieve such a layout with appropriate offsets. Setting horizontal: "center" and vertical: "middle" at the same time is not supported.
The possible keys are:
horizontal— Defines the possible horizontal alignment of the FloatingActionButton.start— Uses the start point of the container.center— Uses the center point of the container.end(Default) — Uses the end point of the container
vertical— Defines the possible vertical alignment of the FloatingActionButton.top— Uses the top point of the container.middle— Uses the middle point of the container.bottom(Default) — Uses the bottom point of the container.
Specifies the horizontal and vertical offset of the FloatingActionButton. see example.
Normally, the floating button positions next to the boundaries of its container with a default offset of 16px.
Positive offsets move floating buttons, which are in a corner, further from that corner. Buttons, which are not in a corner, can be moved along the container's boundary or towards the center of the container.
A negative offset can force a button to overflow the boundaries of its container.
The possible keys are:
x— Sets the horizontal offset of the FloatingActionButton.y— Sets the vertical offset of the FloatingActionButton.
className?
string
Specifies a list of CSS classes that will be added to the Floating Action Button.
dir?
string
Represents the dir HTML attribute for text direction.
disabled?
boolean
Specifies if the FloatingActionButton is disabled.
false
icon?
string
Defines the icon that renders in the FloatingActionButton.
iconClass?
string
Defines a custom CSS class for the icon.
id?
string
Sets the id property of the root HTML element.
item?
ComponentType<FloatingActionButtonItemProps>
Overrides the default component responsible for rendering items.
Defines the collection of items rendered in the Floating Action Button.
modal?
boolean
Enables modal behavior by rendering an overlay under the Floating Action Button.
onBlur?
(event: FloatingActionButtonEvent) => void
Fires when the Floating Action Button is blurred.
onClick?
(event: FloatingActionButtonEvent) => void
Fires when the Floating Action Button is clicked.
onClose?
(event: FloatingActionButtonEvent) => void
Fires when the popup containing the items is closed.
onFocus?
(event: FloatingActionButtonEvent) => void
Fires when the Floating Action Button is focused.
onItemClick?
(event: FloatingActionButtonItemEvent) => void
Fires when a Floating Action Button item is clicked.
onKeyDown?
(event: FloatingActionButtonEvent) => void
Fires when a key is pressed while the Floating Action Button is focused.
onOpen?
(event: FloatingActionButtonEvent) => void
Fires when the popup which contains the items is opened see example.
overlayStyle?
CSSProperties
Sets styles for the overlay element when the modal prop is enabled.
Configures the popup settings for the Floating Action Button.
Specifies the position mode of the Floating Action Button. see example. It is based on the CSS position rule.
- The possible values are:
- 'fixed' (Default)
- 'absolute'
'fixed'
Configures the rounding of the Floating Action Button.
The possible values are:
smallmediumlargefullnone
undefined (theme-controlled)
Specifies the size of the FloatingActionButton. see example.
The possible values are:
small— Applies half of the default padding, e.g.8px.medium— Applies the default padding, e.g.16px.large— Applies one and one half of the default padding, e.g.24px.
undefined (theme-controlled)
style?
CSSProperties
Sets additional CSS styles to the Floating Action Button.
svgIcon?
SVGIcon
Defines the SVG icon that renders in the FloatingActionButton.
tabIndex?
number
Sets the tabIndex of the main button.
text?
string
Specifies the text of the Floating Action Button.
Configures the theme color of the FloatingActionButton. see example.
The possible values are:
base—Applies coloring based on the base theme color.primary—Applies coloring based on the primary theme color.secondary—Applies coloring based on the secondary theme color.tertiary— Applies coloring based on the tertiary theme color.
undefined (theme-controlled)