Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow customization of default wrapper in order to support Bootstrap without requiring templates #349

Merged
merged 8 commits into from
Sep 15, 2024
Merged

Allow customization of default wrapper in order to support Bootstrap without requiring templates #349

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d422000
Allow customization of default wrapper.
codeconsole Sep 7, 2024
7c6c04c
Fix unit tests
codeconsole Sep 8, 2024
3418bb8
Support class and controller attributes on <f:table />
codeconsole Sep 8, 2024
762dcb0
Support _list class attributes <f:display />
codeconsole Sep 8, 2024
58559ce
use class instead of listClass for ol
codeconsole Sep 12, 2024
530a433
Formatting suggested by Søren :)
codeconsole Sep 13, 2024
038e355
Document new classes
codeconsole Sep 13, 2024
668a132
Document defaults
codeconsole Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 32 additions & 16 deletions grails-app/taglib/grails/plugin/formfields/FormFieldsTagLib.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,26 +190,31 @@ class FormFieldsTagLib {

String prefixAttribute = formFieldsTemplateService.getWidgetPrefix() ?: 'widget-'
attrs.each { k, v ->

if (k?.startsWith(prefixAttribute))
widgetAttrs[k.replace(prefixAttribute, '')] = v
else
wrapperAttrs[k] = v
}

List classes = [widgetAttrs['class']?:'']
sbglasius marked this conversation as resolved.
Show resolved Hide resolved
if (model.invalid) classes << (widgetAttrs.remove('invalidClass')?:'')
if (model.required) classes << (widgetAttrs.remove('requiredClass')?:'')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To follow the code-style (if any) of the existing code, add spaces around ?: (throughout changes)

widgetAttrs['class'] = classes.join(' ').trim()
if (widgetAttrs['class'].isEmpty()) {
widgetAttrs.remove('class')
}
if (hasBody(body)) {
model.widget = raw(body(model + [attrs: widgetAttrs] + widgetAttrs))
} else {
model.widget = renderWidget(propertyAccessor, model, widgetAttrs, widgetFolder ?: templatesFolder, theme)
}


String templateName = formFieldsTemplateService.getTemplateFor("wrapper")
Map template = formFieldsTemplateService.findTemplate(propertyAccessor, templateName, fieldFolder ?: templatesFolder, theme)
if (template) {
out << render(template: template.path, plugin: template.plugin, model: model + [attrs: wrapperAttrs] + wrapperAttrs)
} else {
out << renderDefaultField(model)
out << renderDefaultField(model, wrapperAttrs)
}
}
}
Expand Down Expand Up @@ -338,7 +343,7 @@ class FormFieldsTagLib {
String template = attrs.remove('template') ?: 'list'

List properties = resolvePersistentProperties(domainClass, attrs)
out << render(template: "/templates/_fields/$template", model: [domainClass: domainClass, domainProperties: properties]) { prop ->
out << render(template: "/templates/_fields/$template", model: attrs + [domainClass: domainClass, domainProperties: properties]) { prop ->
BeanPropertyAccessor propertyAccessor = resolveProperty(bean, prop.name)
Map model = buildModel(propertyAccessor, attrs, 'HTML')
out << raw(renderDisplayWidget(propertyAccessor, model, attrs, templatesFolder, theme))
Expand Down Expand Up @@ -623,28 +628,39 @@ class FormFieldsTagLib {
message ?: defaultMessage
}

private CharSequence renderDefaultField(Map model) {
List classes = ['fieldcontain']
if (model.invalid) classes << 'error'
if (model.required) classes << 'required'

protected CharSequence renderDefaultField(Map model, Map attrs = [:]) {
List classes = [attrs['class']?:'fieldcontain']
if (model.invalid) classes << (attrs.remove('invalidClass')?:'error')
if (model.required) classes << (attrs.remove('requiredClass')?:'required')
attrs['class'] = classes.join(' ').trim()
Writer writer = new FastStringWriter()
new MarkupBuilder(writer).div(class: classes.join(' ')) {
label(for: (model.prefix ?: '') + model.property, model.label) {
def mb = new MarkupBuilder(writer)
mb.setDoubleQuotes(true)
mb.div(class: attrs['class']) {
label(class: attrs.labelClass, for: (model.prefix ?: '') + model.property, model.label) {
if (model.required) {
span(class: 'required-indicator', '*')
}
}
// TODO: encoding information of widget gets lost - don't use MarkupBuilder
def widget = model.widget
if (widget != null) {
mkp.yieldUnescaped widget
if (attrs.divClass) {
div(class: attrs.divClass) {
sbglasius marked this conversation as resolved.
Show resolved Hide resolved
renderWidget(mkp, model)
}
} else {
renderWidget(mkp, model)
}

}
writer.buffer
}

private void renderWidget(def mkp, Map model) {
sbglasius marked this conversation as resolved.
Show resolved Hide resolved
// TODO: encoding information of widget gets lost - don't use MarkupBuilder
def widget = model.widget
if (widget != null) {
mkp.yieldUnescaped widget
}
}

CharSequence renderDefaultInput(Map model, Map attrs = [:]) {
renderDefaultInput(null, model, attrs)
}
Expand Down
8 changes: 4 additions & 4 deletions grails-app/views/templates/_fields/_list.gsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<ol class="property-list ${domainClass.decapitalizedName}">
<ol class="${pageScope['class']?:'property-list'} ${domainClass.decapitalizedName}">
<g:each in="${domainProperties}" var="p">
<li class="fieldcontain">
<span id="${p.name}-label" class="property-label"><g:message code="${domainClass.decapitalizedName}.${p.name}.label" default="${p.defaultLabel}" /></span>
<div class="property-value" aria-labelledby="${p.name}-label">${body(p)}</div>
<li class="${listItemClass?:'fieldcontain'}">
<span id="${p.name}-label" class="${labelClass?:'property-label'}"><g:message code="${domainClass.decapitalizedName}.${p.name}.label" default="${p.defaultLabel}" /></span>
<div class="${valueClass?:'property-value'}" aria-labelledby="${p.name}-label">${body(p)}</div>
</li>
</g:each>
</ol>
6 changes: 3 additions & 3 deletions grails-app/views/templates/_fields/_table.gsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<table>
<table<g:if test="${pageScope['class']}"> class="${pageScope['class']}"</g:if>>
<thead>
<tr>
<g:each in="${domainProperties}" var="p" status="i">
Expand All @@ -11,10 +11,10 @@
<tr class="${(i % 2) == 0 ? 'even' : 'odd'}">
<g:each in="${domainProperties}" var="p" status="j">
<g:if test="${j==0}">
<td><g:link method="GET" resource="${bean}"><f:display bean="${bean}" property="${p.property}" displayStyle="${displayStyle?:'table'}" theme="${theme}"/></g:link></td>
<td><g:link method="GET" resource="${bean}" controller="${controller}"><f:display bean="${bean}" property="${p.property}" displayStyle="${displayStyle?:'table'}" theme="${theme}"/></g:link></td>
</g:if>
<g:else>
<td><f:display bean="${bean}" property="${p.property}" displayStyle="${displayStyle?:'table'}" theme="${theme}"/></td>
<td><f:display bean="${bean}" property="${p.property}" displayStyle="${displayStyle?:'table'}" theme="${theme}"/></td>
</g:else>
</g:each>
</tr>
Expand Down
Loading