• Reference
  • Nodes
  • Components
  • Sign-in Widget

Sign-in Widget Component

Sign-in Widgets allow you to quickly add a set of sign-in providers to your application.

Properties

Visible

PropisVisible
Typeboolean
Defaulttrue

Whether or not this node is visible.

Enabled

PropisEnabled
Typeboolean
Defaulttrue

Whether or not this node is enabled.

Tooltip

Proptooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

Proptop
Typenumber
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

Propleft
Typenumber
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

Propwidth
Typestring
Default128px

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

PropminWidth
Typestring
Defaultundefined

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropmaxWidth
Typestring
Defaultundefined

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

Propheight
Typestring
Default32px

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

PropminHeight
Typestring
Defaultundefined

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropmaxHeight
Typestring
Defaultundefined

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

Propoverflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropoverflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropoverflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

Propstyles
Typestring
Default::component { } ::wrapper { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Object Fit

PropobjectFit
TypeObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down')
Defaultcover

The strategy used to set how the content of a replaced element should be resized to fit its container.

Text Color

ProptextColor
Typestring
Defaultwhite

The text color of each button's label.

Font Size

PropfontSize
TypeFontSize ('xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl')
Defaultsm

The font size of each button's label.

Border Radius

PropborderRadius
Typestring
Default6px

The radius of the rounded corners of each button's border (perimeter). Supports the same values as the corresponding CSS property.

Padding

Proppadding
Typestring
Default4px

The interior padding of each button.

Background Color

PropbackgroundColor
Typestring
Defaultpurple.700

The background color of each button.

Hover Background Color

ProphoverBackgroundColor
Typestring
Defaultundefined

The background color of each button when it is hovered over or focused.

Should Redirect

PropshouldRedirect
Typeboolean
Defaulttrue

Whether the user should be redirected back to another page on successful authentication.

Redirect Path

PropdefaultRedirectPath
Typestring
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

Handlersign-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

Handlersign-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.

Last updated on March 30, 2023