j-Detail

jComponent 20 · jcomponent@20 component Example loaded with jComponent 20

This component can render values from model. Supports inline mapping - look into the source-code of the example.

Configuration:

dateformat {String} a date format (default: DEF.dateformat)
datetimeformat {String} a date/time format (default: DEF.dateformat + ' ' + DEF.timeformat)
numberformat {Number} a default number format (default: empty)
small {Boolean} enables smaller design (default: false)
style {Number} component style (default: 1), supports style 2, 3 (minimal) and 4 (modern)
defaultgroup {String} a default group name (default: Default)
notnull {Boolean} skips nullable values (default: false)
track {String} can contain paths divided by comma, this property will watch only changes in trakced keys

Data declaration:

var model = { firstname: 'Peter', lastname: 'Širka', age: 33 };
var items = [{ id: 2, name: 'Banská Bystrica' }, { id: 3, name: 'Bratislava' }];
var form = [];

// The below values will be binded automatically from the "model" (according to the "path" field) because they contain "path" field
form.push({ group: 'Personal', label: 'First name', path: 'firstname', type: 'string', value: model, note: 'This is first name' });
form.push({ group: 'Personal', label: 'Last name', path: 'lastname', type: 'string', value: model, placeholder: 'String' });
form.push({ group: 'Personal', label: 'Age', path: 'age', type: 'number', value: model });

// The below values will be binded from "value" key
form.push({ group: 'Personal', label: 'Birth date', type: 'date', value: NOW });
form.push({ group: 'Additional', label: 'Newsletter', type: 'bool', value: true });
form.push({ group: 'Additional', label: 'City', type: 'list', value: 2, items: 'items' });
form.push({ group: 'Additional', label: 'Color', type: 'color', value: '#e73323' });
form.push({ group: 'Additional', label: 'Icon', type: 'fontawesome', value: 'fas fa-home' });

Data properties in data declaration:

group {String} a group name (required)
label {String} a label (required)
type {String} a type (required)
note {String} a small note under value
format {String} number e.g. 2 or date format dd.MM.yyyy
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
value {Object} a value or model with values (then path is required)
path {String} a path to value in model (value must contain a model)
template {String} A Tangular template (works only with type:'template' and {{ value }} contains a raw value, and {{ item }} contains the entire item)
empty {String} An empty value when the value is nullable (default: ---)
show {String} the conditional function value.type === 'company' then displays if the evaluated condition is true
NEW autoformat {Boolean} enables auto-format for email, or phones, and only for string type (default: false)
NEW colorize {Boolean} colorizes the value with except list, color and icon type
NEW plus {String} adds a value to end of rendered value for number and string types

Allowed types in data:

string
bool
number
date
datetime
list
color
emoji
fontawesome
password
template

Good to know:

if group contains only the one char then the name of group is not rendered

Use it with <ui-component name="detail">. 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.

example.html

<div style="width:500px">
	<ui-component name="detail" path="form"></ui-component>
	<br />
	<div>-- OR --</div>
	<br />
	<ui-component name="detail" path="model" config="style:2">
		<script type="text/plain">
			[
				{ name: 'First name', path: 'firstname', type: 'string' },
				{ name: 'Last name', path: 'lastname', type: 'string' },
				{ name: 'Age', path: 'age', type: 'number' }
			]
		</script>
	</ui-component>
	<br />
	<div>-- OR FILTERED --</div>
	<br />
	<ui-component name="detail" path="model" config="style:3">
		<script type="text/plain">
			[
				// Will be displayed, look to show condition ("value" means "model")
				{ name: 'First name', path: 'firstname', type: 'string', show: 'value.type==1' },
				{ name: 'Last name', path: 'lastname', type: 'string', show: 'value.type==1' },
				// Won't be displayed, look to show condition ("value" means "model")
				{ name: 'Age', path: 'age', type: 'number', show: 'value.type==2' }
			]
		</script>
	</ui-component>
	<br />
	<ui-component name="detail" path="model" config="style:4">
		<script type="text/plain">
			[
				// Will be displayed, look to show condition ("value" means "model")
				{ name: 'First name', path: 'firstname', type: 'string', show: 'value.type==1' },
				{ name: 'Last name', path: 'lastname', type: 'string', show: 'value.type==1' },
				// Won't be displayed, look to show condition ("value" means "model")
				{ name: 'Age', path: 'age', type: 'number', show: 'value.type==2' }
			]
		</script>
	</ui-component>
</div>

<script>
	var model = { firstname: 'Peter', lastname: 'Širka', age: 33, type: 1 };
	var items = [{ id: 2, name: 'Banská Bystrica' }, { id: 3, name: 'Bratislava' }];
	var form = [];

	// The below values will be binded automatically from the "model" (according to the "path" field) because they contain "path" field
	form.push({ group: 'Personal', label: 'First name', path: 'firstname', type: 'string', value: model, note: 'This is first name' });
	form.push({ group: 'Personal', label: 'Last name', path: 'lastname', type: 'string', value: model, placeholder: 'String' });
	form.push({ group: 'Personal', label: 'Age', path: 'age', type: 'number', value: model });

	// The below values will be binded from "value" key
	form.push({ group: 'Personal', label: 'Birth date', type: 'date', value: NOW });
	form.push({ group: 'Additional', label: 'Newsletter', type: 'bool', value: true });
	form.push({ group: 'Additional', label: 'City', type: 'list', value: 2, items: 'items' });
	form.push({ group: 'Additional', label: 'Color', type: 'color', value: '#e73323' });
	form.push({ group: 'Additional', label: 'Icon', type: 'fontawesome', value: 'ti ti-home' });
</script>