1.0.0 • Published 2 years ago

flashaim-straw v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Straw

Flashaim 針對 LINE Audience 開發之API的 Narrowcast 推播 Library

相依版本

Angular 12+
Angular material 12+

Setup

Angular Library Setup

npm install flashaim-straw

Uninstall

Angular Library Uninstall

npm uninstall flashaim-straw

Import module

匯入模組

import {StrawModule} from "flashaim-straw";
@NgModule({  
  imports: [  
    BrowserModule,
    BrowserAnimationsModule,
    HttpClientModule,
    ...  
    StrawModule,  
    ...  
  ],  
})
<st-straw [accessToken]="{{accessToken}}" [channelId]="{{channelId}}" [config]="{{config}}"></st-straw>

模組參數

NameTypeRequiredDescription
@Input()accessTokenstring*Access Token
@Input()channelIdstring*Channel ID
@Input()configConfig*細部控制參數設定
Config
NameTypeRequiredDescription
apiDomainApiDomainConfig*API Domain
sidenavSidenavConfig客製化Sidenav
themeThemeConfig客製化CSS style
tagsTags[]*標籤
msgPricenumber*單則推播訊息價格
ApiDomainConfig
NameTypeRequiredDescription
apistring*API Domain,目前內部使用需填到 https://.../api
mediastring*API Media Domain,資源上傳網址,目前內部使用需填到 https://.../api
SidenavConfig
NameTypeRequiredDescription
mode'over' or 'push' or 'side'Sidenav Mode,參照Material Sidenav:MatDrawerMode
fixedTopGapnumbersidenav和top的間距
Tags
NameTypeRequiredDescription
descriptionstring*標籤名稱
users_idstring[]*標籤的LINE User id
selectedboolean傳入true可預設被選取
ThemeConfig
NameTypeRequiredDescription
mainColorstring文字主色系文字顏色,需填入符合hexadecimal之完整色碼,例:#000000
mainBackgroundColorstring深色背景顏色,需填入符合hexadecimal之完整色碼,例:#000000
btnStyle{key:string}一般按鈕CSS style,需符合CSS規則
focusBtnStyle{key:string}重點按鈕CSS style,需符合CSS規則
Config Example
config: Config = {
        apiDomain: {
            api: '...',
            media: '...'
        },
        sidenavMode: {
             mode:'side',
             fixedTopGap:0
         },
        tags: [
            {description: "...", users_id: [ "..."]},
            ...
        ],
        msgPrice: 0.5,
        theme: {
            btnStyle: {
                ...
            },
            focusBtnStyle: {
                ...
            },
            mainColor: "#??????",
            mainBackgroundColor: "#??????"
        }
    };
Btn Style Example
focusBtnStyle:{color:'#000000',borderRadius:'15px'}
1.0.0

2 years ago

0.1.2

2 years ago