# STOVE GNB

STOVE GNB를 통해, 유저에게 Onstove 가입 동선, 웹페이지 언어 제어 기능, 게임 간 이동 동선 등을 제공합니다.
아래 가이드는 GNB ver. 5.0.24 을 기준으로 작성되었습니다

# 옵션 설정 예시

<html>
    <head>
        <script charset="utf-8" src="https://static-new.onstove.com/sh-5.2.26/cp-header.js"></script>
    </head>
    <body>
        <div> 본문 입력.</div>
        <script>
            var options = {
                wrapper: '.wrapper',
                logArea: 'stove',
                stoveLogo: {
                    use: true,
                    url: '',
                },
                serviceLogo: '',
                widget: {
                    gameList: true,
                    toonspoon: true,
                    languageSelect: true,
                    gameListAndService: true,
                    totalMenu: true,
                    notification: true,
                    clientDownload: true,
                    customArea: {
                        template: undefined,
                        eventHandler: undefined,
                    },
                },
                userMenu: {
                    myProfile: true,
                    myCash: true,
                    cartInfo: true,
                    myInfo: true,
                    security: true,
                    customerCenter: true,
                    reportCenter: true,
                    logout: true,
                    customArea: {
                        template: '',
                        eventHandler: undefined,
                    },
                },
                global: {
                    useGds: true,
                    defaultSelectedLanguage: 'en',
                    onChangeLanguage: null,
                    languageCoverages: ['de', 'en', 'es', 'fr', 'pt', 'zh-tw', 'ja', 'ko', 'th'],
                },
                defaultLocale: {
                    nation: undefined,
                    lang: undefined,
                    timezone: undefined,
                    utc_offset: undefined,
                    locale: undefined,
                },
                withDrawRedirect: true,
            };
            new window.cp.Header(options).render();
        </script>
    </body>
</html>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# GNB 옵션 설정

GNB 내 노출할 메뉴 및 로고, GNB 내 유저 메뉴 속 노출 메뉴, 글로벌 설정(GDS API 사용여부, 언어 설정 등), 가입/로그인 시 팝업 여부 등의 옵션을 설정 할 수 있습니다.

# 옵션 설명

이름 (Lv. 1) 이름 (Lv. 2) 이름 (Lv. 3) 설명 필수 여부 지원 옵션
wrapper GNB가 삽입될 컨테이너 DOM요소 지정 O id 혹은 class로 지정 가능
(기본값 : ".wrapper")
skin GNB에 삽입될 스킨
커스텀 클래스를 이용해 CSS 적용 가능
X "gnb-default", // 기본 버전 (기본값)
"gnb-dark", // 다크 버전
"gnb-dark-mix" // 다크 + 팝업 흰색 버전
"gnb-dark-mini" // 다크 + 미니 버전
"gnb-dark-mix-mini" // 다크 + 팝업 흰색 + 미니 버전
"gnb-mini" // 미니버전
"{String}" // 커스텀 클래스
logArea 로그 수집을 위한 로그 영역을 지정합니다 O "stove"(기본값), "cp"
stoveLogo use 스토브 로고 노출 여부 X TRUE(기본값), FALSE
url 스토브 로그 클릭이 이동될 URL 지정 X 자유로운 URL 지정가능 (기본값 : "")
serviceLogo 스토브 로그 우측에 서비스 로고 추가
예시 - <a href=""...""><img src=""..."">
X HTML형태의 string (기본값 : "")
widget toonspoon 툰스푼 노출 여부 X TRUE(기본값), FALSE
languageSelect 언어 선택 여부 X TRUE, FALSE(기본값)
notification 알림 노출 여부 X TRUE(기본값), FALSE
clientDownload 전체메뉴 내에 클라이언트 다운로드 노출 여부 X TRUE(기본값), FALSE
totalMenu 전체메뉴 노출 여부 X TRUE(기본값), FALSE
customArea template 커스텀 서비스 영역에 대체로 들어갈 템플릿 X HTML형태의 string (기본값 : "")
eventHandler 커스텀 영역에 템플릿에 적용될 함수 X 함수(콜백함수로 실행됨. 기본값 : "")
userMenu myProfile 유저 메뉴 내에 프로필영역 노출여부 X TRUE(기본값), FALSE
myCash 유저 메뉴 내에 캐시영역 노출여부 X TRUE(기본값), FALSE
cartInfo 유저 메뉴 내에 장바구니 노출여부 X TRUE(기본값), FALSE
myInfo 유저 메뉴 내에 내정보 노출여부 X TRUE(기본값), FALSE
security 유저 메뉴 내에 보안설정 노출여부 X TRUE(기본값), FALSE
customerCenter 유저 메뉴 내에 고객센터 노출여부 X TRUE(기본값), FALSE
reportCenter 유저 메뉴 내에 신고센트 노출여부 X TRUE(기본값), FALSE
logout 유저 메뉴 내에 로그아웃 노출여부 X TRUE(기본값), FALSE
customArea template 유저 커스텀 영역에 들어갈 템플릿 X HTML형태의 string (기본값 : "")
eventHandler 유저 커스텀 영역에 템플릿에 적용될 함수 X 함수(콜백함수로 실행됨. 기본값 : "")
global userGds GDS (글로벌) API 사용 여부 X TRUE(기본값), FALSE
languageCoverages 글로벌 언어 사용 여부 (GDS API 사용)
GDS의 미설정된 locale값이 들어올시 디폴트언어(영어)로 표기
X "['de', 'en', 'es', 'fr', 'pt', 'zh-tw', 'ja', 'ko', 'vi, 'th', 'id']
- de: 독일어
- en: 영어
- es: 스페인어
- fr: 프랑스어
- pt: 포르투갈
- zh-tw: 중국(대만)
- ja: 일본
- ko: 대한민국
- vi: 베트남
- th: 태국
- id: 인도네시아
(기본값 : ['de', 'en', 'es', 'fr', 'pt', 'zh-tw', 'ja', 'ko', 'th'])"
defaultSelectedLanguage languageCoverages에 지정되지 않은 locale의 경우 표기될 언어 지정 X GDS 정책에 따름 (기본값 : 'en')
onChangeLanguage 언어선택 이후 내부동작 이외에 별도의 기능을 실행을 원할경우 함수(선택된 언어는 인자로 받음) X 함수(콜백함수로 실행됨. 기본값 : -)
defaultLocale nation "ISO 3166-1"에 따른 국가코드 X GDS 정책에 따름 (기본값 : 한국 기준)
lang 사용자에게 보여줄 번역 언어 X GDS 정책에 따름 (기본값 : 한국 기준)
timezone timezone 정보 X GDS 정책에 따름 (기본값 : 한국 기준)
utc_offset timezone utc offset 정보 X GDS 정책에 따름 (기본값 : 한국 기준)
locale 선택된 언어 X GDS 정책에 따름 (기본값 : 한국 기준)
loginMethod redirectCurrentPage 로그인 및 로그아웃시 이전페이지로 리다이렉트
false 설정시 onstove 메인페이지로 이동
O TRUE, FALSE(기본값)
target "new"로 지정시 로그인 화면 새탭 열림 X "new" (기본값 : undefined)
params redirect_url 로그인 및 로그아웃시 지정된 URL로 리다이렉트 X 자유롭게 지정 가능 (기본값 : -)
inflow_path 로그인 채널 또는 서비스(로그인페이지 유입경로) 서비스별 상이 자유롭게 지정 가능 (기본값 : -)
game_no 게임 식별자 서비스별 상이 자유롭게 지정 가능 (기본값 : -)
show_play_button 게임 시작 동선 여부(회원 가입 시 클라이언트 실행 버튼 노출 여부) 서비스별 상이 "Y"(기본값), "N"
Last Updated: 2023. 10. 20. 오후 1:35:09