@newbiz/sohomall-libs
Version:
신사업개발실 원더FE개발팀 소호몰 전용 라이브러리
96 lines (87 loc) • 3.25 kB
Markdown
# Newbiz SohoMall Libs
신사업개발실 원더FE개발팀 소호몰 전용 라이브러리.
> This project was generated by [Vessel](https://www.npmjs.com/package/@mornya/vessel).
## About
소호몰에서 사용되는 pure javascript 라이브러리.
## Installation
해당 모듈은 패밀리세일 소호몰 작업시 \<script\>태그에서 로드하여 사용한다.<br>
jQuery를 사용하는 메소드 사용시에는 먼저 jQuery를 CDN 등의 경로로부터 로드해야 한다.
```html
<html lang="ko">
<head>
<meta charset="UTF-8"/>
<title>SAMPLE</title>
</head>
<body>
...
<script src="https://cdn.jsdelivr.net/npm/jquery@3.4.1/dist/jquery.min.js"></script>
<script src="해당 라이브러리 CDN 경로 (@newbiz/sohomall-libs)"></script>
</body>
</html>
```
## Methods
사용 할 메소드가 들어있는 라이브러리의 CDN경로를 \<script\> 태그로 불러온다.
### app.js
CDN경로: https://cdn.jsdelivr.net/npm/@newbiz/sohomall-libs@x.x.x/dist/app.js
> 디바이스 / OS별 분기가 필요 할 경우, 별도로 체크하고 있지 않기 때문에 스크립트를 작성하여 분기 로직을 작성해야 한다.
#### `openWonderShoppingApp`
소호몰 페이지 내에서 원더쇼핑 앱을 실행하는 스키마를 호출한다.
```html
<script>
var option = {
url: '', // 웹뷰에 띄울 url (required)
title: '', // 웹뷰 헤더 타이틀 (required)
image: '', // 웹뷰 이미지 (optional)
message: '', // 웹뷰 메시지 (optional)
}
openWonderShoppingApp(option)
</script>
```
#### `openWemakepriceApp`
소호몰 페이지 내에서 위메프 앱을 실행하는 스택링크를 호출한다.
```html
<script>
var option = {
action: '', // 런칭할 타입 종류 (deal/detail/plan/event) (required)
url: '', // 웹뷰에 띄울 url 혹은 딜번호 (required)
title: '', // 웹뷰 타이틀 (동작안함) (required)
}
openWemakepriceApp(option)
</script>
```
예를 들어 소호몰 페이지에서 `위메프 반값특가` 내 특정 딜 클릭시 위메프 앱을 띄워 이동하게 하기 위해서는 아래와 같이 처리한다.
```html
<script>
var option = {
action: 'deal',
url: '4470859',
title: '위메프 반값특가',
}
</script>
```
혹은 기획전일 경우
```html
<script>
var option = {
action: 'plan',
url: 'http://m.wemakeprice.com/~', // 기획전 모바일 웹 주소
title: '위메프 반값특가',
}
</script>
```
등 `action` 값과 `url` 값에 따라 위메프 앱에 랜딩 할 수 있다.
- `action`: 딜(deal) / 상세페이지(detail) / 기획전(plan) / 이벤트(event)
- `url`:
- 딜 / 상세페이지일 경우 상품번호 (number type)
- 기획전 / 이벤트일 경우 모바일 URL 주소 (string type)
### coupon.js
CDN경로: https://cdn.jsdelivr.net/npm/@newbiz/sohomall-libs@x.x.x/dist/coupon.js
> jQuery 라이브러리가 필요하므로 해당 라이브러리 로딩 전에 호출 필요.
#### `makeshopCouponDownload`
메이크샵 쿠폰 다운로드 받기.
```javascript
makeshopCouponDownload (couponNum, brandCode)
```
## License
해당 프로젝트의 [LICENSE](LICENSE) 파일 참조.<br>
Copyright ©위메프 신사업개발실 원더FE개발팀