기획전 목록
기획전 목록 페이지에서 노출되는 기획전 목록 모듈입니다.
URL: /pages/event/event-list.html?pageSize={pageSize}&pageNumber={pageNumber}&orderDirection={orderDirection}&orderBy={orderBy}
관련 API : 🔗 기획전 조회하기 v2.0모듈명: event-list-total-count
기획전 정렬 모듈입니다.
속성
속성명 | 타입 | 기본값 | 설명 |
---|---|---|---|
current-tab | REGISTERDATE | STARTDATE | ENDDATE | ENDDATE | REGISTER_DATE | 기획전 조회하기 v2.0API 요청 값 중 order.by 와 동일 (REGISTERDATE: 등록일, STARTDATE: 시작일, END_DATE: 종료일) |
사용 가능 변수
변수명 | 타입 | 기본값 | 설명 |
---|---|---|---|
currentTab | string | - | custom-attributes 에 current-tab 추가한 값으로 초기값 설정 |
totalCount | number | 0 | 총 이벤트 수 |
모듈명: event-list
기획전 목록 모듈입니다.
속성
속성명 | 타입 | 기본값 | 설명 |
---|---|---|---|
default-page-size | number | 20 | (필수) 한 페이지당 노출 수 |
page-size:query | number | 20 | (필수) query string 중 pageSize 값한 페이지당 노출 수 |
page-number:query | number | 1 | (필수) query string 중 pageNumber 값페이지 번호 |
order-by:query | string | REGISTER_\DATE | (필수) query string 중 orderBy 값orderBy 는 기획전 조회하기 v2.0API 요청 값 중 order.by 와 동일 |
order-direction:query | string | DESC | query string 중 orderDirection 값orderDirection 은 기획전 조회하기 v2.0API 요청 값 중 order.direction 와 동일 |
pair-key | string | EVENTS_MORE_VIEW_BUTTON | 더보기 기능 사용 시 목록과 연동하기 위한 페어 키.more-view-button 모듈 사용 시 동일한 pair-key 를 추가해야 함. |
shopby-accumulable | - | - | 이벤트 목록 값을 누적할지 여부accumulativeContents 값을 사용하기 위해 필요한 설정 |
사용 가능 변수
변수명 | 타입 | 기본값 | 설명 |
---|---|---|---|
isLoading | boolean | true | contents 값 로딩 여부 |
contents | Contents[] | [] | 기획전 조회하기 v2.0API 응답 값 중 contents 와 동일 (아래 타입 참조) |
accumulativeContents | Contents[] | [] | 누적된 contents 값더보기 기능 사용 시에 활용 가능한 값으로 1페이지부터 현재 페이지까지 누적한 값 (아래 타입 참조) |
totalCount | number | 0 | 총 이벤트 수 |
totalPage | number | 0 | 총 페이지 수 |
pageNumber | number | 1 | 현재 검색 페이지 |
pagination | Pagination | - | 페이지네이션 (아래 타입 참조) |
Contents 타입
속성명 | 타입 | 기본값 | 설명 |
---|---|---|---|
urlType | EVENT_NUMBER | DIRECT | - | URL 타입 |
progressStatus | ALL | READY | ING | END | - | 진행 상태 |
displayPeriodType | REGULAR | PERIOD | - | 전시기간 타입 |
endYmdt | string | - | 전시 종료일 |
label | string | - | 기획전 명 |
url | string | - | 기획전 url |
promotionText | string | - | 홍보문구 |
pcImageUrl | string | - | 기획전 이미지 URL(PC) |
startYmdt | string | - | 전시 시작일 |
mobileimageUrl | string | - | 기획전 이미지 URL(MOBILE) |
eventYn | string | - | 이벤트 여부 |
tag | string | - | 검색용 태그값 |
id | string | - | 기획전 ID |
eventNo | number | - | 기획전 번호 |
Pagination 타입
속성명 | 타입 | 기본값 | 설명 |
---|---|---|---|
firstPage | string | - | 첫번째 페이지 |
lastPage | string | - | 마지막 페이지 |
prevPage | string | - | 이전 페이지 |
nextPage | string | - | 다음 페이지 |
pages | Page[] | [] | 페이지 리스트 |
totalPages | number | 0 | 페이지 총 개수 |