这是indexloc提供的服务,不要输入任何密码
Skip to content

feat(): add primeng multiselect and filter support #2100

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.

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

Open
wants to merge 4 commits into
base: v5
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 11 additions & 10 deletions demo/src/app/ui/common/select/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,30 @@ export class AppComponent {
description: 'Description',
required: true,
options: [
{ value: 1, label: 'Option 1' },
{ value: 2, label: 'Option 2' },
{ value: 3, label: 'Option 3' },
{ value: 4, label: 'Option 4' },
{ value: 1, label: 'Option 1' },
{ value: 2, label: 'Option 2' },
{ value: 3, label: 'Option 3' },
{ value: 4, label: 'Option 4' },
],
filterable: true,
},
},
{
key: 'select_multi',
type: 'select',
type: 'multi-select',
templateOptions: {
label: 'Select Multiple',
placeholder: 'Placeholder',
description: 'Description',
required: true,
multiple: true,
selectAllOption: 'Select All',
options: [
{ value: 1, label: 'Option 1' },
{ value: 2, label: 'Option 2' },
{ value: 3, label: 'Option 3' },
{ value: 4, label: 'Option 4' },
{ value: 1, label: 'Option 1' },
{ value: 2, label: 'Option 2' },
{ value: 3, label: 'Option 3' },
{ value: 4, label: 'Option 4' },
],
filterable: true,
},
},
];
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions src/core/src/lib/templates/field-array.type.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { FormGroup, ReactiveFormsModule, FormArray } from '@angular/forms';
import { FormlyModule, FormlyForm, FormlyFieldConfig, FormlyFormOptions } from '@ngx-formly/core';
import { FieldArrayType } from './field-array.type';
import { FormlyFieldText } from '../components/formly.field.spec';
import { By } from '@angular/platform-browser';

function createFormlyTestComponent() {
return createGenericTestComponent('<formly-form [form]="form" [fields]="fields" [model]="model" [options]="options"></formly-form>', TestComponent);
Expand Down Expand Up @@ -63,6 +64,30 @@ describe('Array Field Type', () => {
expect(app.form.dirty).toBeTruthy();
});

it('should not mark the form dirty on Add/Remove', () => {
app.model = { array: null };
app.fields = [{
key: 'array',
type: 'array',
}];

const fixture = createFormlyTestComponent();
expect(app.form.dirty).toBeFalsy();

const arrayType = fixture.debugElement.query(By.css('formly-array-type'))
.componentInstance as ArrayTypeComponent;

arrayType.add(null, null, { markAsDirty: false });
fixture.detectChanges();
expect(app.form.dirty).toBeFalsy();

app.form.markAsPristine();

arrayType.remove(0, { markAsDirty: false });
fixture.detectChanges();
expect(app.form.dirty).toBeFalsy();
});

it('should work with nullable model', () => {
app.model = { array: null };
app.fields = [{
Expand Down
10 changes: 5 additions & 5 deletions src/core/src/lib/templates/field-array.type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export abstract class FieldArrayType<F extends FormlyFieldConfig = FormlyFieldCo
}

onPopulate(field: FormlyFieldConfig) {
if (!field.formControl) {
if (!field.formControl && field.key) {
registerControl(field, new FormArray([], { updateOn: field.modelOptions.updateOn }));
}

Expand All @@ -42,7 +42,7 @@ export abstract class FieldArrayType<F extends FormlyFieldConfig = FormlyFieldCo
}
}

add(i?: number, initialModel?: any) {
add(i?: number, initialModel?: any, { markAsDirty } = { markAsDirty: true }) {
i = isNullOrUndefined(i) ? this.field.fieldGroup.length : i;
if (!this.model) {
assignModelValue(this.field.parent.model, getKeyPath(this.field), []);
Expand All @@ -51,16 +51,16 @@ export abstract class FieldArrayType<F extends FormlyFieldConfig = FormlyFieldCo
this.model.splice(i, 0, initialModel ? clone(initialModel) : undefined);

(<any> this.options)._buildForm(true);
this.formControl.markAsDirty();
markAsDirty && this.formControl.markAsDirty();
}

remove(i: number) {
remove(i: number, { markAsDirty } = { markAsDirty: true }) {
this.model.splice(i, 1);
unregisterControl(this.field.fieldGroup[i], true);
this.field.fieldGroup.splice(i, 1);
this.field.fieldGroup.forEach((f, key) => f.key = `${key}`);

(<any> this.options)._buildForm(true);
this.formControl.markAsDirty();
markAsDirty && this.formControl.markAsDirty();
}
}
23 changes: 21 additions & 2 deletions src/core/src/lib/templates/field-template.type.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
import { Component } from '@angular/core';
import { DomSanitizer } from '@angular/platform-browser';
import { FieldType } from './field.type';

@Component({
selector: 'formly-template',
template: `<div [innerHtml]="field.template"></div>`,
template: `<div [innerHtml]="template"></div>`,
})
export class FormlyTemplateType extends FieldType {}
export class FormlyTemplateType extends FieldType {
get template() {
if (this.field && (this.field.template !== this.innerHtml.template)) {
this.innerHtml = {
template: this.field.template,
content: this.to.safeHtml
? this.sanitizer.bypassSecurityTrustHtml(this.field.template)
: this.field.template,
};
}

return this.innerHtml.content;
}

private innerHtml = { content: null, template: null };
constructor(private sanitizer: DomSanitizer) {
super();
}
}
25 changes: 25 additions & 0 deletions src/primeng/src/lib/types/multi-select.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Component } from '@angular/core';
import { FieldType } from '@ngx-formly/core';

@Component({
selector: 'formly-field-primeng-multi-select',
template: `
<p-multiSelect
[class.ng-dirty]="showError"
[filterPlaceHolder]="to.placeholder"
[options]="to.options | formlySelectOptions:field | async"
[formControl]="formControl"
[formlyAttributes]="field"
[filter]="to.filterable"
(onChange)="to.change && to.change(field, $event)">
</p-multiSelect>
`,
})
export class FormlyFieldMultiSelect extends FieldType {
defaultOptions = {
templateOptions: { options: [] },
};
constructor() {
super();
}
}
1 change: 1 addition & 0 deletions src/primeng/src/lib/types/select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { FieldType } from '@ngx-formly/core';
[formControl]="formControl"
[formlyAttributes]="field"
[showClear]="!to.required"
[filter]="to.filterable"
(onChange)="to.change && to.change(field, $event)">
</p-dropdown>
`,
Expand Down
7 changes: 7 additions & 0 deletions src/primeng/src/lib/ui-primeng.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
FormlyFieldSelect,
} from './types/types';
import { FormlyWrapperFormField } from './wrappers/wrappers';
import { FormlyFieldMultiSelect } from './types/multi-select';

export const FIELD_TYPE_COMPONENTS = [
// types
Expand All @@ -15,6 +16,7 @@ export const FIELD_TYPE_COMPONENTS = [
FormlyFieldCheckbox,
FormlyFieldRadio,
FormlyFieldSelect,
FormlyFieldMultiSelect,

// wrappers
FormlyWrapperFormField,
Expand Down Expand Up @@ -47,6 +49,11 @@ export const PRIME_NG_FORMLY_CONFIG: ConfigOption = {
component: FormlyFieldSelect,
wrappers: ['form-field'],
},
{
name: 'multi-select',
component: FormlyFieldMultiSelect,
wrappers: ['form-field'],
},
],
wrappers: [
{ name: 'form-field', component: FormlyWrapperFormField },
Expand Down
3 changes: 2 additions & 1 deletion src/primeng/src/lib/ui-primeng.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { InputTextareaModule } from 'primeng/inputtextarea';
import { CheckboxModule } from 'primeng/checkbox';
import { RadioButtonModule } from 'primeng/radiobutton';
import { DropdownModule } from 'primeng/dropdown';
import { MultiSelectModule } from 'primeng/multiselect';

import { FormlyModule } from '@ngx-formly/core';
import { FormlySelectModule } from '@ngx-formly/core/select';
Expand All @@ -22,7 +23,7 @@ import { PRIME_NG_FORMLY_CONFIG, FIELD_TYPE_COMPONENTS } from './ui-primeng.conf
CheckboxModule,
RadioButtonModule,
DropdownModule,

MultiSelectModule,
ReactiveFormsModule,
FormlySelectModule,
FormlyModule.forChild(PRIME_NG_FORMLY_CONFIG),
Expand Down