silverstripe-framework/docs/en/02_Developer_Guides/03_Forms/06_Tabbed_Forms.md

68 lines
1.9 KiB
Markdown
Raw Normal View History

---
title: Tabbed Forms
summary: Find out how CMS interfaces use jQuery UI tabs to provide nested FormFields.
---
# Tabbed Forms
SilverStripe's [FormScaffolder](api:SilverStripe\Forms\FormScaffolder) can automatically generate [Form](api:SilverStripe\Forms\Form) instances for certain database models. In the
CMS and other scaffolded interfaces, it will output [TabSet](api:SilverStripe\Forms\TabSet) and [Tab](api:SilverStripe\Forms\Tab) objects and use jQuery Tabs to split
parts of the data model.
[notice]
All interfaces within the CMS such as [ModelAdmin](api:SilverStripe\Admin\ModelAdmin) and [LeftAndMain](api:SilverStripe\Admin\LeftAndMain) use tabbed interfaces by default.
[/notice]
When dealing with tabbed forms, modifying the fields in the form has a few differences. Each [Tab](api:SilverStripe\Forms\Tab) will be given a
name, and normally they all exist under the `Root` [TabSet](api:SilverStripe\Forms\TabSet).
[notice]
[TabSet](api:SilverStripe\Forms\TabSet) instances can contain child [Tab](api:SilverStripe\Forms\Tab) and further [TabSet](api:SilverStripe\Forms\TabSet) instances, however the CMS UI will only
2017-08-07 02:09:39 +02:00
display up to two levels of tabs in the interface.
[/notice]
## Adding a field to a tab
```php
$fields->addFieldToTab('Root.Main', new TextField(..));
```
## Removing a field from a tab
```php
$fields->removeFieldFromTab('Root.Main', 'Content');
```
## Creating a new tab
```php
$fields->addFieldToTab('Root.MyNewTab', new TextField(..));
```
## Moving a field between tabs
```php
$content = $fields->dataFieldByName('Content');
$fields->removeFieldFromTab('Root.Main', 'Content');
$fields->addFieldToTab('Root.MyContent', $content);
```
## Add multiple fields at once
```php
$fields->addFieldsToTab('Root.Content', [
TextField::create('Name'),
TextField::create('Email')
]);
```
## API Documentation
* [FormScaffolder](api:SilverStripe\Forms\FormScaffolder)