# j-Directory

> Det är en liknande komponent som j-Suggestion, men har förbättrad design och stöder mer smarta funktioner.

Framework: jcomponent20
Product: jComponent 20 (jcomponent@20)
Language: sv
Content-SHA256: 6b9173fb394a9098c61b9e873f74931d40394423ab3c58230f09ffa69ade1f9c
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: components@910ed1a86f6e72b4f031d3ad0dc7844f9fc5cb8e
Review: not-recorded

Det är en liknande komponent som `j-Suggestion`, men har förbättrad design och stöder mer smarta funktioner.

- singlar
- Arbeta med beröring
- Stöd för _dark mode_

> __IMPORTANT__: Standardvis ger denna komponent ett värde som text från `name`-egenskapen.


__Metoder__:

Metod: `component.show(options)`

- `options.element {Element/jQuery Element}`
- `options.items {Array/String/Function}` en lista över objekt (`String` betyder en länk till datakällan)
- `options.offsetX {Number}` alternativ, `x` offset (default: `0`)
- `options.offsetY {Number}` alternativ, `y` offset (default: `0`)
- `options.offsetWidth {Number}` alternativ, `width` offset (default: `0`)
- `options.placeholder {String}` valfritt, en platsinnehavare för sökfältet
- __NEW__ `options.height {Number}` valfritt, en höjd av behållaren (default: `180`)
- `options.render {Function}` valfritt, en funktion för anpassad rendering av objektet `function(item, text)` måste returnera `HTML`
- `options.custom {Boolean/String}` alternativ, möjliggör retur av ett värde som inte är definierat i `options.items`, standard: `false`
- `options.minwidth {Number}` valfritt, en minimal bredd, standard `200`
- `options.maxwidth {Number}` valfritt, högsta bredd, standard `infinite`
- `options.callback(selected_item, element, iscustom, e) {Function}` utlöses när användaren klickar på objektet
- `options.key {String}` valfritt, en standard `key` för `text` värde (default: `name`)
- `options.empty {String}` alternativ, lägger till tomt fält
- `options.exclude {Function}` är valfritt, kan utesluta objekt och måste returnera en boolean `function(item) { return item.id !== 100 }`
- `options.close {Function}` valfritt, kan bestämma stängningen av panelen
- `options.search {Boolean/String}` alternativ, kan dölja sökfältet (default: `true`) eller `{String}` (nyckelnamn) kan kartlägga ett värde för sökning
- `options.selected {Object}` är valfritt, kan innehålla ett valfritt värde (default: `undefined`)
- `options.align {String}` alternativ, `left` (default), `right` eller `center`
- `options.position {String}` valfritt, `top` (default), `bottom`
- `options.raw {Boolean}` är valfritt, det här alternativet förhindrar att tecken fly (i andra ord: HTML-innehåll kommer att tillåtas i etiketter av objekt, standard: `false`)
- `options.classname {String}` valfritt, en anpassad containerklass för alla objekt
- absolut positionering fungerar endast om `options.element` inte definieras
	- `options.x {Number}` absolut position X
	- `options.y {Number}` absolut position och
- `options.checkbox {Boolean}` alternativ, möjliggör checkboxar
- `options.checked {Array String}` valfritt, identifierare av kontrollerade objekt
	- Riktade på `options.items {Function(q, next)}`
	- Callback returnerar endast råidentifierare `Array {String}`
- __NEW__ `options.template {String}` valfritt, en anpassad Tangular mall t.ex. `{{ name }}` (default: null)
- __NEW__ `options.fuzzy {Boolean}` valfritt, det kan inaktivera fuzzy sökning (default: `true`)

Metod: `component.hide()`

__Konfigurera__:
- `placeholder` - en platsinnehavare för sökningen
- `create` - en platsinnehavare för `Create` etikett (default: `Create`)

__Stödda objektfält__:

- `name {String}` ett märke
- `template {String}` valfritt, en anpassad Tangular mall
- `classname {String}` alternativ, lägger till ytterligare klasser i elementet `<li>`
- `disabled {Boolean}` alternativ, det kan inaktivera objektet
- `selected {Boolean}` är valfritt, det väljer objektet

__Formatera via Tangular__:

```js
var opt = {};
opt.items = [];
opt.push({ name: 'Total.js', template: '<b>{{ name }}</b>' });
```

__Formatera via custom__:

```js
var opt = {};
opt.items = [];
opt.push({ name: 'Total.js' });
opt.push({ name: 'Express.js' });
opt.push({ name: 'Koa.js' });
opt.render = function(item, name) {
	return '<b>' + name + '</b>';
};
```

__Lägga till custom class__:

```js
var opt = {};
opt.items = [];
opt.push({ name: 'Total.js', classname: 'your_class_name' });
```

__Server-sidan sökning__:

```js

var opt = {};

opt.element = your_element;

opt.items = function(search, next) {
	next([{ name: 'Item 1' }, { name: 'Item 2' }]);
};

opt.callback = function(selected) {
	console.log(selected);
};

SETTER('directory/show', opt);
```

__Bra att veta__:

- om `checkboxes:true` sedan komponenten förlänger objekt genom att lägga till en timestamp `selectedts {Number}` på grund av beställning

Använd den med `<ui-component name="directory">`När komponenten ännu inte är laddad, jComponent Ladda ner den första gången från adressen i `DEF.fallback` (en av Componentator Författare: Peter Širka. källa: The Componentator Komponenterna i lager, MIT licens.

```html example.html
<style>
	body { background-color: #F0F0F0; }
</style>

<ui-component name="directory" config="placeholder:Search ..."></ui-component>

<div class="container">
	<div><a href="javascript:void(0)" data-name="classic">Open directory - classic</a></div>
	<div><a href="javascript:void(0)" data-name="checkboxes">Open directory - checkboxes</a></div>
</div>

<script>
	$(document).on('click', 'a', function() {


		var opt = {};
		opt.element = $(this);

		if (opt.element.attrd('name') === 'checkboxes') {
			opt.checkbox = true;
			opt.items = [{ name: 'Total.js', selected: true }, { name: 'Express.js', selected: true }, { name: 'Meteor.js' }, { name: 'Koa.js' }, { name: 'ASP.NET' }, { name: 'PHP' }, { name: 'Python' }, { name: 'Node.js' }];
		} else
			opt.items = [{ name: 'Total.js', template: '<b>{{ name }}</b>' }, { name: 'Express.js' }, { name: 'Meteor.js' }, { name: 'Koa.js' }, { name: 'ASP.NET' }, { name: 'PHP' }, { name: 'Python' }, { name: 'Node.js' }];

		opt.callback = function(value) {
			if (opt.checkbox)
				console.log('SELECTED:', value);
			else
				console.log('CLICKED:', value);
		};

		SETTER('directory/show', opt);
	});
</script>
```