tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8510 from open-sausages/pulls/4/remove-legacy-article

Browse Source 
DOC Remove buggy example form the _Show Help Text on CMS Form Fields_
This commit is contained in:
Andre Kiste 2018-10-26 14:21:08 +13:00 committed by GitHub
commit 1ac8665aa9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/How_Tos/CMS_Formfield_Help_Text.md
View File

@ -17,26 +17,7 @@ TextField::create('MyText', 'My Text Label')
->setDescription('More <strong>detailed</strong> 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 <strong>detailed</strong> 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 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.
@ -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 <strong>detailed</strong> help')
->addExtraClass('cms-description-toggle')
->setRightTitle('<a class="cms-description-trigger">My custom icon</a>');
```
Note: For more advanced help text we recommend using
[Custom form field templates](/developer_guides/forms/form_templates);