The Feedback Form
The feedback form is where players write their report. The feedback form object is highly customizable, and Easy Feedback comes with some prefabs for quickly adding new input fields to your form.
Configuring the Feedback Form
The Feedback Form component has a few exposed fields that can be configured. Unlike the settings found in the configuration window, changing these values will only affect the form instance you are editing.
Config
A reference to the auto-generated EasyFeedbackConfig.asset. This generally should not be changed.
Include screenshot
Whether or not to include a screenshot with the report.
Default: checked
Resize large screenshots
Trello has a per-attachment file size limit of 10MB for free accounts and 250MB for paid accounts. This option resizes screenshots larger than 1080p to avoid the image size restriction. You can safely disable this if your account allows 250MB attachments.
Default: checked
Form
The Form
RectTransform in the Feedback game object children.
Events
See FeedbackForm for more detail on the events listed on the component.
Customizing your Feedback Form
By default, the feedback form has category and priority dropdowns, a
summary text field, and a detail text field. Objects containing scripts
that collect metadata information like system information are also
included under the MetadataCollectors
object.
All of these elements may be removed or replaced as needed. Additional elements may be added to the form as well.
Order of Priority Options
To change the order of the options in the priority dropdown,
set the order
property of the Labels in
EasyFeedbackConfig.asset.
Lower values will appear higher in the list.
Form elements
Form elements are any components that alter the report in some way. The report category dropdown, debug log collector, and priority dropdown are all form elements.
Note
See also: Report
Form fields
Form fields are any components that alter a section on the report in some way. The detail text field, as well as most metadata collectors are form fields.
FormField
inherits from
FormElement
but also exposes some variables that make it easier to quickly alter
how the form field appears on the report.
All form fields have these public variables:
- Section Title: The title of this field’s section on the report.
- Sort Order: Order of the section in the report (lowest first).
Prefabs
Easy Feedback comes with a few form field prefabs for quick drag and
drop customization. These prefabs can be found in the project window at
Easy Feedback > Prefabs > Fields
. To add these fields to your form,
just add them as children of Form
on the Feedback
prefab.
Dropdown
A simple dropdown input.
Public variables:
Label: The label to prepend to this field on the report. No label will be included if this field is left blank.
InputField
A text input field.
Public variables:
Label: The label to prepend to this field on the report. No label will be included if this field is left blank.
Toggle
A checkbox.
Public variables:
Label: The label to prepend to this field on the report. No label will be included if this field is left blank.
Default: The default value of the toggle.
Toasts
By default, Easy Feedback will send submission status messages via the Toaster
attached to the Easy Feedback prefab. Toaster.Toast(string)
is added
as a callback on each of the submission events.
Customizing the Toast
You can customize the toast popup to your liking by modifying the Toast
prefab.
Input
Easy Feedback uses the legacy input API to detect input by default.
The asset also comes with out of the box support for Unity's Input System package. To configure Easy Feedback to use the Input System, see Input System Support
Show/hide the form on input
By default, the feedback form is configured to be shown/hidden on keypress using the Show Feedback Form Input component. Feel free to reconfigure, remove and/or replace this component depending on your needs.
Tab Next
The Tab Next component on some fields allows the player to use the tab key to jump to the next input field. Feel free to reconfigure, remove and/or replace this component depending on your needs.