상품목록
상품 목록 페이지에서 노출되는 상품 목록 모듈입니다.
URL: /pages/product/product-list.html?categoryNo={categoryNo}&depth={depth}&sortType={sortType}&pageSize={pageSize}
관련 API : 🔗 상품 검색 API, 전체 카테고리 조회 API모바일) custom-attribute : shopby-view-type
type: GALLERY | LIST
모듈명: display-category원본소스
브래드 크럼브 & 하위 카테고리 슬라이더 모듈입니다
사용 가능 변수
| 변수명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| isSearchPage | boolean | false | 상품검색목록 페이지 여부 상품 검색을 통해 접근한 페이지인 경우 true |
| isLeafCategory | boolean | false | 현재 페이지가 최하위 카테고리인지 여부 |
| keywords | string | - | 키워드 |
| categoryNo | string | - | 현재 접근한 페이지의 카테고리 번호 |
| slider | Slider | - | Swiper 설정옵션과 동일한 데이터 (하위 카테고리 슬라이더 설정옵션) (아래 타입 참조) |
| currentCategoryRoute | CategoryRoute | - | 현재 카테고리 경로 정보 (아래 타입 참조) |
| categoryRoute | CategoryRoute[] | [] | 카테고리 경로 브레드크럼을 구성하기 위한 데이터 (아래 타입 참조) |
| categoryChildren | CategoryChildren[] | [] | 하위 카테고리 목록 |
Slider 타입
| 속성명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| id | string | - | 슬라이더id 값 |
CategoryRoute 타입
| 속성명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| label | string | - | 카테고리명 |
| depth | number | - | 카테고리 depth |
| categoryNo | number | - | 카테고리 번호 |
| siblingCategories | CategoryRoute[] | [] | 형제 카테고리 목록 CategoryRoute 타입과 동일한 데이터 |
CategoryChildren 타입
| 속성명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| label | string | - | 카테고리명 |
| depth | number | - | 카테고리 depth |
| categoryNo | number | - | 카테고리 번호 |
| count | number | 0 | 카테고리 상품 수 |
| children | CategoryChildren[] | [] | 하위 카테고리 목록 CategoryChildren 타입과 동일한 데이터 |
모듈명: product-keyword원본소스
(PC - 상품검색시) 검색어 모듈입니다
사용 가능 변수
| 변수명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| isSearchPage | boolean | false | 검색 페이지 여부 url에 keywords=검색어 쿼리스트링이 있는 경우 true |
| keywords | string | - | 검색어 |
모듈명: total-count-and-sort원본소스
상품 총 검색결과 수 & 정렬 모듈입니다
속성
| 속성명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| shopby-product-search-order | state > sortType과 동일 | - | (필수) PRODUCTS_SORT_TYPE 이벤트를 통해 변경될 상품 정렬 순서 해당 attribute를 사용하면 value는 제거가능 |
| shopby-product-search-direction | state > directions과 동일 | - | (선택) PRODUCTS_SORT_TYPE 이벤트를 통해 변경될 상품 정렬 방향 해당 attribute를 사용하면 value는 제거가능 shopby-product-search-order와 함께 사용해야함. |
| default-sort-type | string | SALE | 카테고리 정렬 타입 기본값 |
사용 가능 변수
| 변수명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| sortType | LOW_PRICE, HIGH_PRICE, 상품 검색하기 API > order.by | SALE_CNT | 상품 정렬 순서 |
| direction | ASC, DESC | null | sortType에서 LOW_PRICE, HIGH_PRICE 를 제외하고 direction을 통해 나머지 sortType에 대해 오름차순, 내림차순을 결정할 수 있음. (상품검색 커스터마이징을 하는 경우 사용가능) |
| viewType | GALLERY, LIST | GALLERY | (모바일)상품 리스트 뷰 타입 |
| nextViewType | GALLERY, LIST | LIST | (모바일)상품 리스트 뷰 타입 변경시 변경될 뷰 타입 |
| totalCount | number | 0 | 총 상품 개수 |
| productsSearchQueryParams | object | {} | 상품 검색 API 호출시 추가로 전달할 파라미터 상품 검색하기 API의 parameters와 동일 |
모듈명: product-list-items원본소스
상품목록 모듈입니다
속성
| 속성명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| shopby-is-adult | boolean | false | (필수)성인상품 여부 |
| shopby-product-no | number | - | (필수)상품번호 |
사용 가능 변수
| 변수명 | 타입 | 기본값 | 설명 |
|---|---|---|---|
| viewType | GALLERY | LIST | GALLERY | 상품 리스트 뷰 타입 |
| items | array | [] | 상품 검색 API 응답값 중 items와 동일 (상품목록) |
| isLoaded | boolean | false | 상품목록 로드 여부 |
| hasNoMoreItems | boolean | false | 더 이상 상품이 없는지 여부 |
| hasNoItems | boolean | false | 진열(검색)된 상품이 없는지 여부 |
| isSearchPage | boolean | false | 검색 페이지 여부 |
| productsSearchQueryParams | object | {} | 상품 검색 API 호출시 추가로 전달할 파라미터 상품 검색하기 API의 parameters와 동일 |
| page-size page-size:query |
number string |
20 pageSize |
한 페이지 노출 수 query string 중 pageSize 키 값 |
| page-number page-number:query |
number string |
1 pageNumber |
페이지 번호 query string 중 pageNumber 키 값 |
| visible-pages-count | number | 5 | 페이지네이션 표시 페이지 수 |