# j-Properties

> The component uses j-DatePicker, j-TimePicker, j-Directory, j-Emoji, j-ColorPicker and j-FaIcons components.

Framework: jcomponent20
Product: jComponent 20 (jcomponent@20)
Language: en
Content-SHA256: 800ebc73d3fac5c56576781417481bed88bd8c01c98db8afc361bcbc76525566
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: components@910ed1a86f6e72b4f031d3ad0dc7844f9fc5cb8e
Review: not-recorded

The component uses `j-DatePicker`, `j-TimePicker`, `j-Directory`, `j-Emoji`, `j-ColorPicker` and `j-FaIcons` components.

__Configuration__:

- `dateformat` {String} a date format (default: `yyyy-MM-dd`)
- `timeformat` {String} a time format (default: `HH:mm`)
- `datetimeformat` {String} a date/time format (default: `yyyy-MM-dd HH:mm`)
- `height` {Number} a height of the element (default: `undefined`)
- `parent` {String} jQuery selector for auto setup of height (can be `window`, `parent` or `custom`)
- `margin` {Number} vertical margin (default: `0`)
- `change` {String} a path to method `method(item, replace_text(new_text))` (executed if some value is changed) and `replace_text` argument is optional
- `scrollbar` {Boolean} enables scrollbar (default: `true`)
- `visibleY` {Boolean} shows a scrollbar (default: `true`)

__Data declaration__:

```javascript
var form = [];
form.push({ group: 'Personal', label: 'First name', name: 'user.firstname', type: 'string', value: 'Peter', transform: 'capitalize' });
form.push({ group: 'Personal', label: 'Last name', name: 'user.lastname', type: 'string', value: 'Širka', placeholder: 'String' });
form.push({ group: 'Personal', label: 'Age', name: 'user.age', type: 'number', value: 33, min: 30 });
form.push({ group: 'Personal', label: 'Birth date', name: 'user.birth', type: 'date', value: NOW });
form.push({ group: 'Additional', label: 'Newsletter', name: 'user.newsletter', type: 'bool', value: true });
form.push({ group: 'Additional', label: 'City', name: 'user.city', type: 'list', value: 2, items: 'items', dirsearch: 'Search city', dircustom: true });
form.push({ group: 'Additional', label: 'Color', name: 'user.color', type: 'color', value: '#e73323' });
form.push({ group: 'Additional', label: 'Icon', name: 'user.icon', type: 'fontawesome', value: 'ti ti-home' });
form.push({ group: 'Additional', label: 'Emoji', name: 'user.emoji', type: 'emoji', value: '', show: 'n => n.age === 33' });
```

__Data properties in data declaration__:
- `name` {String} an item identifier (required)
- `label` {String} a label (required)
- `group` {String} a group name (required)
- `type` {String} a type (required)
- `placeholder` {String} a placeholder (supports few types only)
- `transform` {String} for `string` type only, can contain `capitalize`, `uppercase`, `lowercase` or `slug`
- `maxlength` {Number} for `string` type only
- `validate` {RegExp/String} for `string` type only, can contain `email`, `phone` or `url`
- `min` {Number} for `number` type only
- `max` {Number} for `number` type only
- `inc` {Number/String} increments a value according to the value, targeted for `number` or `date` (can contain `1 day` or `-1 day`) type only
- `required` {Boolean} for type `string`, `number` or `date`
- `dirsearch` {String/Boolean} a placeholder for `list` type only, boolean disables search
- `dircustom` {Boolean} enables a custom value for `list` type only
- `dirkey` {String} a key name for label/name, targeted for `list` type only (default: `name`)
- `dirvalue` {String} a key name for value, targeted for `list` type only (default: `id`)
- `detail` {String} URL address for obtaining of data for `list` type, example: `/users/{0}/` and `{0}` will be replaced with the value from list
- `items` {Object Array/String} items for `list` type only, string can contain a path to `Array` or `URL address` to search
- `show` {Arrow function}, example: `data => data.KEY === 'SOMETHING'` --> will show the item if the condition will valid

__Allowed types in data__:

- `string`
- `bool`
- `number`
- `date`
- `list`
- `color`
- `emoji`
- `fontawesome`

__Missing types__:

- `datetime`
- `time`
- `file`
- `months`

### Persistent mode

```html
<ui-component name="properties" path="form" config="parent:window">
	<script type="text/html">
		[
			{ group: 'Personal', label: 'First name', name: 'firstname', type: 'string', transform: 'capitalize' },
			{ group: 'Personal', label: 'Last name', name: 'lastname', type: 'string', placeholder: 'String' },
			...
			...
			...
			{ group: 'Additional', label: 'Emoji', name: 'emoji', type: 'emoji', show: 'n => n.age === 33' }
		]
	</script>
</ui-component>

<script>
	var form = { firstname: 'John', lastname: 'Connor' };
</script>
```

### Good to know

The component extends the Array by adding:

- `invalid` {Boolean} field determines if the `value` is invalid (default: `undefined`)
- `changed` {Boolean} field determines if the `value` has been changed (default: `undefined`)
- `prev` {???} field contains an initial value

Use it with `<ui-component name="properties">`. When the component is not loaded yet, jComponent downloads it on first use from the address in `DEF.fallback` (the Componentator CDN by default). Author: Peter Širka. Source: the Componentator components repository, MIT license.

```html example.html
<ui-component name="LAZY directory"></ui-component>
<ui-component name="LAZY colorpicker"></ui-component>
<ui-component name="LAZY faicons"></ui-component>
<ui-component name="LAZY datepicker"></ui-component>
<ui-component name="LAZY timepicker"></ui-component>
<ui-component name="LAZY emoji"></ui-component>

<div style="width:400px;float:right">
	<ui-component name="properties" path="form" config="parent:window"></ui-component>
</div>

<script>
	var items = [{ id: 2, name: 'Banská Bystrica' }, { id: 3, name: 'Bratislava' }];
	var form = [];
	form.push({ group: 'Personal', label: 'First name', name: 'firstname', type: 'string', value: 'Peter', transform: 'capitalize' });
	form.push({ group: 'Personal', label: 'Last name', name: 'lastname', type: 'string', value: 'Širka', placeholder: 'String' });
	form.push({ group: 'Personal', label: 'Age', name: 'age', type: 'number', value: 33, min: 30 });
	form.push({ group: 'Personal', label: 'Birth date', name: 'birth', type: 'date', value: NOW });
	form.push({ group: 'Additional', label: 'Newsletter', name: 'newsletter', type: 'bool', value: true });
	form.push({ group: 'Additional', label: 'City', name: 'city', type: 'list', value: 2, items: 'items', dirsearch: 'Search city', dircustom: true });
	form.push({ group: 'Additional', label: 'Color', name: 'color', type: 'color', value: '#e73323' });
	form.push({ group: 'Additional', label: 'Icon', name: 'icon', type: 'fontawesome', value: 'ti ti-home' });
	form.push({ group: 'Additional', label: 'Emoji', name: 'emoji', type: 'emoji', value: '', show: 'n => n.age === 33' });
</script>
```