mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-07-05 10:59:35 +02:00
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
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.
|
|
|
|
<div class="notice" markdown="1">
|
|
All interfaces within the CMS such as [ModelAdmin](api:SilverStripe\Admin\ModelAdmin) and [LeftAndMain](api:SilverStripe\Admin\LeftAndMain) use tabbed interfaces by default.
|
|
</div>
|
|
|
|
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).
|
|
|
|
<div class="notice" markdown="1">
|
|
[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
|
|
display up to two levels of tabs in the interface.
|
|
</div>
|
|
|
|
## 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)
|