Skip to content

Commit

Permalink
Ensure proper rendering of form fields
Browse files Browse the repository at this point in the history
Make sure details/description attributes have new lines rendered
Output the description value for Name/Address combination fields
  • Loading branch information
noahheck committed Mar 3, 2021
1 parent 9735604 commit 71607f6
Show file tree
Hide file tree
Showing 26 changed files with 48 additions and 38 deletions.
2 changes: 1 addition & 1 deletion resources/views/_form/checkbox.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<div class="checkbox-label-container">
<label for="{{ $id }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
</div>
</div>
2 changes: 1 addition & 1 deletion resources/views/_form/checkboxSwitch.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
<input type="checkbox" class="custom-control-input" value="{{ $value ?? 1 }}" id="{{ $id }}" name="{{ $name }}" {{ ($checked ?? false) ? 'checked' : '' }} {{ ($required ?? false) ? 'required' : '' }}>
<label class="custom-control-label" for="{{ $id }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
</div>
2 changes: 1 addition & 1 deletion resources/views/_form/date.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<div class="input-group">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/decimal.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<input type="text" data-decimal-places="{{ $decimalPlaces }}" class="decimal-field form-control {{ ($error ?? false) ? 'is-invalid' : '' }}" name="{{ $name }}" id="{{ $name }}" placeholder="{{ $placeholder ?? '' }}" value="{{ $value ?? '' }}" {{ ($autofocus ?? false) ? 'autofocus' : '' }} {{ ($required ?? false) ? 'required' : '' }} {{ ($readonly ?? false) ? 'readonly' : '' }}>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/email.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<div class="input-group">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/file-search.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<div class="form-group">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<div class="input-group {{ ($required ?? false) ? 'required' : '' }}">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/file-type-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control {{ ($error ?? false) ? 'is-invalid' : '' }}" id="{{ $name }}" name="{{ $name }}" title="{{ $placeholder }}" data-live-search="true">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/file-upload.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="form-group file-upload-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
- {{ $details }}
<p>{!! nl2br(e($details)) !!}</p>
@endif
<div class="file-upload-image-preview-container" id="fileUploadImagePreviewContainer_{{ $name }}">
<img id="fileUploadImagePreview_{{ $name }}" alt="" src="">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/integer.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<input type="number" class="integer-field form-control {{ ($error ?? false) ? 'is-invalid' : '' }}" name="{{ $name }}" id="{{ $name }}" placeholder="{{ $placeholder ?? '' }}" value="{{ $value ?? '' }}" {{ ($autofocus ?? false) ? 'autofocus' : '' }} {{ ($required ?? false) ? 'required' : '' }} {{ ($readonly ?? false) ? 'readonly' : '' }}>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/money.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<div class="input-group">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/multi-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<label for="{{ $name }}">{{ $label }}</label>
@endif
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control" {!! ($maxOptions ?? false) ? 'data-max-options="' . e($maxOptions) . '"' : '' !!} id="{{ $id ?? $name }}" name="{{ $name }}[]" title="{{ $placeholder }}" data-live-search="true" {{ ($readonly ?? false) ? 'disabled' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }} data-display="static" multiple>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/password.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
- {{ $details }}
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<input type="password" class="form-control {{ ($error ?? false) ? 'is-invalid' : '' }}" name="{{ $name }}" id="{{ $name }}" placeholder="{{ $placeholder ?? '' }}" value="{{ $value ?? '' }}" {{ ($autofocus ?? false) ? 'autofocus' : '' }} {{ ($required ?? false) ? 'required' : '' }}>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/phone.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@else
<small class="text-muted">(xxx) xxx-xxxx</small>
@endif
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/radioGroup.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<p>
<strong>{{ $label }}</strong>
@if ($description)
<br>{{ $description }}
<br>{!! nl2br(e($description)) !!}
@endif
</p>

Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<select class="custom-select {{ ($error ?? false) ? 'is-invalid' : '' }}" id="{{ $id ?? $name }}" name="{{ $name }}" {{ ($readonly ?? false) ? 'readonly disabled' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }}>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/team-multi-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control" id="{{ $name }}" name="{{ $name }}[]" title="{{ $placeholder }}" data-live-search="true" multiple>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/team-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control" id="{{ $name }}" name="{{ $name }}" title="{{ $placeholder }}" data-live-search="true">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/text-editor.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<div class="editor-container">
<label for="{{ $id }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
<trix-toolbar id="{{ $id }}__toolbar">
<div class="trix-button-row">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/text.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
@if ($inputGroupAppendText ?? false)
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/textarea.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
<p>{{ $details }}</p>
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<textarea rows="{{ $rows ?? 10 }}" class="form-control {{ ($error ?? false) ? 'is-invalid' : '' }}" name="{{ $name }}" id="{{ $name }}" placeholder="{{ $placeholder ?? '' }}" {{ ($autofocus ?? false) ? 'autofocus' : '' }} {{ ($required ?? false) ? 'required' : '' }} {{ ($readonly ?? false) ? 'readonly' : '' }}>{{ $value ?? '' }}</textarea>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/time.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($details ?? false)
- {{ $details }}
<p>{!! nl2br(e($details)) !!}</p>
@endif
@endunless
<div class="input-group">
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/user-multi-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control" id="{{ $name }}" name="{{ $name }}[]" title="{{ $placeholder }}" data-live-search="true" {{ ($readonly ?? false) ? 'disabled' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }} multiple>
Expand Down
2 changes: 1 addition & 1 deletion resources/views/_form/user-select.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<div class="form-group {{ ($required ?? false) ? 'required' : '' }}">
<label for="{{ $name }}">{{ $label }}</label>
@if ($description ?? false)
<p>{{ $description }}</p>
<p>{!! nl2br(e($description)) !!}</p>
@endif
@endunless
<select class="selectpicker show-tick form-control" id="{{ $name }}" name="{{ $name }}" title="{{ $placeholder }}" data-live-search="true" {{ ($readonly ?? false) ? 'disabled' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }}>
Expand Down
3 changes: 3 additions & 0 deletions resources/views/_form_field/address.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
<div class="form-row">
<div class="col-12">
<label for="{{ $field->fieldName() }}_1">{{ $field->label }}</label>
@if($description = $field->description)
<p>{!! nl2br(e($description)) !!}</p>
@endif
</div>
<div class="col-12 col-md-6 mb-3">
<input type="text" class="form-control {{ ($errors->has($field->fieldName() . '_1') ?? false) ? 'is-invalid' : '' }}" name="{{ $field->fieldName() }}_1" id="{{ $field->fieldName() }}_1" value="{{ old($field->fieldName() . '_1', $value->value_text1) }}" placeholder="{{ __('file.field_fieldTypeAddressPreviewLine1Placeholder') }}" {{ ($readonly ?? false) ? 'readonly' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }}>
Expand Down
3 changes: 3 additions & 0 deletions resources/views/_form_field/name.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
<div class="form-row mb-3">
<div class="col-12">
<label for="{{ $field->fieldName() }}_1">{{ $field->label }}</label>
@if($description = $field->description)
<p>{!! nl2br(e($description)) !!}</p>
@endif
</div>
<div class="col-8">
<input type="text" class="form-control {{ ($errors->has($field->fieldName() . '_1') ?? false) ? 'is-invalid' : '' }}" name="{{ $field->fieldName() }}_1" id="{{ $field->fieldName() }}_1" value="{{ old($field->fieldName() . '_1', $value->value_text1) }}" placeholder="{{ __('file.field_fieldTypeNamePreviewFirstNamePlaceholder') }}" {{ ($readonly ?? false) ? 'readonly' : '' }} {{ ($autofocus ?? false) ? 'autofocus' : '' }}>
Expand Down
34 changes: 19 additions & 15 deletions resources/views/manual/en/form-fields.md.blade.php
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
@dateField([
'name' => 'date',
'label' => 'Date',
'details' => 'Use this field for date values; a calendar will appear to help make selecting the correct date easy!',
'details' => 'Use this field for date values. A calendar will appear to help make selecting the correct date easy!',
'value' => '',
'placeholder' => '',
'required' => false,
Expand All @@ -100,7 +100,7 @@
@phoneField([
'name' => 'phone',
'label' => 'Phone Number',
'details' => 'Use this field for phone numbers; the phone number will be formatted as the user enters it to help ensure accuracy!',
'details' => 'Use this field for phone numbers. The phone number will be formatted as the user enters it to help ensure accuracy!',
'value' => '',
'required' => false,
'autofocus' => false,
Expand All @@ -122,7 +122,7 @@
@integerField([
'name' => 'integer',
'label' => 'Integer Field',
'details' => 'Use this field for integer data points; many browsers will include a widget for these fields to help make selecting the appropriate value easier.',
'details' => 'Use this field for integer data points. Many browsers will include a widget for these fields to help make selecting the appropriate value easier.',
'value' => '',
'placeholder' => '',
'required' => false,
Expand All @@ -137,7 +137,7 @@
@decimalField([
'name' => 'decimal',
'label' => 'Decimal Field',
'details' => 'Used to gather numeric values with a decimal point; the number of decimal points the field will accept and validate is configurable (up to 4 decimal points). This field has a configured value of 2 decimal points.',
'details' => 'Used to gather numeric values with a decimal point. The number of decimal points the field will accept and validate is configurable (up to 4 decimal points). This field has a configured value of 2 decimal points.',
'value' => '',
'decimalPlaces' => '2',
'placeholder' => '',
Expand Down Expand Up @@ -197,7 +197,7 @@
'name' => 'checkbox',
'id' => 'checkbox',
'label' => 'Checkbox Field',
'details' => 'Checkbox fields are used to indicate a value as affirmative or negative. Use them to indicate state (e.g., Follow Up Required), or to indicate the presence or absence of a condition (e.g., Restricted Diet).',
'details' => 'Checkbox fields are used to indicate a value as affirmative or negative. Use them to indicate state (e.g., Follow Up Required), or to indicate the presence/absence of a condition (e.g., Restricted Diet, Wears Glasses, or Requires Notification).',
'checked' => false,
'value' => '',
'required' => false,
Expand Down Expand Up @@ -238,12 +238,14 @@

<div class="field-example">

**Name Field**

The Name Field is used to collect a person's name, including First, Middle, and Last name, and a possible suffix.
@php
$nameField = new \App\FormDoc\Template\Field;
$nameField->label = 'Name Field';
$nameField->description = "The Name Field is used to collect a person's name, including First, Middle, and Last name, and a possible suffix.";
@endphp

@include('_form_field.name', [
'field' => new \App\FormDoc\Template\Field(),
'field' => $nameField,
'value' => optional((object) []),
'readonly' => false,
])
Expand All @@ -252,12 +254,14 @@

<div class="field-example">

**Address Field**

Use the Address Field to collect all of the details for a US address.
@php
$addressField = new \App\FormDoc\Template\Field;
$addressField->label = 'Address Field';
$addressField->description = "Use the Address Field to collect all of the details for a US address.";
@endphp

@include('_form_field.address', [
'field' => new \App\FormDoc\Template\Field(),
'field' => $addressField,
'value' => optional((object) []),
'readonly' => false,
])
Expand All @@ -276,7 +280,7 @@
'name' => 'user',
'label' => 'User Field',
'value' => '',
'users' => \App\User::active()->get(),
'users' => collect([Auth::user()]),
'placeholder' => 'Select a user',
'description' => "The User Field allows staff to select an Office Forge user for a field's value. The options that appear in the list can be filtered by Team to ensure only appropriate user's can be selected for an individual field.",
'required' => false,
Expand Down Expand Up @@ -310,7 +314,7 @@

### Additional Fields

<div class="field-example">
<div class="field-example" style="padding-top: 0;">

@include('_form_field.section-header', [
'field' => (object) [
Expand Down

0 comments on commit 71607f6

Please sign in to comment.