# Customization

# Buttons

Sprout has a custom rule for virtual buttons. Where, the user can apply sizes, colors, styles and icons with Font Awesome when creating a button. Thus, it is possible, by default, to adapt it to the layout of your system.

The rule is easily defined by applying the reference as a prefix to the button name. For example, to create a bigger button, just prefix ms_le to the name of the button: ms_le_btn_copy

More than one reference can be applied to the same button, being limited only by the number of characters that the Scriptcase interface allows for the name of a button.
For example, to create a button with an icon and class, simply apply the ms_del and ms_ldr prefixes to the button name: ms_del_ms_ldr_del_user

Delete user

Check out the list below with all the button references, available on Sprout:

• Sizes
• Colors
• Light Styles
• Light hover styles*
• Light background styles*
• Font Awesome

*This style has hover difference.

# Sizes

# Colors

# Light Style

# Light hover styles*

*This style has hover difference.

# Light background styles*

*This style has hover difference.

# Font Awesome

Reference	icon	Example	Reference	icon	Example
ms_close		Example	ms_rght		Example
ms_ok		Example	ms_tab		Example
ms_clear		Example	ms_srch		Example
ms_undo		Example	ms_chrt		Example
ms_save		Example	ms_list		Example
ms_cancel		Example	ms_sort		Example
ms_copy		Example	ms_tbl		Example
ms_check		Example	ms_magic		Example
ms_add		Example	ms_cog		Example
ms_del		Example	ms_bar		Example
ms_edit		Example	ms_line		Example
ms_first		Example	ms_pie		Example
ms_back		Example	ms_stck		Example
ms_next		Example	ms_tach		Example
ms_last		Example	ms_pdf		Example
ms_remove		Example	ms_wrd		Example
ms_up		Example	ms_prnt		Example
ms_down		Example	ms_xls		Example
ms_hide		Example	ms_xml		Example
ms_view		Example	ms_csv		Example
ms_max		Example	ms_img		Example
ms_upl		Example	ms_mail		Example
ms_clock		Example	ms_more		Example
ms_gear		Example	ms_dwnl		Example
ms_data		Example	ms_warn		Example
ms_pw		Example	ms_fb		Example
ms_exit		Example	ms_gogl		Example
ms_event		Example	ms_papl		Example
ms_alert		Example	ms_twtt		Example
ms_ask		Example	ms_sad		Example
ms_bell		Example	ms_home		Example
ms_lft		Example

# Macros

In addition to customizing the buttons, Sprout also has exclusive macros, designed to provide more dynamism to the system.

# sc_field_group

sc_field_group(text, array_config)

This macro allows you to group multiple values in a single field of the grid. Through the parameters it is possible to inform the values that will be displayed and also a series of display configurations through an array.

The use of this macro is restricted to the grid's onRecord event.

This macro requires the use of the internal fieldGroup.php library, which is enabled by default.

# Parameters

*This parameter is not mandatory for the macro to work.

# ms_initial

# ms_list

# Example

Grids - onRecord

$admin = (isset({set_admin}) && {set_admin} == "Y") ? {lang_sec_user_fld_set_admin} : "";

$set                                = array();
$set["ms_initial"]["img"]["field"]  = {photo};
$set["ms_initial"]["img"]["viewer"] = "Y";
$set["ms_initial"]["text"]          = {first_name};
$set["ms_list"]["title"]            = {first_name} . " " . {last_name};
$set["ms_list"]["note"]["primary"]  = $admin;

{user} = sc_field_group({email}, $set);
 
        Copied!
    

# sc_input_group

sc_input_group(array_fields, sc_seq_vert)

This macro allows you to create text and icon groups on form inputs. Through the parameters it is possible to inform a multidimensional array that will receive the fields, contents and types that can be texts or Font Awesome (opens new window) icons.

The use of this macro is restricted to the onLoad and onLoadRecord events of form, control, and calendar applications.

This macro requires the use of the inputGroup.php internal library, which is enabled by default.

Disable the Display Ajax output option in the application settings.

# Parameters

*This parameter must receive the variable $sc_seq_vert and is mandatory only for multiple records, editable grid and editable grid(view) orientations.

# Multidimensional Array

*View supported field types.
**For icons it is necessary to inform the Font Awesome (opens new window) class attribute. Example: fas fa-user.

# Supported Field Types

# Examples

Single record forms, controls and calendars - onLoad

$arr_fields = [
	['smtp_server', 'icon', 'fas fa-server', 'left'],
	['smtp_email', 'icon', 'fas fa-at', 'left'],
	['smtp_user', 'icon', 'fas fa-user', 'left'],
	['smtp_pswd', 'icon', 'fas fa-key', 'left']
];

sc_input_group($arr_fields);
 
        Copied!
    

Multiple records forms, editable grid and editable grid (view) - onLoadRecord

$arr_fields = [
	['mod', 'icon', 'fas fa-bars', 'left']
];

sc_input_group($arr_fields, $sc_seq_vert);
 
        Copied!
    

# sc_float_label

sc_float_label(array_fields, sc_seq_vert)

This macro allows you to transform the placeholder as a floating label on form inputs. Through the parameters it is possible to inform an array that will receive all the fields in which the resource will be applied.

The use of this macro requires that the field used contains a placeholder(Watermark).

Use of this macro is restricted to the onLoad and onLoadRecord events of form, control, and calendar applications.

This macro requires the use of the floatLabel.php internal library, which is enabled by default.

Disable the Display Ajax output option in the application settings.

# Parameters

*This parameter must receive the variable $sc_seq_vert and is Required only for orientations of multiple records, editable grid and editable grid(view).

# Array

*View supported field types.

# Supported Field Types

# Examples

Single record forms, controls and calendars - onLoad

$arr_fields = ['smtp_server', 'smtp_email', 'smtp_user', 'smtp_pswd'];

sc_float_label($arr_fields);
 
        Copied!
    

Multiple records forms, editable grid and editable grid (view) - onLoadRecord

$arr_fields = ['mod', 'icon'];

sc_float_label($arr_fields, $sc_seq_vert);
 
        Copied!
    

# sc_back_to_top

sc_back_to_top(position)

This macro creates a button, in the bottom margin while scrolling the page, redirecting to the top. Through the parameter, it is possible to define the position of the button as left or right.

The use of this macro is applicable to page load events such as onExecute, onLoad and onScriptInit.

This macro requires the use of the built-in library backTop.php, which is enabled by default.

Disable the Display Ajax output option in the application settings.

# Parameters

# Examples

Grid - onScriptInit

sc_back_to_top();
 
        Copied!
    

Form - onLoad

sc_back_to_top("left");
 
        Copied!
    

# sc_add_notification

sc_add_notification(type, rec_type, receiver, text, link, sender)

This macro allows the sending of alert messages or system events. Through the parameters it is possible to determine for which users and departments the message will be displayed.

This macro requires the use of the built-in notification.php library, which is enabled by default.

# Parameters

# Example

switch ({receiver_type}) {
    case "all_users":
        $receiver = null;
    break;
    case "group":
        $receiver = {receiver_group};
    break;
    case "user":
    break;
    default:
        $receiver = null;
    break;
}

$sender = null;

if (isset([usr_login])) {
    $sender = [usr_login];
}

sc_add_notification({type}, {receiver_type}, $receiver, {text}, {link_app}, $sender);
 
        Copied!