Web Components 그리드 검색 필터
웹 Web Components Ignite UI for Web Components 하면 데이터 컬렉션에서 값을 찾는 프로세스를 사용할 수 있습니다. 우리는 이 기능을 더 쉽게 설정할 수 있도록 하고 더 나은 사용자 경험을 위해 검색 입력 상자, 버튼, 키보드 탐색 및 기타 유용한 기능을 구현할 수 있습니다. 브라우저는 기본적으로 콘텐츠 검색 기능을 제공하지만 대부분의 경우 IgcGridComponent
보이지 않는 열과 행을 가상화합니다. 이러한 경우 기본 브라우저 검색은 가상화된 셀이 DOM의 일부가 아니기 때문에 해당 셀의 데이터를 검색할 수 없습니다. 우리는 Web Components 머티리얼 테이블 기반 그리드를 확장했습니다. 검색 API 이를 통해 검색할 수 있습니다. 가상화된 콘텐츠 ~의 IgcGridComponent
.
Web Components Search Example
다음 예는 모든 열과 행을 검색할 수 있는 검색 입력 상자와 각 열에 대한 특정 필터링 옵션이 있는 IgcGridComponent
나타냅니다.
Web Components Search Usage
Grid Setup
그리드를 생성하고 이를 데이터에 바인딩하는 것부터 시작해 보겠습니다. 또한 우리가 사용할 구성 요소에 대한 몇 가지 사용자 정의 스타일을 추가할 것입니다!
.gridSize {
--ig-size: var(--ig-size-small);
}
<igc-grid id="grid1" class="gridSize" auto-generate="false" allow-filtering="true">
<igc-column field="IndustrySector" data-type="string" sortable="true"></igc-column>
<igc-column field="IndustryGroup" data-type="string" sortable="true"></igc-column>
<igc-column field="SectorType" data-type="string" sortable="true"></igc-column>
<igc-column field="KRD" data-type="number" sortable="true"></igc-column>
<igc-column field="MarketNotion" data-type="number" sortable="true"></igc-column>
<igc-column field="Date" data-type="date" sortable="true"></igc-column>
</igc-grid>
좋습니다. 이제 IgcGridComponent
의 검색 API를 준비하겠습니다! 현재 검색된 텍스트를 저장하고 검색이 대소문자를 구분하는지 및/또는 정확히 일치하는지 여부를 저장하는 데 사용할 수 있는 몇 가지 속성을 만들 수 있습니다.
private grid: IgcGridComponent;
private searchBox: IgcInputComponent;
private searchIcon: IgcIconComponent;
private clearIcon: IgcIconComponent;
private nextIconButton: IgcIconButtonComponent;
private prevIconButton: IgcIconButtonComponent;
private caseSensitiveChip: IgcChipComponent;
private exactMatchChip: IgcChipComponent;
Web Components Search Box Input
이제 검색 입력을 만들어 보겠습니다! 입력 요소를 가져옴으로써 현재 값을 얻을 수 있습니다. 이를 통해 IgcGridComponent
의 findNext
및 findPrev
메소드를 사용하여 SearchText
의 모든 항목을 강조 표시하고 다음/이전 항목으로 스크롤할 수 있습니다(호출한 메소드에 따라 다름).
findNext
및 findPrev
메소드에는 모두 세 가지 인수가 있습니다.
Text
: string (검색하려는 텍스트)- (선택 사항)
CaseSensitive
: 부울 (검색 시 대소문자를 구분해야 하는지 여부, 기본값은 false입니다.) - (선택 사항)
ExactMatch
: 부울 (정확한 일치로 검색해야 하는지 여부, 기본값은 false입니다.)
정확한 일치로 검색할 때 검색 API는 대소문자 구분도 고려하여 SearchText
와 완전히 일치하는 셀 값만 결과로 강조 표시합니다. 예를 들어 'software' 및 'Software' 문자열은 대소문자 구분을 무시하고 정확히 일치합니다.
위의 메소드는 숫자 값(IgcGridComponent
에 지정된 문자열이 포함된 횟수)을 반환합니다.
<igc-input id="searchBox" name="searchBox">
</igc-input>
constructor() {
var grid = this.grid = document.getElementById('grid') as IgcGridComponent;
this.searchBox = document.getElementById('searchBox') as IgcInputComponent;
grid.data = new MarketData();
}
public nextSearch(){
this.grid.findNext(this.searchBox.value, false, false);
}
Add Search Buttons
검색 결과를 자유롭게 검색하고 탐색하기 위해 버튼의 각 클릭 이벤트 핸들러 내에서 findNext
및 findPrev
메소드를 호출하여 두 개의 버튼을 만들어 보겠습니다.
<igc-icon-button id="prevIconBtn" variant="flat" name="prev" collection="material" ></igc-icon-button>
<igc-icon-button id="nextIconBtn" variant="flat" name="next" collection="material"></igc-icon-button>
constructor() {
var nextIconButton = document.getElementById('nextIconBtn') as IgcIconButtonComponent;
var prevIconButton = document.getElementById('prevIconBtn') as IgcIconButtonComponent;
nextIconButton.addEventListener("click", this.nextSearch);
prevIconButton.addEventListener("click", this.prevSearch);
}
public prevSearch() {
this.grid.findPrev(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
}
public nextSearch() {
this.grid.findNext(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
}
Add Keyboard Search
또한 사용자가 키보드의 화살표 키와 입력하다 열쇠. 이를 달성하기 위해 우리는 다음을 처리할 수 있습니다. 키다운 입력의 기본 캐럿 이동을 방지하여 검색 입력 이벤트 PreventDefault
메서드를 호출하고 findNext
/ findPrev
사용자가 어떤 키를 눌렀는지에 따라 방법이 달라집니다.
<input id="searchBox" name="searchBox"/>
constructor() {
searchBox.addEventListener("keydown", (evt) => { this.onSearchKeydown(evt); });
this.searchBox.addEventListener("igcInput", (evt) => {
this.searchIcon.name = evt.detail ? 'clear' : 'search';
this.grid.findNext(evt.detail, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
});
}
public onSearchKeydown(evt: KeyboardEvent) {
if (evt.key === 'Enter' || evt.key === 'ArrowDown') {
evt.preventDefault();
this.grid.findNext(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
} else if (evt.key === 'ArrowUp') {
evt.preventDefault();
this.grid.findPrev(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
}
}
}
Case Sensitive and Exact Match
이제 사용자가 검색에서 대소문자를 구분할지 또는 정확히 일치할지 여부를 선택할 수 있도록 하겠습니다. 이를 위해 간단한 체크박스 입력을 사용하고 체크박스 checked
상태를 사용할 수 있는 change
이벤트에 바인딩할 수 있습니다.
<span>Case sensitive</span>
<input id="case" type="checkbox">
<span>Exact match</span>
<input id="exact" type="checkbox">
constructor() {
const case = document.getElementById("case") as HTMLInputElement;
const exact = document.getElementById("exact") as HTMLInputElement;
case.addEventListener("change", this.updateSearch);
exact.addEventListener("change", this.updateSearch);
}
public updateSearch() {
const search1 = document.getElementById("search1") as HTMLInputElement;
const case = document.getElementById("case") as HTMLInputElement;
const exact = document.getElementById("exact") as HTMLInputElement;
const grid = document.getElementById("grid") as IgcGridComponent;
grid.findNext(search1.value, case.checked, exact.checked);
}
Persistence
IgcGridComponent
를 필터링 및 정렬하거나 레코드를 추가 및 제거하려면 어떻게 해야 합니까? 이러한 작업 후에는 현재 검색의 하이라이트가 자동으로 업데이트되어 SearchText
와 일치하는 모든 텍스트에 대해 지속됩니다! 또한 검색은 페이징과 함께 작동하며 IgcGridComponent
의 PerPage
속성 변경을 통해 강조 표시를 유지합니다.
Adding icons
다른 구성 요소 중 일부를 사용하면 풍부한 사용자 인터페이스를 만들고 전체 검색 창의 전반적인 디자인을 개선할 수 있습니다! 검색 입력 왼쪽에는 멋진 검색 또는 삭제 아이콘이 있고, 검색 옵션을 위한 몇 가지 칩이 있으며, 오른쪽에는 탐색을 위한 멋진 잔물결 스타일 버튼과 결합된 일부 머티리얼 디자인 아이콘이 있습니다. 보다 세련된 디자인을 위해 이러한 구성 요소를 입력 그룹 내에 래핑할 수 있습니다.
import { defineComponents, IgcInputComponent, IgcChipComponent, IgcIconComponent, IgcIconButtonComponent, registerIconFromText } from "igniteui-webcomponents";
defineComponents(IgcInputComponent, IgcChipComponent, IgcIconComponent, IgcIconButtonComponent);
마지막으로 템플릿을 새로운 구성요소로 업데이트해 보겠습니다.
<igc-input id="searchBox" name="searchBox">
<igc-icon id="searchIcon" slot="prefix" name="search" collection="material"></igc-icon>
<div slot="suffix">
<igc-chip selectable="true" id="caseSensitiveChip">Case Sensitive</igc-chip>
<igc-chip selectable="true" id="exactMatchChip">Exact Match</igc-chip>
</div>
<div slot="suffix">
<igc-icon-button id="prevIconBtn" variant="flat" name="prev" collection="material" ></igc-icon-button>
<igc-icon-button id="nextIconBtn" variant="flat" name="next" collection="material"></igc-icon-button>
</div>
</igc-input>
constructor() {
const prevIconText = "<svg width='24' height='24' viewBox='0 0 24 24'><path d='M15.41 7.41 14 6l-6 6 6 6 1.41-1.41L10.83 12z'></path></svg>";
const nextIconText = "<svg width='24' height='24' viewBox='0 0 24 24'><path d='M10 6 8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z'></path></svg>";
const clearIconText = "<svg width='24' height='24' viewBox='0 0 24 24' title='Clear'><path d='M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z'></path></svg>";
const searchIconText = "<svg width='24' height='24' viewBox='0 0 24 24'><path d='M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z' /></svg>";
registerIconFromText("prev", prevIconText, "material");
registerIconFromText("next", nextIconText, "material");
registerIconFromText("clear", clearIconText, "material");
registerIconFromText("search", searchIconText, "material");
}
입력 그룹 오른쪽에 다음 목적을 가진 세 개의 별도 컨테이너를 만들어 보겠습니다.
-
CaseSensitive
및ExactMatch
속성을 전환하는 몇 가지 칩을 표시합니다. 우리는 체크박스를 이러한 속성에 따라 색상을 변경하는 두 개의 세련된 칩으로 대체했습니다. 칩을 클릭할 때마다 해당 핸들러를 호출합니다.
<div slot="suffix">
<igc-chip selectable="true" id="caseSensitiveChip">Case Sensitive</igc-chip>
<igc-chip selectable="true" id="exactMatchChip">Exact Match</igc-chip>
</div>
constructor() {
const input = document.getElementById("searchBox") as IgcInputComponent;
input.addEventListener("change", this.updateSearch);
}
public updateSearch() {
const grid = document.getElementById('grid') as IgcGridComponent;
const caseSensitiveChip = document.getElementById('caseSensitiveChip') as IgcChipComponent;
const exactMatchChip = document.getElementById('exactMatchChip') as IgcChipComponent;
grid.findNext(input.value, caseSensitiveChip.selected, exactMatchChip.selected);
}
- 검색 탐색 버튼의 경우 입력을 머티리얼 아이콘이 있는 잔물결 스타일 버튼으로 변환했습니다. 클릭 이벤트에 대한 핸들러는 동일하게 유지되며
findNext
/findPrev
메소드를 호출합니다.
<div slot="suffix">
<igc-icon-button id="prevIconBtn" variant="flat" name="prev" collection="material" ></igc-icon-button>
<igc-icon-button id="nextIconBtn" variant="flat" name="next" collection="material"></igc-icon-button>
</div>
constructor() {
const nextIconButton = this.nextIconButton = document.getElementById('nextIconBtn') as IgcIconButtonComponent;
const prevIconButton = this.prevIconButton = document.getElementById('prevIconBtn') as IgcIconButtonComponent;
nextIconButton.addEventListener("click", this.nextSearch);
prevIconButton.addEventListener("click", this.prevSearch);
}
public nextSearch() {
this.grid.findNext(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
}
public prevSearch() {
this.grid.findPrev(this.searchBox.value, this.caseSensitiveChip.selected, this.exactMatchChip.selected);
}
Known Limitations
한정 | 설명 |
---|---|
템플릿을 사용하여 셀에서 검색 | 검색 기능 강조 표시는 기본 셀 템플릿에서만 작동합니다. 사용자 정의 셀 템플릿이 포함된 열이 있는 경우 강조 표시가 작동하지 않으므로 열 포맷터와 같은 대체 접근 방식을 사용하거나searchable 열의 속성을 false로 설정합니다. |
원격 가상화 | 원격 가상화를 사용하면 검색이 제대로 작동하지 않습니다. |
텍스트가 잘린 셀 | 셀의 텍스트가 너무 커서 맞지 않고 찾고 있는 텍스트가 줄임표로 잘려도 셀로 스크롤하여 일치 횟수에 포함시키지만 아무것도 강조 표시되지 않습니다. |
API References
이 기사에서는 검색 결과 간 탐색과 관련된 몇 가지 추가 기능을 갖춘 IgcGridComponent
에 대한 자체 검색 창을 구현했습니다. 또한 아이콘, 칩, 입력과 같은 Ignite UI for Web Components 사용했습니다. 검색 API는 다음과 같습니다.
IgcGridComponent
methods:
IgcColumnComponent
properties:
사용된 관련 API가 포함된 추가 구성요소:
Additional Resources
우리 커뮤니티는 활동적이며 항상 새로운 아이디어를 환영합니다.