From 40e542de2dd8380e23749b5ad340e31e2b9c6299 Mon Sep 17 00:00:00 2001 From: Maxime Rainville Date: Tue, 23 Oct 2018 16:04:54 +1300 Subject: [PATCH 1/2] DOC Remove buggy example form the _Show Help Text on CMS Form Fields_ article --- .../How_Tos/CMS_Formfield_Help_Text.md | 32 +------------------ 1 file changed, 1 insertion(+), 31 deletions(-) diff --git a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md index 57fd0bd88..db621f90d 100644 --- a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md +++ b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md @@ -17,26 +17,7 @@ TextField::create('MyText', 'My Text Label') ->setDescription('More detailed help'); ``` -To show the help text as a tooltip instead of inline, -add a `.cms-description-tooltip` class. - - -```php -TextField::create('MyText', 'My Text Label') - ->setDescription('More detailed help') - ->addExtraClass('cms-description-tooltip'); -``` - -Tooltips are only supported -for native, focusable input elements, which excludes -more complex fields like `GridField` -or `DropdownField` with the chosen.js behaviour applied. - -Sometimes a field requires a longer description to provied the user with context. -Tooltips can be unwieldy when dealing with large blocks of text, especially if -you're including interactive elements like links. - -Another option you have available is making the field's description togglable. This keeps +Sometimes a field requires a longer description to provied the user with context. Another option you have available is making the field's description togglable. This keeps the UI tidy by hiding the description until the user requests more information by clicking the 'info' icon displayed alongside the field. @@ -47,16 +28,5 @@ TextField::create('MyText', 'My Text Label') ->addExtraClass('cms-description-toggle'); ``` -If you want to provide a custom icon for toggling the description, you can do that -by setting an additional `RightTitle`. - - -```php -TextField::create('MyText', 'My Text Label') - ->setDescription('More detailed help') - ->addExtraClass('cms-description-toggle') - ->setRightTitle('My custom icon'); -``` - Note: For more advanced help text we recommend using [Custom form field templates](/developer_guides/forms/form_templates); From bed1906f7390ee9ebb0ad1cc581e4acd667184f9 Mon Sep 17 00:00:00 2001 From: Andre Kiste Date: Thu, 25 Oct 2018 15:59:02 +1300 Subject: [PATCH 2/2] Fix typo --- .../How_Tos/CMS_Formfield_Help_Text.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md index db621f90d..1452040f0 100644 --- a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md +++ b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md @@ -17,7 +17,7 @@ TextField::create('MyText', 'My Text Label') ->setDescription('More detailed help'); ``` -Sometimes a field requires a longer description to provied the user with context. Another option you have available is making the field's description togglable. This keeps +Sometimes a field requires a longer description to provide the user with context. Another option you have available is making the field's description togglable. This keeps the UI tidy by hiding the description until the user requests more information by clicking the 'info' icon displayed alongside the field.