Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | 2x 2x 11x 11x 11x 27x 2x 2x 10x 2x 2x 24x 24x 1x 1x 1x 1x 2x | import DefineMap from 'can-define/map/map';
import DefineList from 'can-define/list/list';
import Field from '../util/field/Field';
import {makeSentenceCase} from '../util/string/string';
import canDefine from 'can-define';
import stache from 'can-stache';
// @property sp-filter-builder.FilterOptions FilterOptions
// @memberof sp-filter-builder.types
// @description The default filter operator options
export const FilterOptions = [{
label: 'Contains',
value: 'like',
types: ['string']
}, {
label: 'Does not contain',
value: 'not_like',
types: ['string']
}, {
label: 'Starts with',
value: 'starts_with',
types: ['string']
}, {
label: 'Ends with',
value: 'ends_with',
types: ['string']
}, {
label: 'Equal to',
value: 'equals'
}, {
label: 'Not equal to',
operator: 'not_equal_to',
value: 'not_equal_to'
}, {
label: 'Greater Than',
value: 'greater_than',
types: ['number']
}, {
label: 'Less Than',
value: 'less_than',
types: ['number']
}, {
label: 'Before',
value: 'before',
types: ['date'],
valueField: {
name: 'value',
alias: 'Value',
ui: 'datepicker',
properties: {
placeholder: 'Select a date'
}
}
}, {
label: 'After',
value: 'after',
types: ['date'],
valueField: {
name: 'value',
alias: 'Value',
ui: 'datepicker',
properties: {
placeholder: 'Select a date'
}
}
}];
/**
* Creates a new filter
* @class Filter
* @memberof sp-filter-builder
*/
export const Filter = DefineMap.extend('Filter', {
/** @lends sp-filter-builder.Filter.prototype */
/**
* A value to filter on. Can be any primitive type. If the
* [sp-filter-builder.Filter.props.field `field`] property
* is set, the `field.type` property will be used to coerce the value.
* @type {*}
* @memberof sp-filter-builder.Filter.prototype
*/
value: {
type (newVal) {
const type = this.valueField && this.valueField.type ? this.valueField.type : 'any';
const cast = canDefine.types[type];
return cast ? cast(newVal) : newVal;
}
},
/**
* The name of the field to filter on
* @type {String}
* @memberof sp-filter-builder.Filter.prototype
*/
name: {
type: 'string',
get (name) {
return this.field ? this.field.name : name;
}
},
/**
* The operator to filter with. The default is `like`.
* @type {String}
* @memberof sp-filter-builder.Filter.prototype
*/
operator: {
type: 'string',
get (val) {
return typeof val === 'undefined' ? this.operatorField.value : val;
}
},
/**
* A field object that defines the available operator options and properties.
* This is used to create the dropdown choice for each filter in the sp-filter-builder.
* This field is generated automatically. If the
* [sp-filter-builder.Filter.props.field `field`] property is set,
* the `field.type` property will be used to filter the operator options.
* @type {Object}
* @memberof sp-filter-builder.Filter.prototype
*/
operatorField: {
serialize: false,
get (fieldProps) {
const field = this.field;
const options = field ? FilterOptions.filter((filter) => {
return !field.type || field.type === 'observable' || !filter.types || filter.types.indexOf(field.type) > -1;
}) : FilterOptions;
return new Field(Object.assign({
name: 'operator',
value: options[0].value,
alias: null,
inline: true,
placeholder: 'Choose an operator',
editTag: 'sp-select-field',
options: options
}, fieldProps || {}));
}
},
/**
* A property to show or hide this filter in the picker. The default is `true`
* @type {Boolean}
* @memberof sp-filter-builder.Filter.prototype
*/
visible: {
type: 'boolean',
default: true,
set (val) {
return val;
}
},
/**
* A property to disable this filter's remove button. This filter will not
* be removable. In addition, the operator field will be fixed. The default
* is `false`.
* @type {Boolean}
* @memberof sp-filter-builder.Filter.prototype
*/
pinned: {
type: 'boolean',
default: false
},
/**
* A virtual property to provide the field alias. If the
* [sp-filter-builder.Filter.props.field `field`] property is set, this alias
* will match the `field.alias`
* @type {String}
* @memberof sp-filter-builder.Filter.prototype
*
*/
alias: {
get () {
return this.field ? this.field.alias : makeSentenceCase(this.name);
}
},
/**
* A field object that defines the value field properties.
* This is used to create the value field for each filter in the sp-filter-builder.
* If the [sp-filter-builder.Filter.props.field `field`] property is set, the
* valueField will be a customized field based off of the set field.
* @type {util/field/Field}
* @memberof sp-filter-builder.Filter.prototype
*/
valueField: {
get () {
const fieldProps = this.field
? Object.assign({editTag: 'sp-text-field'}, this.field.get(), {
inline: true,
textarea: false,
alias: null
}) : {
inline: true,
name: this.name,
alias: null,
editTag: 'sp-text-field',
placeholder: 'Enter a filter value'
};
return new Field(fieldProps);
}
},
valueComponent: {
type: '*',
get (renderer) {
if (typeof renderer === 'function') {
return renderer;
}
return stache(`<${this.valueField.editTag}
properties:from="filter.valueField"
value:bind="filter.value" />`);
}
},
/**
* The field object used to initialize this filter. When this value is
* provided, the custom field will be used in place of the regular
* text field. This allows the user to interract with a different
* type of field, like a checkbox when setting filters.
* @type {util/field/Field}
* @memberof sp-filter-builder.Filter.prototype
*/
field: {
Type: Field
},
/**
* A virtual property that creates a dummmy form object for use with the
* field template
* @type {Object}
* @memberof sp-filter-builder.Filter.prototype
*/
object: {
get () {
const obj = {};
obj[this.name] = this.value;
return obj;
}
},
/**
* a setter for the value field for use with the field template
* @param {util/field/Field} field the field object
* @param {domElement} dom the input element
* @param {Object} scope the view model scope
* @param {*} props the object with the value set on the form
*/
setField (field, dom, scope, props) {
this.value = props.value;
}
});
/**
* Creates a new filter list
* @class FilterList
* @memberof sp-filter-builder
*
*/
export const FilterList = DefineList.extend('FilterList', {
'#': Filter
});
|