# Form Button ## Basic #### Text The text is displayed on the body of the button. It is recommended to use a short string for the text, as the button is used for triggering a command or action.

## Interaction #### Type | Properties | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------- | | `Default` | Acts as a normal button, that triggers the specified action on the click event. | | `Submit` |

Users will need to pick an existing form from the list and the button commands to submit the form selected.

| `Default` and `Submit` types are explained in the sections below. ### Default #### Event Handlers **`Click`** - This is triggered when this is used as a default button and the user clicks on it.

#### Disabled Disables the user interaction with the element on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied.

#### Hide This sets whether the widget has to be displayed on the screen when the program is loaded. This shows/hides the widget both on desktop and mobile devices.

#### Loading It will be useful when there is a process to be carried out, like running a query to fetch data, before the widget is loaded. The `loading` boolean value can be utilized to show the spinner till the process is complete.

#### Alignment | Property | Layout | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | |

| `Left` - The content is attached to the left side of the widget | |

| `Center` - The content is placed at the center part of the widget | |

| `Right` - The content is attached to the right side of the widget | ### Submit 'Form to Submit' will show the list of forms and the user needs to choose one to attach to the widget.

Once the form has been linked, define the submit event. This will be triggered when the user clicks the button.

## Layout #### Prefix Icon Choose one from the set of icons that will be displayed as a prefix logo, just before the button text.

#### Suffix Icon Choose one from the set of icons that will be displayed as a suffix logo, just after the logo text.

#### Tooltip Tooltips display additional information upon mouse hover. This information will be contextual, useful, and informative. The tooltip will be immediately shown when the user's mouse hovers over the widget, and immediately hides when the user's mouse leaves.

#### Placement Refers to the position of the tooltip. | Property | Description | | ----------- | ---------------------------------------------------------------------------------- | | top | Tooltip is placed at the top of the widget | | left | Tooltip is placed to the left side of the widget | | bottom | Tooltip is placed at the bottom of the widget | | right | Tooltip is placed to the right side of the widget | | topLeft | Tooltip is placed at the top left corner of the widget | | topRight | Tooltip is placed at the top right corner of the widget | | bottomLeft | Tooltip is placed at the bottom left corner of the widget | | bottomRight | Tooltip is placed at the bottom right corner of the widget | | leftTop | Tooltip is positioned primarily to the left and slightly above the target element | | leftBottom | Tooltip positioned at the left bottom of its target | | rightTop | Tooltip is positioned primarily to the right and slightly above the target element | | rightBottom | Tooltip positioned at the right bottom of its target | #### Custom CSS Users can write a specific style using CSS syntax here and the style text will be applied to the widget when the program is loaded.

#### Height | | | | ----- | ------------------------------------------- | | Auto | The height is auto-adjusted for the content | | Fixed | The height of the widget is fixed | ## Style

Property	Description
Background	Users can change the colour of the text background using this property. It has all the RGB colour ranges to pick from. It is recommended to use a corresponding background colour that shows the font clearly.
Hover Color	Refers to the specific color that is displayed when a user hovers their cursor over the widget.
Hover Border Color	Refers to the color that is displayed on the border of the widget when a user hovers their cursor.
Box Shadow	The is the colour of the shadow that is generated behind the widget box. The X and Y axis values can be altered such that the shadow can be set to fall anywhere behind the widget area. "x-offset" - a positive number specifies the shadow will be on the right of the box, and a negative number will put the shadow on the left of the box. "y-offset" - a negative one means the shadow will be above the box, and a positive number means the shadow will be below the box. "Blur" - if the number is set to 0 then the shadow will be sharp. It will more blurred as the number goes higher, and the shadow will extend further away. "Color" - sets the colour of the shadow. If the colour is not set, the box shadows are drawn in the foreground colour.
Text	Set the colour of the text. Recommended to set in contrast with the background.
Loader Color	Pick the colour to the loading spinner when the component shows the loader before getting displayed.
Prefix Icon Color	Choose a specific color for the icon that appears before the actual widget content.
Suffix Icon Color	Choose a specific color for the icon that appears after the actual widget content.
Prefix Icon Size	Set the size of the prefix icon in px value - 12px
Suffix Icon Size	Set the size of the suffix icon in px value - 12px
Text Transform	This property specifies how to capitalize an element's text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized. MDN web docs
Text Decoration	This property sets the appearance of decorative lines on text. Types are "underline", "overline", "line-though", "overline-underline".
Text Size	Set the size of the text in px value - 12px
Text Weight	Increase or decrease the thickness of the font using the list of numbers from 100-800.
Font Family	Type the name of the font family. The reference to the list of font families can be found here: MDN web docs
Font Style	There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text.
Border Color	Set the colour to the border lines. The border lines will be shown only if that is enabled.
Margin	This value is set in terms of "px" number which creates the space between the border and the content of the widget.
Padding	This value is set in terms of "px" number which creates the space between the border and outer elements.
Border Radius	This sets the radius of the widget's corners, enabling rounded corners on the widget. This value is defined in "px" terms.
Border Width	Set the thickness of the border of the widget using this value. It is defined using "px" terms.