This adds the ability to toggle a field description

[flashbackzoo]

If a field requires a long description it can be useful have it hidden until the user needs to read it.

Description hidden:

Description show:

I'm looking for feedback on the technical approach here, so I have only pushed the initial show/hide logic at this stage. There is additional styling required to get the layout looking like the screenshots.

[chillu]

Interesting! When developing the help text I think we deliberately decided to show it by default. It would be good to make the "info" icons opt-in though (globally and per field), as an easier way to show longer help text.

Please have a read through historical discussions to get context:
#969
#1029
#986
#525
#979

Make sure the styling works correctly with different field layout combos, like in FieldGroup or a DateField with a dmy configuration option (three separate fields). There's a frameworktest module which creates many of these combinations, I've used it for similar sanity checks before: https://github.com/silverstripe-labs/silverstripe-frameworktest

[tractorcow]

This should be in the FormField() function, which is where all other formfields require their javascript. It should also only be included if necessary.

Alternatively, if you don't want to include this check, then you can put it in one of the existing framework/admin/javascript files; likely LeftAndMain.FieldHelp.js, which already has similar field helpers.

[chillu]

Also make sure that's included in the main Requirements::combine_files() call in CMSMain, we don't want to cause more asset loads to slow down the CMS

[flashbackzoo]

Thanks, I'll move it :)

[tractorcow]

I think if it's in LeftAndMain we should remove it from here. This is a CMS specific feature not a field specific one?

[flashbackzoo]

thanks, yup that was an oversight on my part, i forgot to remove it.

[flashbackzoo]

The naming convention is now more consistent with FieldHelp / Tooltip. And there are some docs. @chillu @tractorcow what are your thoughts on this approach?

[flashbackzoo]

The initial styling is there now. Here's a screenshot of the styles applied in the files area.

There are a lot of image file changes as a result of adding an icon to the buttons sprite (admin/images/btn-icon/information.png) and running a compass compile. I've had a good look around the CMS and everything seems to be presenting fine.

I'm going to do some testing on other field types as @chillu suggested, and as a result probably push up another commit :)

[flashbackzoo]

Here are some screenshots of various field types.

@chillu @tractorcow If you're happy with this, I'll squash the commits...

[jonom]

Hey @flashbackzoo you may have already tested but just wondering if this works for a

DateField with a dmy configuration option (three separate fields)

as chillu pointed out, and also on individual fields nested within a FieldGroup?

[flashbackzoo]

Hey @jonom - Yup it works on DateField with three fields.

For a FieldGroup you can add a toggleable description to the group.

The CheckboxField template has no middleColumn, so it doesn't work there. I think that's more of a CheckboxField issue though. If the CheckboxField template was updated to have a middleColumn, consistent with other CMS fields, it will work.

[tractorcow]

Thanks @flashbackzoo :D