Angular 實現輸入框中顯示文章標籤

本文同時也發佈在了個人 我的博客中

不少網站發帖的時候標籤輸入框看起來像是在 <input> 元素中直接顯示標籤. 好比這種

一開始覺得是把 <span> 放在 <input> 中, 看了下 Stack Overflow 和 SegmentFault 的實現方式, 原來是用一個 <div> 把 <span> 和 <input> 包起來, 而後讓 <div> 模仿出輸入框的樣式. 再給 <div> 加上eventListensor, 點擊 <div> 時, 使 <input> 得到焦點.

StackBlitz 上的 Demo

在 Angular 中的實現

將各個tag用 <span> 顯示, 在同一行放一個 <input> 用來輸入新的標籤, 而後用一個 <div> 將它們包起來

<div>
  <span *ngFor="let tag of tags">{{tag}}</span>
  <input type="text">
</div>複製代碼

以後給 <div> 加上一個事件監聽器, 點擊 <div> 的時候, 激活 <input>. 爲了可以獲取 <input> 元素, 使用 Angular的 Template reference variables 來命名 <input>.

<div (click)="focusTagInput()">
  <span *ngFor="let tag of tags">{{tag}}</span>
  <input #tagInput type="text">
</div>複製代碼

在component中得到 <input> 元素

export class EditorComponent {
  // 用 @ViewChild 得到 DOM 元素
  @ViewChild('tagInput') tagInputRef: ElementRef;

  focusTagInput(): void {
    // 讓 input 元素得到焦點
    this.tagInputRef.nativeElement.focus();
  }
}複製代碼

到此基本上總體思路就實現了. 接下來就是完善一下細節. 好比

1. 輸入完一個標籤後, 按逗號或者空格自動將輸入的標籤添加到前面的標籤列表中
2. 給標籤加上一個刪除按鈕
3. 當輸入框是空的時候, 按鍵盤的退格鍵能夠刪除標籤列表中最後一個標籤

咱們一步一步來.

自動將標籤加入標籤列表

給 <input> 元素添加一個事件監聽, 能夠監聽鍵盤按下了哪一個鍵. 和鍵盤按鍵有關的事件有 keydown, keypress, keyup.

根據 MDN 上的解釋, keydown 和 keypress 都是在按鍵按下以後觸發, 不一樣點在於, 全部按鍵均可以觸發 keydown, 而 keypress 只有按下能產生字符的鍵時才觸發, shift, alt 這些按鍵不會觸發 keypress. 並且 keypress 從 DOM L3 以後就棄用了.

keyup 就是鬆開按鍵的時候觸發.

首先給 <input> 標籤添加事件監聽 (這裏用的 keyup, 後面會解釋爲何不用 keydown).

<input #tagInput type="text" (keyup)="onKeyup($event)">複製代碼

component 中對接收到的 KeyboardEvent 進行處理

onKeyup(event: KeyboardEvent): void {
  // 這裏將標籤輸入框做爲 FormGroup 中的一個 control
  const inputValue: string = this.form.controls.tag.value;

  // 檢查鍵盤是否按下了逗號或者空格, 並且得要求
  if (event.code === 'Comma' || event.code === 'Space') {
    this.addTag(inputValue);
    // 將新輸入的標籤加入標籤列表後, 把輸入框清空
    this.form.controls.tag.setValue('');
  }
}

addTag(tag: string): void {
  // 去掉末尾的逗號或者空格
  if (tag[tag.length - 1] === ',' || tag[tag.length - 1] === ' ') {
    tag = tag.slice(0, -1);
  }
  // 有可能什麼也沒輸入就直接按了逗號或者空格, 若是已經在列表中, 也不添加
  // 這裏使用了 lodah 的 find
  if (tag.length > 0 && !find(this.tags, tag)) {
    this.tags.push(tag);
  }
}複製代碼

使用 keyup 而不是 keypress 的緣由:

一開始我是用的 keypress, 可是 keypress 觸發的時候, <input> 還沒接收到按鍵的值, 因此就會出現標籤添加到列表, 而且清空輸入框後, 輸入框才接收到按下的逗號, 因而剛剛清空的輸入框中就出現了一個逗號.

keyup 是在釋放按鍵以後才觸發, 此時輸入框已經接收到按下的逗號的值, 再清空輸入框的時候就能把逗號一塊兒清除掉

給標籤加上一個刪除按鈕

就在每一個標籤旁邊添加一個叉號 ×, 點擊的時候, 把標籤從列表中移除就好了

<div (click)="focusTagInput()">
  <span *ngFor="let tag of tags">
    {{tag}}
  <span (click)="removeTag(tag)">×</span>
  </span>
  <input #tagInput type="text" (keyup)="onKeyup($event)">
</div>複製代碼

removeTag(tag: string): void {
  this.tags.splice(-1);
}複製代碼

按下退格鍵刪除最後一個標籤

不須要給DOM添加別的事件監聽, 只須要對component中的方法稍加修改便可

onKeyUp(event: KeyboardEvent): void {
  const inputValue: string = this.form.controls.tag.value;
  // 按下退格鍵, 且輸入框是空的時候, 刪除最後一個標籤
  if (event.code === 'Backspace' && !inputValue) {
    this.removeTag();
    return;
  } else {
    if (event.code === 'Comma' || event.code === 'Space') {
      this.addTag(inputValue);
      this.form.controls.tag.setValue('');
    }
  }
}

// 修改參數爲可選參數, 當沒有參數時, 刪除列表中最後一個,
// 有參數時, 刪除傳入的標籤
removeTag(tag?: string): void {
  if (!!tag) {
    // 這裏使用了 lodash 的 pull
    pull(this.tags, tag);
  } else {
    this.tags.splice(-1);
  }
}複製代碼

接下來就是調整樣式了. 就略過了

不足之處

• 使用中文輸入法輸入完一個詞按下空格時, 會直接把輸入的內容加到列表裏
• 使用中文輸入法時, 按下退格鍵, 若是輸入框裏沒有別的內容, 會直接刪除列表中最後一個標籤