Skip to content

Commit 5f13c86

Browse files
committed
Improve naming & documentation
1 parent e3b1bd6 commit 5f13c86

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/labs/ia-combo-box/ia-combo-box-story.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ export class IAComboBoxStory extends LitElement {
301301
private applySettings(e: Event): void {
302302
e.preventDefault();
303303

304-
this.applyOptions();
304+
this.updateOptions();
305305
this.behavior = this.behaviorSelect.value as IAComboBoxBehaviorOption;
306306
this.label = this.labelInput.value;
307307
this.placeholder = this.placeholderInput.value;
@@ -317,7 +317,7 @@ export class IAComboBoxStory extends LitElement {
317317
* Updates which options are shown, depending on the option set chosen and
318318
* whether custom content should be included.
319319
*/
320-
private applyOptions(): void {
320+
private updateOptions(): void {
321321
switch (this.optionSetSelect.value) {
322322
case 'colors':
323323
this.options = this.customContentCheck.checked

src/labs/ia-combo-box/ia-combo-box.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ export class IAComboBox extends LitElement {
152152
caseSensitive = false;
153153

154154
/**
155-
* Whether the filtered options should be sorted lexicographically before display.
155+
* Whether the filtered options should be listed in lexicographically-sorted order.
156+
* Default is `false`, displaying them in the same order as the provided options array.
156157
*/
157158
@property({ type: Boolean, reflect: true }) sort = false;
158159

@@ -746,7 +747,8 @@ export class IAComboBox extends LitElement {
746747
}
747748

748749
/**
749-
* Highlights the given option and scrolls it into view if necessary
750+
* Highlights the given option and scrolls it into view if necessary.
751+
* If `null` is provided, any current highlight will be cleared.
750752
*/
751753
private async setHighlightedOption(
752754
option: IAComboBoxOption | null,

0 commit comments

Comments
 (0)