Support required text and optional text configuration.

[santosh-pingle]

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Fixes #1954

Description

• Show required text to the beginning of the instructions if views are non textInputLayout views.
• Show required text as helper text if view are InputTextLayout views.
• Support optional text configuration
• If optional text is configured, then show optional text at the end of the question text.
• If question text is not present then show optional text as helper text.

Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?

Type
Choose one: Feature

Screenshots (if applicable)

Checklist

• I have read and acknowledged the Code of conduct.
• I have read the Contributing page.
• I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
• I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
• I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
• I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
• I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

[santosh-pingle]

@shelaghm
Required text :

Optional text :

[shelaghm]

This looks good to me. Thanks @santosh-pingle

[jingtang10]

1. I think the behavior between required and option should be the consistent. so if we're appending (optional) after question text when configured to show optional text, we should be appending (required) after quesiton text as well when configured to show required text.
2. slightly unsure about appending Required. in front of instruction text - Can we just have it as a separate line? happy to be overruled on this one though.

can we just always append (required/optional) after question text, and if question text does't exist, append it to instruction text.

@shelaghm

[shelaghm]

1. To be consistent between the two, I recommend we use the instruction text field to append required/optional. In paginated layout the (required) or (optional) text is very large and I think it's not THAT important to display. In default layout it works better than in paginated as the text proportions are more subtle.
2. Breaking it into two lines is a nice suggestion. @santosh-pingle Do you think we could do a line-break?

I've gone through and mocked up all the options, so we can be sure we are talking about the same options. I'll also post link in group chat as it's a lot!

[shelaghm]

Feedback from @mberg
To confirm does this mean the sdc will no longer support * or will that be supported as an option? I would want to keep the option to not have to display optional on every question. I feel like it’s a bit overwhelming to see it on every question. Odk and most of the form libraries just use the *. I think a lot of people are used to the pattern but I see why required text is a nice option too. I would want to disable optional on all questions though as I feel that becomes a bit overwhelming.

[santosh-pingle]

@shelaghm
Thanks for sharing the details.
The only pending questions are: what will be the default behavior, and what will be supported from the given table?

[shelaghm]

@santosh-pingle I recommend that the default is 2 - Required and that it is appended to instructions or help text. So that is 2A, 2B, 2C. Default should be separate lines for Required/Optional and additional instructions

I suggest we make the following configurable:

• Optional (3)
• Asterisk (1)

I'm not sure if we need to add ability to also append the required/optional text behind the question title instead of in the instructions/help field.

@jingtang10 what do you think? Let's discuss

[shelaghm]

Team discussion:

• For edge case: suggest making Required on the second line, instead of it being displayed before the instructions
• Use Instructions and hint text field
• Asterisk turns on only the *, in order to also display required text, need to turn on Required option
• Configurable options:
• (1) Required text only (default), (2) Optional, (3) Asterisk* - always displayed after question text or inside the text field. They can all be individually toggled on/off.

Note to Shelagh to update the design guidelines with this update.

[santosh-pingle]

@shelaghm

[dubdabasoduba]

@santosh-pingle I tested all three options and they seem to work well. I however have a small design request for the Asterisk display

I think we need some spacing between the text and the Asterisk. I think the Asterisk should have a red text colour.

cc: @shelaghm

[dubdabasoduba]

@shelaghm should these 3 options be mutually exclusive? Right now you can how all can be turned on at the same time.

[shelaghm]

I think we need some spacing between the text and the Asterisk.

Yes, agreed. @santosh-pingle we should add one space before the asterisk.

I think the Asterisk should have a red text colour.

From our usability testing we learned that the red color on the asterisk was confusing, some people thought it was an error because it was red. So I don't recommend making the asterisk red.

should these 3 options be mutually exclusive? Right now you can how all can be turned on at the same time.

Yes, you can turn on all of these at the same time, because you might want to show the required text and the asterisk at the same time.

@dubdabasoduba @santosh-pingle @jingtang10

[mberg]

Agreed I think red should only be used to indicate and error. eg i submitted and it was required but not by default

…

On Tue, May 9, 2023 at 11:42 AM Shelagh McLellan ***@***.***> wrote: I think we need some spacing between the text and the Asterisk. Yes, agreed. @santosh-pingle <https://github.com/santosh-pingle> we should add one space before the asterisk. I think the Asterisk should have a red text colour. From our usability testing we learned that the red color on the asterisk was confusing, some people thought it was an error because it was red. So I don't recommend making the asterisk red. should these 3 options be mutually exclusive? Right now you can how all can be turned on at the same time. Yes, you can turn on all of these at the same time, because you might want to show the required text and the asterisk at the same time. @dubdabasoduba <https://github.com/dubdabasoduba> @santosh-pingle <https://github.com/santosh-pingle> @jingtang10 <https://github.com/jingtang10> — Reply to this email directly, view it on GitHub <#1963 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAOEQMFAHI7WLBC6IW7SPTXFJQUVANCNFSM6AAAAAAW3IBZDE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jingtang10]

thanks @santosh-pingle

[santosh-pingle]

Resolving review comments.