syntro/silverstripe-bootstrap-forms

Silverstripe module adding formfields for use in the frontend

1.0.4 2024-02-03 13:47 UTC

Requires

• php: ^7.4.0 || ^8
• giggsey/libphonenumber-for-php: ^8.0
• silverstripe/cms: ^4 || ^5
• silverstripe/framework: ^4 || ^5

Requires (Dev)

• phpunit/phpunit: ^9.4
• squizlabs/php_codesniffer: ^3.0
• syntro/silverstripe-phpstan: ^1

BSD-3-Clause

• Matthias Leutenegger

• silverstripe
• silverstripe 4
• frontend forms

README

Silverstripe module for adding bootstrap forms to the frontend more easily.

Introduction

Creating forms compatible with the Bootstrap CSS framework using the provided form fields by Silverstripe is not an easy thing to do. Silverstripes' internally used form fields are not intended to be frontend fields in the first place, meaning the framework is very opinionated about how these fields are rendered in the admin UI and imposes these standards for frontend fields. These standards however are not very compatible with Bootstrap, especially Bootstrap v5.

To counter this, this module introduces a new set of fields, which behave like the originals, but render in a bootstrap compatible way. They also add a separate holderClasses attribute, which allows the easy formatting of forms using spacing classes.

Installation

To install this module, run the following command:

composer require syntro/silverstripe-bootstrap-forms

Usage

Quick Start

The following fields are available currently:

use Syntro\SilverstripeBootstrapForms\Forms\CheckboxField;
use Syntro\SilverstripeBootstrapForms\Forms\CheckboxSetField;
use Syntro\SilverstripeBootstrapForms\Forms\DropdownField;
use Syntro\SilverstripeBootstrapForms\Forms\EmailField;
use Syntro\SilverstripeBootstrapForms\Forms\OptionsetField;
use Syntro\SilverstripeBootstrapForms\Forms\TextareaField;
use Syntro\SilverstripeBootstrapForms\Forms\TextField;

// does not have the HolderClass trait
use Syntro\SilverstripeBootstrapForms\Forms\FieldGroup;

All fields have an extra set of methods, analogous the extraClass ones:

• holderClass()
• setupDefaultHolderClasses()
• hasHolderClass($class)
• addHolderClass($class)
• removeHolderClass($class)

They behave the exact same way as their xxxExtraClass counterparts, but they control the class on the outer (holder) div.

Example

To create a good looking multi-column form, simply add the correct classes:

FieldGroup::create(
    TextField::create('Name', 'Your Name')->addHolderClass('col'),
    EmailField::create('Email', 'Email')->addHolderClass('col'),
    DropdownField::create(
        'choose',
        'Choose an option',
        [
            'yes' => 'Yes',
            'no' => 'No'
        ]
    )->addHolderClass('col'),
)->addExtraClass('row row-cols-1 row-cols-md-3'),

Docs

no docs yet

Contributing

See CONTRIBUTION.md for mor info.