Sign-in Widget Component
Sign-in Widgets allow you to quickly add a set of sign-in providers to your application.
Properties
Visible
| Prop | isVisible |
|---|---|
| Type | boolean |
| Default | true |
Whether or not this node is visible.
Enabled
| Prop | isEnabled |
|---|---|
| Type | boolean |
| Default | true |
Whether or not this node is enabled.
Tooltip
| Prop | tooltip |
|---|---|
| Type | string |
| Default | undefined |
The tooltip text to display when hovered or focused over this node.
Top
| Prop | top |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the top side of the grid (grid-row-start).
Left
| Prop | left |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the left side of the grid (grid-column-start).
Width
| Prop | width |
|---|---|
| Type | string |
| Default | 128px |
The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.
Min Width
| Prop | minWidth |
|---|---|
| Type | string |
| Default | undefined |
The minimum width of the node. When this node is in a grid layout, this property is ignored.
Max Width
| Prop | maxWidth |
|---|---|
| Type | string |
| Default | undefined |
The maximum width of the node. When this node is in a grid layout, this property is ignored.
Height
| Prop | height |
|---|---|
| Type | string |
| Default | 32px |
The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.
Min Height
| Prop | minHeight |
|---|---|
| Type | string |
| Default | undefined |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Max Height
| Prop | maxHeight |
|---|---|
| Type | string |
| Default | undefined |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Overflow
| Prop | overflow |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.
Overflow X
| Prop | overflowX |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal axis for content that is larger than its container.
Overflow Y
| Prop | overflowY |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the vertical axis for content that is larger than its container.
Custom Styles
| Prop | styles |
|---|---|
| Type | string |
| Default | ::component { } ::wrapper { } |
Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.
Object Fit
| Prop | objectFit |
|---|---|
| Type | ObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down') |
| Default | cover |
The strategy used to set how the content of a replaced element should be resized to fit its container.
Text Color
| Prop | textColor |
|---|---|
| Type | string |
| Default | white |
The text color of each button's label.
Font Size
| Prop | fontSize |
|---|---|
| Type | FontSize ('xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl') |
| Default | sm |
The font size of each button's label.
Border Radius
| Prop | borderRadius |
|---|---|
| Type | string |
| Default | 6px |
The radius of the rounded corners of each button's border (perimeter). Supports the same values as the corresponding CSS property.
Padding
| Prop | padding |
|---|---|
| Type | string |
| Default | 4px |
The interior padding of each button.
Background Color
| Prop | backgroundColor |
|---|---|
| Type | string |
| Default | purple.700 |
The background color of each button.
Hover Background Color
| Prop | hoverBackgroundColor |
|---|---|
| Type | string |
| Default | undefined |
The background color of each button when it is hovered over or focused.
Should Redirect
| Prop | shouldRedirect |
|---|---|
| Type | boolean |
| Default | true |
Whether the user should be redirected back to another page on successful authentication.
Redirect Path
| Prop | defaultRedirectPath |
|---|---|
| Type | string |
| Default | / |
What path to send the user to upon successful authentication if the user does not have another path they were previously redirect from.
Event Handlers
On Success
| Handler | sign-inNode.onSuccess |
|---|
The event handler to be called upon the successful completion of the sign-in process. This property can be used to chain function calls.
On Failure
| Handler | sign-inNode.onFailure |
|---|
The event handler to be called upon the failure of the sign-in process. This property can be used to handle errors in function calls.