deblan-mirror/Choices
deblan-mirror/Choices
1
0
Fork 0
mirror of https://github.com/Choices-js/Choices.git synced 2024-05-10 09:36:35 +02:00
Code Issues Projects Releases Wiki Activity

searchPlaceholderValue option

Browse source
This commit is contained in:
Josh Johnson 2017-08-03 09:55:31 +01:00
parent 55e81d188b
commit 84f149ee83
4 changed files with 68 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -358,7 +358,7 @@ const example = new Choices(element, {
### placeholder
**Type:** `Boolean` **Default:** `true`
**Input types affected:** `text`, `select-one`, `select-multiple`
**Input types affected:** `text`, `select-multiple`
**Usage:** Whether the input should show a placeholder. Used in conjunction with `placeholderValue`. If `placeholder` is set to true and no value is passed to `placeholderValue`, the passed input's placeholder attribute will be used as the placeholder value.
@ -369,6 +369,13 @@ const example = new Choices(element, {
**Usage:** The value of the inputs placeholder.
### selectPlaceholderValue
**Type:** `String` **Default:** `null`
**Input types affected:** `select-one`
**Usage:** The value of the search inputs placeholder.
### prependValue
**Type:** `String` **Default:** `null`

55
assets/scripts/src/choices.js
View file

@ -75,6 +75,7 @@ class Choices {
sortFilter: sortByAlpha,
placeholder: true,
placeholderValue: null,
searchPlaceholderValue: null,
prependValue: null,
appendValue: null,
renderSelectedChoices: 'auto',
@ -1124,8 +1125,11 @@ class Choices {
this._triggerChange(itemToRemove.value);
if (this.isSelectOneElement) {
const placeholder = this.config.placeholder ? this.config.placeholderValue || this.passedElement.getAttribute('placeholder') :
const placeholder = this.config.placeholder ?
this.config.placeholderValue ||
this.passedElement.getAttribute('placeholder') :
false;
if (placeholder) {
const placeholderItem = this._getTemplate('placeholder', placeholder);
this.itemList.appendChild(placeholderItem);
@ -2346,15 +2350,11 @@ class Choices {
);
groupChoices.forEach((option) => {
const isOptDisabled = option.disabled ||
(option.parentNode && option.parentNode.disabled);
let label = isType('Object', option) ?
option[labelKey] :
option.innerHTML;
const isOptDisabled = option.disabled || (option.parentNode && option.parentNode.disabled);
this._addChoice(
option[valueKey],
label,
(isType('Object', option)) ? option[labelKey] : option.innerHTML,
option.selected,
isOptDisabled,
groupId,
@ -2690,11 +2690,11 @@ class Choices {
wrap(containerInner, containerOuter);
// If placeholder has been enabled and we have a value
if (placeholder) {
if (this.isSelectOneElement) {
input.placeholder = this.config.searchPlaceholderValue || '';
} else if (placeholder) {
input.placeholder = placeholder;
if (!this.isSelectOneElement) {
input.style.width = getWidthOfInput(input);
}
input.style.width = getWidthOfInput(input);
}
if (!this.config.addItems) {
@ -2752,28 +2752,17 @@ class Choices {
allChoices.forEach((choice, index) => {
// Pre-select first choice if it's a single select
if (this.isSelectOneElement) {
if (hasSelectedChoice || (!hasSelectedChoice && index > 0)) {
// If there is a selected choice already or the choice is not
// the first in the array, add each choice normally
this._addChoice(
choice.value,
choice.label,
choice.selected,
choice.disabled,
undefined,
choice.customProperties
);
} else {
// Otherwise pre-select the first choice in the array
this._addChoice(
choice.value,
choice.label,
true,
false,
undefined,
choice.customProperties
);
}
// If there is a selected choice already or the choice is not
// the first in the array, add each choice normally
// Otherwise pre-select the first choice in the array
this._addChoice(
choice.value,
choice.label,
(hasSelectedChoice || index > 0) ? choice.selected : true,
(hasSelectedChoice || index > 0) ? choice.disabled : false,
undefined,
choice.customProperties
);
} else {
this._addChoice(
choice.value,

4
index.html
View file

@ -157,7 +157,6 @@
<h2>Single select input</h2>
<label for="choices-single-default">Default</label>
<select class="form-control" data-trigger name="choices-single-default" id="choices-single-default" placeholder="This is a search placeholder">
<option selected disabled>This is a placeholder</option>
<option value="Dropdown item 1">Dropdown item 1</option>
<option value="Dropdown item 2">Dropdown item 2</option>
<option value="Dropdown item 3">Dropdown item 3</option>
@ -413,7 +412,8 @@
});
var genericExamples = new Choices('[data-trigger]', {
placeholderValue: 'This is a placeholder set in the config'
placeholderValue: 'This is a placeholder set in the config',
searchPlaceholderValue: 'This is a search placeholder'
});
var singleNoSearch = new Choices('#choices-single-no-search', {

36
tests/spec/choices_spec.js
View file

@ -69,6 +69,7 @@ describe('Choices', () => {
expect(this.choices.config.shouldSortItems).toEqual(jasmine.any(Boolean));
expect(this.choices.config.placeholder).toEqual(jasmine.any(Boolean));
expect(this.choices.config.placeholderValue).toEqual(null);
expect(this.choices.config.searchPlaceholderValue).toEqual(null);
expect(this.choices.config.prependValue).toEqual(null);
expect(this.choices.config.appendValue).toEqual(null);
expect(this.choices.config.renderSelectedChoices).toEqual(jasmine.any(String));
@ -170,6 +171,16 @@ describe('Choices', () => {
this.choices.destroy();
});
it('should apply placeholderValue to input', function() {
this.choices = new Choices(this.input);
expect(this.choices.input.placeholder).toEqual('Placeholder text');
});
it('should not apply searchPlaceholderValue to input', function() {
this.choices = new Choices(this.input);
expect(this.choices.input.placeholder).not.toEqual('Test');
});
it('should accept a user inputted value', function() {
this.choices = new Choices(this.input);
@ -282,6 +293,22 @@ describe('Choices', () => {
this.choices.destroy();
});
it('should not apply placeholderValue to input', function() {
this.choices = new Choices(this.input, {
placeholderValue: 'Placeholder'
});
expect(this.choices.input.placeholder).not.toEqual('Placeholder');
});
it('should apply searchPlaceholderValue to input', function() {
this.choices = new Choices(this.input, {
searchPlaceholderValue: 'Placeholder'
});
expect(this.choices.input.placeholder).toEqual('Placeholder');
});
it('should open the choice list on focusing', function() {
this.choices = new Choices(this.input);
this.choices.input.focus();
@ -590,6 +617,7 @@ describe('Choices', () => {
this.choices = new Choices(this.input, {
placeholderValue: 'Placeholder text',
searchPlaceholderValue: 'Test',
choices: [{
value: 'One',
label: 'Label One',
@ -610,6 +638,14 @@ describe('Choices', () => {
this.choices.destroy();
});
it('should apply placeholderValue to input', function() {
expect(this.choices.input.placeholder).toEqual('Placeholder text');
});
it('should not apply searchPlaceholderValue to input', function() {
expect(this.choices.input.placeholder).not.toEqual('Test');
});
it('should add any pre-defined values', function() {
expect(this.choices.currentState.items.length).toBeGreaterThan(1);
});