라이브러리 파라미터 레퍼런스
window.SauceShowroomLib 함수 16종의 파라미터·타입·필수 여부·기본값과, 요소 ID를 생략했을 때 쓰이는 기본 요소 ID 목록입니다.
함수 목록
설정 함수는 setInit 다음에, 표시 함수는 설정이 끝난 뒤에 호출합니다.
| 함수 | 구분 | 필수 파라미터 |
|---|---|---|
| setInit | 설정 | partnerUniqueId |
| getPartnerUniqueId | 설정 | — |
| setMemberToken | 설정 | JWT 토큰 |
| setMemberObject | 설정 | memberId · nickname |
| setThemeUniqueId | 설정 | 테마 ID |
| setMaxWidth | 설정 | 너비 |
| load | 표시 | — |
| loadImageBanner | 표시 | bannerGroupId |
| loadStripBanner | 표시 | bannerGroupId |
| loadLiveBanner | 표시 | bannerGroupId |
| loadRecentLive | 표시 | — |
| loadScheduledLive | 표시 | — |
| loadLiveCalendar | 표시 | — |
| loadVodCuration | 표시 | curationId |
| loadClipCuration | 표시 | curationId |
| loadSearchArea | 표시 | — |
설정 함수
setInit({ partnerUniqueId })
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| partnerUniqueId | String | 필수 | 파트너 ID |
getPartnerUniqueId()
| 반환 | 타입 | 설명 |
|---|---|---|
| partnerUniqueId | String | setInit 으로 등록한 파트너 ID |
setMemberToken(memberToken)
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| memberToken | String | 필수 | 회원 JWT 토큰. 유효하지 않거나 회원 토큰이 아니면 세션이 비워집니다 |
setMemberObject({ memberId, nickname, age, gender })
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| memberId | String | 필수 | — | 회원 식별 ID |
| nickname | String | 필수 | — | 닉네임 |
| age | String | 선택 | 'etc' | 연령대 — 10대 '10' · 20대 '20'숫자 형식의 문자열이 아니면 'etc' |
| gender | String | 선택 | 'e' | 남성 'm' · 여성 'w' · 기타 'e' |
setThemeUniqueId(themeUniqueId)
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| themeUniqueId | String | 선택 | 기본 테마 | 어드민에서 만든 테마 ID |
setMaxWidth(width)
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| width | Number | 선택 | 1024 | 최대 너비(px). 1024 이상만 반영됩니다 |
표시 함수
elementId 는 모두 선택입니다. 생략하면 함수마다 정해진 기본 요소 ID를 찾습니다.
load({ elementId })
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| elementId | String | 선택 | sauce-showroom | 전체 페이지를 표시할 요소의 ID |
loadImageBanner({ bannerGroupId, elementId })
loadStripBanner({ bannerGroupId, elementId })
loadLiveBanner({ bannerGroupId, elementId })
loadStripBanner({ bannerGroupId, elementId })
loadLiveBanner({ bannerGroupId, elementId })
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| bannerGroupId | String | 필수 | 배너 그룹 ID. 숫자 형식의 문자열이어야 합니다 |
| elementId | String | 선택 | 배너를 표시할 요소의 ID. 생략하면 배너 종류별 기본 ID + 배너 그룹 ID |
loadRecentLive({ elementId, typeCode })
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| elementId | String | 선택 | sauce-showroom-recent-live | 최근 라이브를 표시할 요소의 ID |
| typeCode | String | 선택 | — | 'WIDE' 를 주면 와이드형.생략하면 기본형 |
loadScheduledLive({ elementId })
loadLiveCalendar({ elementId })
loadLiveCalendar({ elementId })
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| elementId | String | 선택 | sauce-showroom-scheduled-livesauce-showroom-live-calendar | 콘텐츠를 표시할 요소의 ID |
loadVodCuration({ curationId, elementId })
loadClipCuration({ curationId, elementId })
loadClipCuration({ curationId, elementId })
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
| curationId | String | 필수 | 큐레이션 ID. 숫자 형식의 문자열이어야 합니다 |
| elementId | String | 선택 | 큐레이션을 표시할 요소의 ID. 생략하면 큐레이션 종류별 기본 ID + 큐레이션 ID |
loadSearchArea({ elementId, topElementId })
| 파라미터 | 타입 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
| elementId | String | 선택 | sauce-showroom-search-area | 검색 영역을 표시할 요소의 ID |
| topElementId | String | 선택 | body | 반응형 기준이 될 상위 요소의 ID |
표시 함수 공통 동작
10종 모두에 같이 적용됩니다.
| 항목 | 동작 |
|---|---|
| 표시 위치 | elementId 로 지정한 요소 안에 그립니다 |
| 요소가 없을 때 | 콘솔에 {요소 ID} ID를 가진 엘리먼트가 없습니다. 를 남기고 건너뜁니다 |
| 초기화 전 호출 | setInit 을 먼저 호출해야 함수가 노출됩니다 |
| 반응형 기준 | 화면 폭이 아니라 마운트한 요소의 폭 |
| 표시 항목·색상 | 어드민 테마 설정이 결정합니다 |
| 중복 마운트 | 같은 요소에 두 번 호출하면 두 개가 겹쳐 그려집니다 |
기본 요소 ID
elementId 를 생략하면 이 ID를 가진 요소를 찾습니다. 요소가 없으면 콘솔에 경고를 남기고 표시를 건너뜁니다.
| 함수 | 기본 요소 ID |
|---|---|
| load | sauce-showroom |
| loadSearchArea | sauce-showroom-search-area |
| loadRecentLive | sauce-showroom-recent-live |
| loadScheduledLive | sauce-showroom-scheduled-live |
| loadLiveCalendar | sauce-showroom-live-calendar |
| loadImageBanner | sauce-showroom-image-banner-{배너 그룹 ID} |
| loadStripBanner | sauce-showroom-strip-banner-{배너 그룹 ID} |
| loadLiveBanner | sauce-showroom-live-banner-{배너 그룹 ID} |
| loadVodCuration | sauce-showroom-vod-curation-{큐레이션 ID} |
| loadClipCuration | sauce-showroom-clip-curation-{큐레이션 ID} |
Updated about 4 hours ago
Did this page help you?
