Date and color field kits¶

Kits in src/Kits/Field/Date/ and src/Kits/Field/Color/.

DateKit¶

A date input (HTML5 date picker).


Class	`Drupal\formfactorykits\Kits\Field\Date\DateKit` (`src/Kits/Field/Date/DateKit.php`)
Extends	`FieldKit`
Factory method	`$kits->date()`
Form API `#type`	`date`
Default ID	`date`
Traits	`DefaultValueTrait`, `DescriptionTrait`, `PrefixTrait`, `RequiredTrait`, `SuffixTrait`, `TitleTrait`, `ValueTrait`

Setters

Method	From
`setDefaultValue(array\\|string\\|null $value)`	DefaultValueTrait (trait)
`setDescription(string $description)`	DescriptionTrait (trait)
`setPrefix(array\\|string\\|null $value)`	PrefixTrait (trait)
`setRequired(bool $required = TRUE)`	RequiredTrait (trait)
`setSuffix(array\\|string\\|null $value)`	SuffixTrait (trait)
`setTitle(string $title)`	TitleTrait (trait)
`setValue(array\\|string\\|null $value)`	ValueTrait (trait)

Example

$kit = $kits->date('start')->setTitle('Start')->setRequired();

Generated render array ([$kit->getID() => $kit->getArray()])

[
  'start' => [
    '#type' => 'date',
    '#title' => 'Start',
    '#required' => TRUE,
  ],
]

A datelist element (separate selects for each date part). Needs the core Datetime module.


Class	`Drupal\formfactorykits\Kits\Field\Date\DateListKit` (`src/Kits/Field/Date/DateListKit.php`)
Extends	`FieldKit`
Factory method	`$kits->dateList()`
Form API `#type`	`datelist`
Default ID	`datelist`
Traits	`DefaultValueTrait`, `DescriptionTrait`, `PrefixTrait`, `SuffixTrait`, `TitleTrait`, `ValueTrait`

Setters

Method	From
`setDatePartOrder(string $order)`	DateListKit
`setDefaultValue(array\\|string\\|null $value)`	DefaultValueTrait (trait)
`setDescription(string $description)`	DescriptionTrait (trait)
`setIncrement(string $increment)`	DateListKit
`setPrefix(array\\|string\\|null $value)`	PrefixTrait (trait)
`setSuffix(array\\|string\\|null $value)`	SuffixTrait (trait)
`setTitle(string $title)`	TitleTrait (trait)
`setValue(array\\|string\\|null $value)`	ValueTrait (trait)

Example

$kit = $kits->dateList('when')->setTitle('When')->setIncrement('15');

Generated render array ([$kit->getID() => $kit->getArray()])

[
  'when' => [
    '#type' => 'datelist',
    '#title' => 'When',
    '#date_increment' => '15',
  ],
]

A datetime element (date and time inputs). Needs the core Datetime module. setTimeZone() takes a \DateTimeZone and stores its name.


Class	`Drupal\formfactorykits\Kits\Field\Date\DateTimeKit` (`src/Kits/Field/Date/DateTimeKit.php`)
Extends	`FieldKit`
Factory method	`$kits->dateTime()`
Form API `#type`	`datetime`
Default ID	`datetime`
Traits	`DefaultValueTrait`, `DescriptionTrait`, `PrefixTrait`, `SuffixTrait`, `TitleTrait`, `ValueTrait`

Setters

Method	From
`setDefaultValue(array\\|string\\|null $value)`	DefaultValueTrait (trait)
`setDescription(string $description)`	DescriptionTrait (trait)
`setIncrement(string $increment)`	DateTimeKit
`setPrefix(array\\|string\\|null $value)`	PrefixTrait (trait)
`setSuffix(array\\|string\\|null $value)`	SuffixTrait (trait)
`setTimeZone(DateTimeZone $timezone)`	DateTimeKit
`setTitle(string $title)`	TitleTrait (trait)
`setValue(array\\|string\\|null $value)`	ValueTrait (trait)

Example

$kit = $kits->dateTime('at')->setTitle('At')->setTimeZone(new \DateTimeZone('UTC'));

Generated render array ([$kit->getID() => $kit->getArray()])

[
  'at' => [
    '#type' => 'datetime',
    '#title' => 'At',
    '#date_timezone' => 'UTC',
  ],
]

A color input.


Class	`Drupal\formfactorykits\Kits\Field\Color\ColorKit` (`src/Kits/Field/Color/ColorKit.php`)
Extends	`FieldKit`
Factory method	`$kits->color()`
Form API `#type`	`color`
Default ID	`color`
Traits	`DefaultValueTrait`, `DescriptionTrait`, `PrefixTrait`, `SuffixTrait`, `TitleTrait`, `ValueTrait`

Setters

Method	From
`setDefaultValue(array\\|string\\|null $value)`	DefaultValueTrait (trait)
`setDescription(string $description)`	DescriptionTrait (trait)
`setPrefix(array\\|string\\|null $value)`	PrefixTrait (trait)
`setSuffix(array\\|string\\|null $value)`	SuffixTrait (trait)
`setTitle(string $title)`	TitleTrait (trait)
`setValue(array\\|string\\|null $value)`	ValueTrait (trait)

Example

$kit = $kits->color('accent')->setTitle('Accent')->setDefaultValue('#0071b8');

Generated render array ([$kit->getID() => $kit->getArray()])

[
  'accent' => [
    '#type' => 'color',
    '#title' => 'Accent',
    '#default_value' => '#0071b8',
  ],
]